KiCad PCB EDA Suite
invoke_sch_dialog.h
Go to the documentation of this file.
1 
2 /*
3  * This program source code file is part of KiCad, a free EDA CAD application.
4  *
5  * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 2013 KiCad Developers, see change_log.txt for contributors.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 // This header is an insolation layer between top most frames and any number of
27 // DIALOG classes which can be called from a frame window.
28 // It is a place to put invocation functions for [modal] dialogs, with benefits:
29 //
30 // 1) The information about each dialog class is not exposed to the frame.
31 // So therefore the DIALOG class can often be kept out of a header file entirely.
32 //
33 // 2) The information about the calling frame is not necessarily exposed to
34 // to the called dialog class, at least not in here.
35 
36 // The actual InvokeDialog<class>() function is usually coded at the bottom of the
37 // DIALOG_<class>.cpp file.
38 
39 
40 #ifndef INVOKE_SCH_DIALOG_H_
41 #define INVOKE_SCH_DIALOG_H_
42 
43 #include <set>
44 #include <vector>
45 
46 class wxFrame;
47 class wxDialog;
48 class LIB_PART;
49 class PART_LIBS;
50 class SCH_COMPONENT;
51 class RESCUER;
52 
53 // Often this is not used in the prototypes, since wxFrame is good enough and would
54 // represent maximum information hiding.
55 class SCH_EDIT_FRAME;
56 
65 int InvokeDialogRescueEach( SCH_EDIT_FRAME* aCaller, RESCUER& aRescuer, bool aAskShowAgain );
66 
69 int InvokeDialogAnnotate( SCH_EDIT_FRAME* aCaller, wxString message = "" );
70 
73 wxDialog* InvokeDialogERC( SCH_EDIT_FRAME* aCaller );
74 
78 
82 
90 #define NET_PLUGIN_CHANGE 1
91 int InvokeDialogNetList( SCH_EDIT_FRAME* aCaller );
92 
93 bool InvokeEeschemaConfig( wxWindow* aParent,
94  wxString* aCallersProjectSpecificLibPaths, wxArrayString* aCallersLibNames );
95 
96 
97 #endif // INVOKE_SCH_DIALOG_H_
wxDialog * InvokeDialogERC(SCH_EDIT_FRAME *aCaller)
Create the modeless DIALOG_ERC and show it, return something to destroy or close it.
Definition: dialog_erc.cpp:613
Schematic editor (Eeschema) main window.
Definition: schframe.h:117
bool InvokeEeschemaConfig(wxWindow *aParent, wxString *aCallersProjectSpecificLibPaths, wxArrayString *aCallersLibNames)
Class LIB_PART defines a library part object.
int InvokeDialogCreateBOM(SCH_EDIT_FRAME *aCaller)
Create and show DIALOG_BOM and return whatever DIALOG_BOM::ShowModal() returns.
Definition: dialog_bom.cpp:223
int InvokeDialogAnnotate(SCH_EDIT_FRAME *aCaller, wxString message="")
Create and show DIALOG_ANNOTATE and return whatever DIALOG_ANNOTATE::ShowModal() returns.
Class PART_LIBS is a collection of PART_LIBs.
int InvokeDialogRescueEach(SCH_EDIT_FRAME *aCaller, RESCUER &aRescuer, bool aAskShowAgain)
Function InvokeDialogRescueEach This dialog asks the user which rescuable, cached parts he wants to r...
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:69
int InvokeDialogNetList(SCH_EDIT_FRAME *aCaller)
int InvokeDialogPrintUsingPrinter(SCH_EDIT_FRAME *aCaller)
Create and show DIALOG_PRINT_USING_PRINTER and return whatever DIALOG_PRINT_USING_PRINTER::ShowModal(...