confirm.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2007 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright The KiCad Developers, see AUTHORS.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
 */

 
#ifndef __INCLUDE__CONFIRM_H__
#define __INCLUDE__CONFIRM_H__
 
#include <kicommon.h>
#include <wx/string.h>
#include <wx/arrstr.h>
 
class wxWindow;
 
 
// On Windows, to have the best dark mode experience we need to sub in the generic dialogs
// as wx can't retheme the native dialogs
#if defined( _WIN32 ) && wxCHECK_VERSION( 3, 3, 0 )
#define KICAD_MESSAGE_DIALOG_BASE wxGenericMessageDialog
#define KICAD_RICH_MESSAGE_DIALOG_BASE wxGenericRichMessageDialog
// incase we in the future declare our own message dialog class
#define KICAD_MESSAGE_DIALOG KICAD_MESSAGE_DIALOG_BASE
#else
#define KICAD_MESSAGE_DIALOG_BASE wxMessageDialog
#define KICAD_RICH_MESSAGE_DIALOG_BASE wxRichMessageDialog
#define KICAD_MESSAGE_DIALOG KICAD_MESSAGE_DIALOG_BASE
#endif
 

KICOMMON_API bool AskOverrideLock( wxWindow* aParent, const wxString& aMessage );
 

KICOMMON_API bool HandleUnsavedChanges( wxWindow* aParent, const wxString& aMessage,
                                        const std::function<bool()>& aSaveFunction );

KICOMMON_API int GetLastUnsavedChangesResponse();
 

KICOMMON_API int UnsavedChangesDialog( wxWindow* aParent, const wxString& aMessage,
                                       bool* aApplyToAll );
 
KICOMMON_API int UnsavedChangesDialog( wxWindow* aParent, const wxString& aMessage );
 

KICOMMON_API bool ConfirmRevertDialog( wxWindow* parent, const wxString& aMessage );
 

KICOMMON_API void DisplayError( wxWindow* aParent, const wxString& aText );

KICOMMON_API void DisplayErrorMessage( wxWindow* aParent, const wxString& aMessage,
                                       const wxString& aExtraInfo = wxEmptyString );
 

KICOMMON_API void DisplayInfoMessage( wxWindow* parent, const wxString& aMessage,
                                      const wxString& aExtraInfo = wxEmptyString );

KICOMMON_API bool IsOK( wxWindow* aParent, const wxString& aMessage );

KICOMMON_API int OKOrCancelDialog( wxWindow* aParent, const wxString& aWarning,
                                   const wxString& aMessage,
                                   const wxString& aDetailedMessage = wxEmptyString,
                                   const wxString& aOKLabel = wxEmptyString,
                                   const wxString& aCancelLabel = wxEmptyString,
                                   bool* aApplyToAll = nullptr );
 
 

KICOMMON_API int SelectSingleOption( wxWindow* aParent, const wxString& aTitle,
                                     const wxString& aMessage,
                                     const wxArrayString& aOptions );
 
#endif /* __INCLUDE__CONFIRM_H__ */