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 (C) 1992-2021 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 <wx/richmsgdlg.h>
#include <vector>
#include <functional>
 
class wxCheckBox;
class wxStaticBitmap;
 
class KIDIALOG : public wxRichMessageDialog
{
public:
 enum KD_TYPE { KD_NONE, KD_INFO, KD_QUESTION, KD_WARNING, KD_ERROR };
 
 KIDIALOG( wxWindow* aParent, const wxString& aMessage, const wxString& aCaption,
 long aStyle = wxOK );
 KIDIALOG( wxWindow* aParent, const wxString& aMessage, KD_TYPE aType,
 const wxString& aCaption = "" );
 
 bool SetOKCancelLabels( const ButtonLabel& ok, const ButtonLabel& cancel ) override
 {
 m_cancelMeansCancel = false;
 return wxRichMessageDialog::SetOKCancelLabels( ok, cancel );
 }
 
 void DoNotShowCheckbox( wxString file, int line );
 
 bool DoNotShowAgain() const;
 void ForceShowAgain();
 
 bool Show( bool aShow = true ) override;
 int ShowModal() override;
 
protected:
 // Helper functions for wxRichMessageDialog constructor
 static wxString getCaption( KD_TYPE aType, const wxString& aCaption );
 static long getStyle( KD_TYPE aType );
 
protected:
 unsigned long m_hash; // Unique id
 bool m_cancelMeansCancel; // If the Cancel button is renamed then it should be
 // saved by the DoNotShowAgain checkbox. If it's really
 // a cancel then it should not.
};
 
 
bool AskOverrideLock( wxWindow* aParent, const wxString& aMessage );
 
 
bool HandleUnsavedChanges( wxWindow* aParent, const wxString& aMessage,
 const std::function<bool()>& aSaveFunction );
 
 
int UnsavedChangesDialog( wxWindow* aParent, const wxString& aMessage, bool* aApplyToAll );
 
int UnsavedChangesDialog( wxWindow* aParent, const wxString& aMessage );
 
 
bool ConfirmRevertDialog( wxWindow* parent, const wxString& aMessage );
 
 
void DisplayError( wxWindow* aParent, const wxString& aText, int aDisplayTime = 0 );
 
void DisplayErrorMessage( wxWindow* aParent, const wxString& aMessage,
 const wxString& aExtraInfo = wxEmptyString );
 
 
void DisplayInfoMessage( wxWindow* parent, const wxString& aMessage,
 const wxString& aExtraInfo = wxEmptyString );
 
bool IsOK( wxWindow* aParent, const wxString& aMessage );
 
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 );
 
 
 
int SelectSingleOption( wxWindow* aParent, const wxString& aTitle, const wxString& aMessage,
 const wxArrayString& aOptions );
 
#endif /* __INCLUDE__CONFIRM_H__ */