kidialog.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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <kicommon.h>
#include <wx/richmsgdlg.h>
 
 
#if defined( _WIN32 ) && wxCHECK_VERSION( 3, 3, 0 )
#define KIDIALOG_BASE wxGenericRichMessageDialog
#else
#define KIDIALOG_BASE wxRichMessageDialog
#endif
 

class KICOMMON_API KIDIALOG : public KIDIALOG_BASE
{
public:
    static void ClearDoNotShowAgainDialogs();

    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 KIDIALOG_BASE::SetOKCancelLabels( ok, cancel );
    }

    void DoNotShowCheckbox( wxString file, int line );

    bool DoNotShowAgain() const;
 
    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.
};