KiCad PCB EDA Suite
invoke_sch_dialog.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
5  * Copyright (C) 2013-2019 KiCad Developers, see change_log.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 // This header is an insolation layer between top most frames and any number of
26 // DIALOG classes which can be called from a frame window.
27 // It is a place to put invocation functions for [modal] dialogs, with benefits:
28 //
29 // 1) The information about each dialog class is not exposed to the frame.
30 // So therefore the DIALOG class can often be kept out of a header file entirely.
31 //
32 // 2) The information about the calling frame is not necessarily exposed to
33 // to the called dialog class, at least not in here.
34 
35 // The actual InvokeDialog<class>() function is usually coded at the bottom of the
36 // DIALOG_<class>.cpp file.
37 
38 
39 #ifndef INVOKE_SCH_DIALOG_H_
40 #define INVOKE_SCH_DIALOG_H_
41 
42 #include <set>
43 #include <vector>
44 #include <list>
45 #include <class_draw_panel_gal.h>
46 
47 class wxFrame;
48 class wxDialog;
49 class LIB_PART;
50 class PART_LIBS;
51 class SCH_COMPONENT;
52 class SCH_SHEET_PATH;
53 class RESCUER;
54 
55 // Often this is not used in the prototypes, since wxFrame is good enough and would
56 // represent maximum information hiding.
57 class SCH_EDIT_FRAME;
58 
69 int InvokeDialogRescueEach( wxWindow* aParent, RESCUER& aRescuer, SCH_SHEET_PATH* aCurrentSheet,
70  EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackEndType, bool aAskShowAgain );
71 
74 wxDialog* InvokeDialogERC( SCH_EDIT_FRAME* aCaller );
75 
79 
83 
86  const std::list<SCH_COMPONENT*> aComponents, bool aCreateUndoEntry );
87 
95 #define NET_PLUGIN_CHANGE 1
96 int InvokeDialogNetList( SCH_EDIT_FRAME* aCaller );
97 
104 
105 #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:673
Schematic editor (Eeschema) main window.
bool InvokeDialogEditComponentsLibId(SCH_EDIT_FRAME *aCaller)
Run a dialog to modify the LIB_ID of components for instance when a symbol has moved from a symbol li...
Define a library symbol object.
int InvokeDialogCreateBOM(SCH_EDIT_FRAME *aCaller)
Create and show DIALOG_BOM and return whatever DIALOG_BOM::ShowModal() returns.
Definition: dialog_bom.cpp:215
int InvokeDialogRescueEach(wxWindow *aParent, RESCUER &aRescuer, SCH_SHEET_PATH *aCurrentSheet, EDA_DRAW_PANEL_GAL::GAL_TYPE aGalBackEndType, bool aAskShowAgain)
This dialog asks the user which rescuable, cached parts he wants to rescue.
Class SCH_SHEET_PATH.
A collection of PART_LIB objects.
int InvokeDialogUpdateFields(SCH_EDIT_FRAME *aCaller, const std::list< SCH_COMPONENT * > aComponents, bool aCreateUndoEntry)
Update symbol fields.
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:70
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(...