KIDIALOG Class Reference

Helper class to create more flexible dialogs, including 'do not show again' checkbox handling. More...

#include <confirm.h>

Inheritance diagram for KIDIALOG:

Public Types
enum	KD_TYPE {   KD_NONE, KD_INFO, KD_QUESTION, KD_WARNING,   KD_ERROR }
	< Dialog type. Selects appropriate icon and default dialog title More...

Public Member Functions
	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
	Shows the 'do not show again' checkbox. More...
void	DoNotShowCheckbox (wxString file, int line)
	Checks the 'do not show again' setting for the dialog. More...
bool	DoNotShowAgain () const
void	ForceShowAgain ()
bool	Show (bool aShow=true) override
int	ShowModal () override

Static Protected Member Functions
static wxString	getCaption (KD_TYPE aType, const wxString &aCaption)
static long	getStyle (KD_TYPE aType)

Protected Attributes
unsigned long	m_hash
bool	m_cancelMeansCancel

Detailed Description

Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.

Definition at line 45 of file confirm.h.

Member Enumeration Documentation

KD_TYPE

enum KIDIALOG::KD_TYPE

< Dialog type. Selects appropriate icon and default dialog title

Enumerator
KD_NONE
KD_INFO
KD_QUESTION
KD_WARNING
KD_ERROR

Definition at line 49 of file confirm.h.

{ KD_NONE, KD_INFO, KD_QUESTION, KD_WARNING, KD_ERROR };

Constructor & Destructor Documentation

KIDIALOG() [1/2]

KIDIALOG::KIDIALOG	(	wxWindow *	aParent,
		const wxString &	aMessage,
		const wxString &	aCaption,
		long	aStyle = wxOK
	)

Definition at line 37 of file confirm.cpp.

    : wxRichMessageDialog( aParent, aMessage, aCaption, aStyle | wxCENTRE | wxSTAY_ON_TOP ),
      m_hash( 0 ),
      m_cancelMeansCancel( true )
{
}

KIDIALOG() [2/2]

KIDIALOG::KIDIALOG	(	wxWindow *	aParent,
		const wxString &	aMessage,
		KD_TYPE	aType,
		const wxString &	aCaption = ""
	)

Definition at line 46 of file confirm.cpp.

    : wxRichMessageDialog( aParent, aMessage, getCaption( aType, aCaption ), getStyle( aType ) ),
      m_hash( 0 ),
      m_cancelMeansCancel( true )
{
}

Member Function Documentation

DoNotShowAgain()

bool KIDIALOG::DoNotShowAgain

(

)

const

Definition at line 63 of file confirm.cpp.

{
    return doNotShowAgainDlgs.count( m_hash ) > 0;
}

References doNotShowAgainDlgs, and m_hash.

DoNotShowCheckbox()

void KIDIALOG::DoNotShowCheckbox	(	wxString	file,
		int	line
	)

Checks the 'do not show again' setting for the dialog.

Definition at line 55 of file confirm.cpp.

{
    ShowCheckBox( _( "Do not show again" ), false );

    m_hash = std::hash<wxString>{}( aUniqueId ) + line;
}

References _, and m_hash.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), SYMBOL_EDIT_FRAME::ExportPart(), ZONE_FILLER::Fill(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), ROUTER_TOOL::InlineBreakTrack(), LEGACY_PLUGIN::loadZONE_CONTAINER(), KICAD_MANAGER_CONTROL::NewFromTemplate(), DIALOG_CONFIGURE_PATHS::OnGridCellChanging(), PCB_PARSER::parseZONE(), ROUTER_TOOL::performDragging(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), PNS_KICAD_IFACE_BASE::syncZone(), DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_SIM_SETTINGS::TransferDataFromWindow().

ForceShowAgain()

void KIDIALOG::ForceShowAgain

(

)

Definition at line 69 of file confirm.cpp.

{
    doNotShowAgainDlgs.erase( m_hash );
}

References doNotShowAgainDlgs, and m_hash.

getCaption()

wxString KIDIALOG::getCaption ( KD_TYPE  aType, const wxString &  aCaption  )

staticprotected

Definition at line 119 of file confirm.cpp.

{
    if( !aCaption.IsEmpty() )
        return aCaption;

    switch( aType )
    {
    case KD_NONE:       /* fall through */
    case KD_INFO:       return _( "Message" );
    case KD_QUESTION:   return _( "Question" );
    case KD_WARNING:    return _( "Warning" );
    case KD_ERROR:      return _( "Error" );
    }

    return wxEmptyString;
}

References _, KD_ERROR, KD_INFO, KD_NONE, KD_QUESTION, and KD_WARNING.

getStyle()

long KIDIALOG::getStyle ( KD_TYPE  aType )

staticprotected

Definition at line 137 of file confirm.cpp.

{
    long style = wxOK | wxCENTRE | wxSTAY_ON_TOP;

    switch( aType )
    {
    case KD_NONE:       break;
    case KD_INFO:       style |= wxICON_INFORMATION; break;
    case KD_QUESTION:   style |= wxICON_QUESTION; break;
    case KD_WARNING:    style |= wxICON_WARNING; break;
    case KD_ERROR:      style |= wxICON_ERROR; break;
    }

    return style;
}

References KD_ERROR, KD_INFO, KD_NONE, KD_QUESTION, and KD_WARNING.

SetOKCancelLabels()

bool KIDIALOG::SetOKCancelLabels ( const ButtonLabel &  ok, const ButtonLabel &  cancel  )

inlineoverride

Shows the 'do not show again' checkbox.

Definition at line 56 of file confirm.h.

References cancel, and m_cancelMeansCancel.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), ZONE_FILLER::Fill(), and DIALOG_SIM_SETTINGS::TransferDataFromWindow().

Show()

bool KIDIALOG::Show ( bool  aShow = true )

override

Definition at line 75 of file confirm.cpp.

{
    // We should check the do-not-show-again setting only when the dialog is displayed
    if( aShow )
    {
        // Check if this dialog should be shown to the user
        auto it = doNotShowAgainDlgs.find( m_hash );

        if( it != doNotShowAgainDlgs.end() )
            return it->second;
    }

    int ret = wxRichMessageDialog::Show( aShow );

    // Has the user asked not to show the dialog again?
    // Note that we don't save a Cancel value unless the Cancel button is being used for some
    // other function (which is actually more common than it being used for Cancel).
    if( IsCheckBoxChecked() && (!m_cancelMeansCancel || ret != wxID_CANCEL ) )
        doNotShowAgainDlgs[m_hash] = ret;

    return ret;
}

References doNotShowAgainDlgs, m_cancelMeansCancel, and m_hash.

ShowModal()

int KIDIALOG::ShowModal ( )

override

Definition at line 99 of file confirm.cpp.

{
    // Check if this dialog should be shown to the user
    auto it = doNotShowAgainDlgs.find( m_hash );

    if( it != doNotShowAgainDlgs.end() )
        return it->second;

    int ret = wxRichMessageDialog::ShowModal();

    // Has the user asked not to show the dialog again?
    // Note that we don't save a Cancel value unless the Cancel button is being used for some
    // other function (which is actually more common than it being used for Cancel).
    if( IsCheckBoxChecked() && (!m_cancelMeansCancel || ret != wxID_CANCEL ) )
        doNotShowAgainDlgs[m_hash] = ret;

    return ret;
}

References doNotShowAgainDlgs, m_cancelMeansCancel, and m_hash.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), PCB_BASE_EDIT_FRAME::CreateNewLibrary(), SYMBOL_EDIT_FRAME::ExportPart(), ZONE_FILLER::Fill(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), ROUTER_TOOL::InlineBreakTrack(), LEGACY_PLUGIN::loadZONE_CONTAINER(), KICAD_MANAGER_CONTROL::NewFromTemplate(), DIALOG_CONFIGURE_PATHS::OnGridCellChanging(), PCB_PARSER::parseZONE(), ROUTER_TOOL::performDragging(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), PCB_IO::Save(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), PNS_KICAD_IFACE_BASE::syncZone(), DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and DIALOG_SIM_SETTINGS::TransferDataFromWindow().

Member Data Documentation

m_cancelMeansCancel

bool KIDIALOG::m_cancelMeansCancel

protected

Definition at line 79 of file confirm.h.

Referenced by SetOKCancelLabels(), Show(), and ShowModal().

m_hash

unsigned long KIDIALOG::m_hash

protected

Definition at line 78 of file confirm.h.

Referenced by DoNotShowAgain(), DoNotShowCheckbox(), ForceShowAgain(), Show(), and ShowModal().

---

The documentation for this class was generated from the following files:

• confirm.h
• confirm.cpp