KiCad PCB EDA Suite
invoke_pl_editor_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 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_PL_EDITOR_DIALOG_H_
40 #define INVOKE_PL_EDITOR_DIALOG_H_
41 
42 // Often this is not used in the prototypes, since wxFrame is good enough and would
43 // represent maximum information hiding.
44 class PL_EDITOR_FRAME;
45 class WS_DATA_ITEM;
46 class wxPrintData;
47 class wxPageSetupDialogData;
48 
49 
52 int InvokeDialogNewItem( PL_EDITOR_FRAME* aCaller, WS_DATA_ITEM* aItem );
53 
56 int InvokeDialogPrint( PL_EDITOR_FRAME* aCaller, wxPrintData* aPrintData,
57  wxPageSetupDialogData* aPageSetupData );
58 
61 int InvokeDialogPrintPreview( PL_EDITOR_FRAME* aCaller, wxPrintData* aPrintData );
62 
63 #endif // INVOKE_PL_EDITOR_DIALOG_H_
int InvokeDialogNewItem(PL_EDITOR_FRAME *aCaller, WS_DATA_ITEM *aItem)
Create and show DIALOG_NEW_DATAITEM and return whatever DIALOG_NEW_DATAITEM::ShowModal() returns.
Work sheet structure type definitions.
Definition: ws_data_item.h:93
Class PL_EDITOR_FRAME is the main window used in the page layout editor.
int InvokeDialogPrintPreview(PL_EDITOR_FRAME *aCaller, wxPrintData *aPrintData)
Create and show a print preview dialog returns 1 if OK, 0 , there is a problem.
int InvokeDialogPrint(PL_EDITOR_FRAME *aCaller, wxPrintData *aPrintData, wxPageSetupDialogData *aPageSetupData)
Create and show a print dialog returns 1 if OK, 0 , there is a problem.