Kicad: clean up include files.

This commit is contained in:
Simon Wells 2016-02-24 16:36:52 -05:00 committed by Wayne Stambaugh
parent f8abe9c191
commit 1c0a0c4bfe
18 changed files with 162 additions and 162 deletions

View File

@ -30,8 +30,13 @@
* in menubars or popup menus * in menubars or popup menus
*/ */
#include <wx/menu.h>
#include <wx/menuitem.h>
#include <bitmaps.h> #include <bitmaps.h>
/** /**
* Definition SETBITMAPS * Definition SETBITMAPS
* is a macro use to add a bitmaps to check menu item. * is a macro use to add a bitmaps to check menu item.

View File

@ -1,10 +1,3 @@
/**
* @file class_treeproject_item.cpp
*
* @brief Class TREEPROJECT_ITEM is a derived class from wxTreeItemData and
* store info about a file or directory shown in the KiCad tree project files
*/
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
@ -28,21 +21,24 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/ */
/**
* @file class_treeproject_item.cpp
*
* @brief Class TREEPROJECT_ITEM is a derived class from wxTreeItemData and
* store info about a file or directory shown in the KiCad tree project files
*/
#include <fctsys.h>
#include <gestfich.h>
#include <macros.h>
#include <kicad.h>
#include <project.h>
#include <pgm_base.h>
#include <tree_project_frame.h>
#include <class_treeprojectfiles.h>
#include <class_treeproject_item.h>
#include <wx/imaglist.h>
#include <wx/regex.h> #include <wx/regex.h>
#include <wx/dir.h>
#include <gestfich.h>
#include "class_treeprojectfiles.h"
#include "pgm_kicad.h"
#include "tree_project_frame.h"
#include "class_treeproject_item.h"
TREEPROJECT_ITEM::TREEPROJECT_ITEM( enum TreeFileType type, const wxString& data, TREEPROJECT_ITEM::TREEPROJECT_ITEM( enum TreeFileType type, const wxString& data,
wxTreeCtrl* parent ) : wxTreeCtrl* parent ) :

View File

@ -25,6 +25,12 @@
#ifndef TREEPROJECT_ITEM_H_ #ifndef TREEPROJECT_ITEM_H_
#define TREEPROJECT_ITEM_H_ #define TREEPROJECT_ITEM_H_
#include <wx/treebase.h>
#include "kicad.h"
/** /**
* Class TREEPROJECT_ITEM * Class TREEPROJECT_ITEM
* handles one item (a file or a directory name) for the tree file * handles one item (a file or a directory name) for the tree file

View File

@ -1,7 +1,3 @@
/**
* @file class_treeprojectfiles.cpp
* this is the wxTreeCtrl that shows a KiCad tree project files
*/
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
@ -26,17 +22,18 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/ */
/**
* @file class_treeprojectfiles.cpp
* this is the wxTreeCtrl that shows a KiCad tree project files
*/
#include <fctsys.h>
#include <kicad.h> #include <bitmaps.h>
#include <tree_project_frame.h>
#include <class_treeprojectfiles.h>
#include <class_treeproject_item.h>
#include <wx/regex.h> #include "class_treeproject_item.h"
#include <wx/imaglist.h> #include "tree_project_frame.h"
#include <menus_helpers.h>
#include "class_treeprojectfiles.h"
IMPLEMENT_ABSTRACT_CLASS( TREEPROJECTFILES, wxTreeCtrl ) IMPLEMENT_ABSTRACT_CLASS( TREEPROJECTFILES, wxTreeCtrl )
@ -109,4 +106,3 @@ int TREEPROJECTFILES::OnCompareItems( const wxTreeItemId& item1, const wxTreeIte
return myitem1->GetFileName().CmpNoCase( myitem2->GetFileName() ); return myitem1->GetFileName().CmpNoCase( myitem2->GetFileName() );
} }

View File

@ -29,6 +29,12 @@
#ifndef CLASS_TREEPROJECTFILES_H #ifndef CLASS_TREEPROJECTFILES_H
#define CLASS_TREEPROJECTFILES_H #define CLASS_TREEPROJECTFILES_H
#include <wx/treectrl.h>
#include "kicad.h"
/** Class TREEPROJECTFILES /** Class TREEPROJECTFILES
* This is the class to show (as a tree) the files in the project directory * This is the class to show (as a tree) the files in the project directory
*/ */

View File

@ -1,8 +1,3 @@
/**
* @file commandframe.cpp
* @brief Frame showing fast launch buttons and messages box
*/
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
@ -27,12 +22,15 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/ */
/**
* @file commandframe.cpp
* @brief Frame showing fast launch buttons and messages box
*/
#include <fctsys.h>
#include <macros.h>
#include <kicad.h> #include <bitmaps.h>
#include <menus_helpers.h>
#include "kicad.h"
LAUNCHER_PANEL::LAUNCHER_PANEL( wxWindow* parent ) : LAUNCHER_PANEL::LAUNCHER_PANEL( wxWindow* parent ) :

View File

@ -1,7 +1,3 @@
/**
* @file kicad/files-io.cpp
*/
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
@ -26,21 +22,23 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/ */
#include <fctsys.h> /**
#include <pgm_kicad.h> * @file kicad/files-io.cpp
#include <kiway.h> */
#include <wx/fs_zip.h>
#include <wx/zipstrm.h>
#include <wx/docview.h>
#include <wx/wfstream.h>
#include <wx/zstream.h>
#include <wx/dir.h> #include <wx/dir.h>
#include <wx/fs_zip.h>
#include <wx/wfstream.h>
#include <wx/zipstrm.h>
#include <confirm.h> #include <confirm.h>
#include <gestfich.h> #include <kiway.h>
#include <macros.h>
#include "pgm_kicad.h"
#include "kicad.h"
#include <kicad.h>
#define ZipFileExtension wxT( "zip" ) #define ZipFileExtension wxT( "zip" )
#define ZipFileWildcard _( "Zip file (*.zip)|*.zip" ) #define ZipFileWildcard _( "Zip file (*.zip)|*.zip" )

View File

@ -1,8 +1,3 @@
/**
* @file kicad.cpp
* @brief Main KiCad Project manager file
*/
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
@ -27,19 +22,26 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/ */
/**
* @file kicad.cpp
* @brief Main KiCad Project manager file
*/
#include <macros.h>
#include <fctsys.h> #include <wx/filename.h>
#include <wx/log.h>
#include <wx/stdpaths.h> #include <wx/stdpaths.h>
#include <kicad.h> #include <wx/string.h>
#include <kiway.h>
#include <pgm_kicad.h>
#include <tree_project_frame.h>
#include <wildcards_and_files_ext.h>
#include <boost/ptr_container/ptr_vector.hpp>
#include <hotkeys_basic.h>
#include <build_version.h> #include <common.h>
#include <hotkeys_basic.h>
#include <kiway.h>
#include <richio.h>
#include <wildcards_and_files_ext.h>
#include "pgm_kicad.h"
#include "kicad.h"
/// Extend LIB_ENV_VAR list with the directory from which I came, prepending it. /// Extend LIB_ENV_VAR list with the directory from which I came, prepending it.

View File

@ -1,8 +1,3 @@
/**
* @file kicad/kicad.h
* @brief KICAD_MANAGER_FRAME is the KiCad main frame.
*/
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
@ -27,19 +22,21 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/ */
/**
* @file kicad/kicad.h
* @brief KICAD_MANAGER_FRAME is the KiCad main frame.
*/
#ifndef KICAD_H #ifndef KICAD_H
#define KICAD_H #define KICAD_H
#include <vector>
#include <wx/treectrl.h>
#include <wx/dragimag.h>
#include <wx/filename.h>
#include <wx/process.h> #include <wx/process.h>
#include <id.h> #include <id.h>
#include <wxstruct.h> #include <wxstruct.h>
#define KICAD_MANAGER_FRAME_NAME wxT( "KicadFrame" ) #define KICAD_MANAGER_FRAME_NAME wxT( "KicadFrame" )
class LAUNCHER_PANEL; class LAUNCHER_PANEL;

View File

@ -1,8 +1,3 @@
/**
* @file kicad/mainframe.cpp
* @brief KICAD_MANAGER_FRAME is the KiCad main frame.
*/
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
@ -28,21 +23,22 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/ */
#include <fctsys.h> /**
#include <pgm_kicad.h> * @file kicad/mainframe.cpp
* @brief KICAD_MANAGER_FRAME is the KiCad main frame.
*/
#include <dialog_hotkeys_editor.h>
#include <gestfich.h>
#include <kiway.h> #include <kiway.h>
#include <kiway_player.h> #include <kiway_player.h>
#include <confirm.h>
#include <gestfich.h>
#include <macros.h>
#include <kicad.h>
#include <tree_project_frame.h>
#include <wildcards_and_files_ext.h> #include <wildcards_and_files_ext.h>
#include <menus_helpers.h>
#include <dialog_hotkeys_editor.h>
#include <wx/filefn.h> #include "pgm_kicad.h"
#include "tree_project_frame.h"
#include "kicad.h"
#define TREE_FRAME_WIDTH_ENTRY wxT( "LeftWinWidth" ) #define TREE_FRAME_WIDTH_ENTRY wxT( "LeftWinWidth" )
@ -474,7 +470,6 @@ void KICAD_MANAGER_FRAME::OnRefresh( wxCommandEvent& event )
void KICAD_MANAGER_FRAME::language_change( wxCommandEvent& event ) void KICAD_MANAGER_FRAME::language_change( wxCommandEvent& event )
{ {
int id = event.GetId(); int id = event.GetId();
Kiway.SetLanguage( id ); Kiway.SetLanguage( id );
} }

View File

@ -27,12 +27,15 @@
* @file kicad/menubar.cpp * @file kicad/menubar.cpp
* @brief (Re)Create the project manager menubar for KiCad * @brief (Re)Create the project manager menubar for KiCad
*/ */
#include <fctsys.h>
#include <pgm_kicad.h>
#include <kicad.h> #include <bitmaps.h>
#include <menus_helpers.h>
#include <tree_project_frame.h>
#include <hotkeys_basic.h> #include <hotkeys_basic.h>
#include <menus_helpers.h>
#include "kicad.h"
#include "pgm_kicad.h"
// Menubar and toolbar event table // Menubar and toolbar event table
BEGIN_EVENT_TABLE( KICAD_MANAGER_FRAME, EDA_BASE_FRAME ) BEGIN_EVENT_TABLE( KICAD_MANAGER_FRAME, EDA_BASE_FRAME )

View File

@ -1,5 +1,3 @@
#ifndef PGM_KICAD_H_
#define PGM_KICAD_H_
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
@ -24,6 +22,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/ */
#ifndef PGM_KICAD_H_
#define PGM_KICAD_H_
#include <pgm_base.h> #include <pgm_base.h>
#include <bin_mod.h> #include <bin_mod.h>

View File

@ -27,14 +27,11 @@
* @file preferences.cpp * @file preferences.cpp
*/ */
#include <fctsys.h>
#include <pgm_kicad.h>
#include <confirm.h> #include <confirm.h>
#include <gestfich.h>
#include <kicad.h> #include "kicad.h"
#include "pgm_kicad.h"
#include <wx/fontdlg.h>
void KICAD_MANAGER_FRAME::OnUpdateDefaultPdfBrowser( wxUpdateUIEvent& event ) void KICAD_MANAGER_FRAME::OnUpdateDefaultPdfBrowser( wxUpdateUIEvent& event )
@ -93,4 +90,3 @@ void KICAD_MANAGER_FRAME::OnSelectPreferredPdfBrowser( wxCommandEvent& event )
Pgm().ForceSystemPdfBrowser( false ); Pgm().ForceSystemPdfBrowser( false );
Pgm().WritePdfBrowserInfos(); Pgm().WritePdfBrowserInfos();
} }

View File

@ -1,8 +1,3 @@
/**
* @file prjconfig.cpp
* Load and save project configuration files (*.pro)
*/
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
@ -27,28 +22,30 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/ */
#include <fctsys.h> /**
#include <pgm_kicad.h> * @file prjconfig.cpp
#include <kiway.h> * Load and save project configuration files (*.pro)
#include <project.h> */
#include <confirm.h>
#include <gestfich.h>
#include <kicad.h>
#include <config_params.h>
#include <project_template.h>
#include <tree_project_frame.h>
#include <wildcards_and_files_ext.h>
#include <vector>
#include <build_version.h>
#include <macros.h>
#include <common.h>
#include <wx/dir.h> #include <wx/dir.h>
#include <wx/filename.h> #include <wx/filename.h>
#include <wx/stdpaths.h> #include <wx/stdpaths.h>
#include <build_version.h>
#include <config_params.h>
#include <confirm.h>
#include <kiway.h>
#include <project.h>
#include <wildcards_and_files_ext.h>
#include "dialogs/dialog_template_selector.h" #include "dialogs/dialog_template_selector.h"
#include "kicad.h"
#include "pgm_kicad.h"
#include "tree_project_frame.h"
#define SEP() wxFileName::GetPathSeparator() #define SEP() wxFileName::GetPathSeparator()
// Not really useful, provided to save/restore params in project config file, // Not really useful, provided to save/restore params in project config file,

View File

@ -22,18 +22,13 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/ */
#include "project_template.h"
#include <vector> #include <wx/bitmap.h>
#include <wx/wx.h>
#include <wx/arrstr.h>
#include <wx/dir.h> #include <wx/dir.h>
#include <wx/filename.h>
#include <wx/txtstrm.h> #include <wx/txtstrm.h>
#include <wx/wfstream.h> #include <wx/wfstream.h>
#include <macros.h> #include "project_template.h"
#define SEP() wxFileName::GetPathSeparator() #define SEP() wxFileName::GetPathSeparator()

View File

@ -104,11 +104,14 @@
#ifndef PROJECT_TEMPLATE_H #ifndef PROJECT_TEMPLATE_H
#define PROJECT_TEMPLATE_H #define PROJECT_TEMPLATE_H
#include <vector> #include <vector>
#include <wx/wx.h>
#include <wx/image.h>
#include <wx/filename.h> #include <wx/filename.h>
#include <wx/intl.h>
class wxBitmap;
/** /**
* @brief A directory which contains information about the project template and does not get * @brief A directory which contains information about the project template and does not get

View File

@ -1,8 +1,3 @@
/**
* @file tree_project_frame.cpp
* @brief Function to build the tree of files in the current project directory
*/
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
@ -28,23 +23,28 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/ */
#include <fctsys.h> /**
#include <confirm.h> * @file tree_project_frame.cpp
#include <gestfich.h> * @brief Function to build the tree of files in the current project directory
#include <pgm_base.h> */
#include <macros.h>
#include <tree_project_frame.h>
#include <class_treeprojectfiles.h> #include <stack>
#include <class_treeproject_item.h>
#include <wildcards_and_files_ext.h>
#include <wx/regex.h> #include <wx/regex.h>
#include <wx/dir.h>
#include <wx/imaglist.h>
#include <wx/stdpaths.h> #include <wx/stdpaths.h>
#include <wx/string.h>
#include <bitmaps.h>
#include <gestfich.h>
#include <menus_helpers.h> #include <menus_helpers.h>
#include <stack> #include <wildcards_and_files_ext.h>
#include "class_treeproject_item.h"
#include "class_treeprojectfiles.h"
#include "pgm_kicad.h"
#include "tree_project_frame.h"
/* Note about the tree project build process: /* Note about the tree project build process:

View File

@ -1,7 +1,3 @@
/**
* @file tree_project_frame.h
*/
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
@ -26,14 +22,24 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/ */
/**
* @file tree_project_frame.h
*/
#ifndef TREEPRJ_FRAME_H #ifndef TREEPRJ_FRAME_H
#define TREEPRJ_FRAME_H #define TREEPRJ_FRAME_H
#include <kicad.h>
#include <wx/fswatcher.h> #include <wx/fswatcher.h>
#include <wx/laywin.h>
#include <wx/treebase.h>
#include "kicad.h"
class KICAD_MANAGER_FRAME;
class TREEPROJECT_ITEM; class TREEPROJECT_ITEM;
class TREEPROJECTFILES;
/** class TREE_PROJECT_FRAME /** class TREE_PROJECT_FRAME
* Window to display the tree files * Window to display the tree files