KiCad PCB EDA Suite
confirm.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) 2007 Jean-Pierre Charras, jp.charras at wanadoo.fr
5  * Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.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 
31 #ifndef __INCLUDE__CONFIRM_H__
32 #define __INCLUDE__CONFIRM_H__
33 
34 #include <wx/window.h>
35 
49 int DisplayExitDialog( wxWindow* aParent, const wxString& aMessage );
50 
51 
58 void DisplayError( wxWindow* parent, const wxString& aMessage, int displaytime = 0 );
59 
68 void DisplayErrorMessage( wxWindow* aParent, const wxString& aMessage, const wxString aExtraInfo = wxEmptyString );
69 
70 
79 void DisplayInfoMessage( wxWindow* parent, const wxString& aMessage, const wxString aExtraInfo = wxEmptyString );
80 
90 bool IsOK( wxWindow* aParent, const wxString& aMessage );
91 
107 int YesNoCancelDialog( wxWindow* aParent,
108  const wxString& aPrimaryMessage,
109  const wxString& aSecondaryMessage,
110  const wxString& aYesButtonText = wxEmptyString,
111  const wxString& aNoButtonText = wxEmptyString,
112  const wxString& aCancelButtonText = wxEmptyString );
113 
114 
119 void DisplayHtmlInfoMessage( wxWindow* parent, const wxString& title,
120  const wxString& aMessage,
121  const wxSize& size = wxDefaultSize );
122 
123 
124 #endif /* __INCLUDE__CONFIRM_H__ */
void DisplayError(wxWindow *parent, const wxString &aMessage, int displaytime=0)
Function DisplayError displays an error or warning message box with aMessage.
Definition: confirm.cpp:71
void DisplayHtmlInfoMessage(wxWindow *parent, const wxString &title, const wxString &aMessage, const wxSize &size=wxDefaultSize)
Function DisplayHtmlInforMessage displays aMessage in HTML format.
Definition: confirm.cpp:119
int DisplayExitDialog(wxWindow *aParent, const wxString &aMessage)
Function DisplayExitDialog displays a dialog with 3 buttons: Save and Exit Cancel Exit without save...
Definition: confirm.cpp:59
void DisplayInfoMessage(wxWindow *parent, const wxString &aMessage, const wxString aExtraInfo=wxEmptyString)
Function DisplayInfoMessage displays an informational message box with aMessage.
Definition: confirm.cpp:102
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Function IsOK displays a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:129
void DisplayErrorMessage(wxWindow *aParent, const wxString &aMessage, const wxString aExtraInfo=wxEmptyString)
Function DisplayErrorMessage displays an error message with aMessage.
Definition: confirm.cpp:85
int YesNoCancelDialog(wxWindow *aParent, const wxString &aPrimaryMessage, const wxString &aSecondaryMessage, const wxString &aYesButtonText=wxEmptyString, const wxString &aNoButtonText=wxEmptyString, const wxString &aCancelButtonText=wxEmptyString)
Function YesNoCancelDialog displays a yes/no/cancel dialog with aMessage and returns the user respons...
Definition: confirm.cpp:166