Merge pull request #1 from saurabhb17/develop

Added main functions

1 files changed, 97 insertions, 0 deletions

diff --git a/eeschema/invoke_sch_dialog.h b/eeschema/invoke_sch_dialog.h
new file mode 100644
index 0000000..fe36a41
--- /dev/null
+++ b/eeschema/invoke_sch_dialog.h
@@ -0,0 +1,97 @@
+
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2013 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
+ * Copyright (C) 2013 KiCad Developers, see change_log.txt for contributors.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, you may find one here:
+ * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * or you may search the http://www.gnu.org website for the version 2 license,
+ * or you may write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ */
+
+// This header is an insolation layer between top most frames and any number of
+// DIALOG classes which can be called from a frame window.
+// It is a place to put invocation functions for [modal] dialogs, with benefits:
+//
+// 1) The information about each dialog class is not exposed to the frame.
+//    So therefore the DIALOG class can often be kept out of a header file entirely.
+//
+// 2) The information about the calling frame is not necessarily exposed to
+//    to the called dialog class, at least not in here.
+
+// The actual InvokeDialog<class>() function is usually coded at the bottom of the
+// DIALOG_<class>.cpp file.
+
+
+#ifndef INVOKE_SCH_DIALOG_H_
+#define INVOKE_SCH_DIALOG_H_
+
+#include <set>
+#include <vector>
+
+class wxFrame;
+class wxDialog;
+class LIB_PART;
+class PART_LIBS;
+class SCH_COMPONENT;
+class RESCUER;
+
+// Often this is not used in the prototypes, since wxFrame is good enough and would
+// represent maximum information hiding.
+class SCH_EDIT_FRAME;
+
+/**
+ * Function InvokeDialogRescueEach
+ * This dialog asks the user which rescuable, cached parts he wants to rescue.
+ * Any rejects will be pruned from aCandidates.
+ * @param aCaller - the SCH_EDIT_FRAME calling this
+ * @param aRescuer - the active RESCUER instance
+ * @param aAskShowAgain - if true, a "Never Show Again" button will be included
+ */
+int InvokeDialogRescueEach( SCH_EDIT_FRAME* aCaller, RESCUER& aRescuer, bool aAskShowAgain );
+
+/// Create and show DIALOG_ANNOTATE and return whatever
+/// DIALOG_ANNOTATE::ShowModal() returns.
+int InvokeDialogAnnotate( SCH_EDIT_FRAME* aCaller, wxString message = "" );
+
+/// Create the modeless DIALOG_ERC and show it, return something to
+/// destroy or close it.  The dialog will have ID_DIALOG_ERC from id.h
+wxDialog* InvokeDialogERC( SCH_EDIT_FRAME* aCaller );
+
+/// Create and show DIALOG_PRINT_USING_PRINTER and return whatever
+/// DIALOG_PRINT_USING_PRINTER::ShowModal() returns.
+int InvokeDialogPrintUsingPrinter( SCH_EDIT_FRAME* aCaller );
+
+/// Create and show DIALOG_BOM and return whatever
+/// DIALOG_BOM::ShowModal() returns.
+int InvokeDialogCreateBOM( SCH_EDIT_FRAME* aCaller );
+
+/**
+ * Function InvokeDialogNetList
+ * creates and shows NETLIST_DIALOG and returns whatever
+ * NETLIST_DIALOG::ShowModal() returns.
+ * @param int - NET_PLUGIN_CHANGE means user added or deleted a plugin,
+ *              wxID_OK, or wxID_CANCEL.
+*/
+#define NET_PLUGIN_CHANGE   1
+int InvokeDialogNetList( SCH_EDIT_FRAME* aCaller );
+
+bool InvokeEeschemaConfig( wxWindow* aParent,
+        wxString* aCallersProjectSpecificLibPaths, wxArrayString* aCallersLibNames );
+
+
+#endif  // INVOKE_SCH_DIALOG_H_