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

#include <kidialog.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

void	DoNotShowCheckbox (wxString file, int line)
	Shows the 'do not show again' checkbox.

bool	DoNotShowAgain () const
	Checks the 'do not show again' setting for the dialog.

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 49 of file kidialog.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 53 of file kidialog.h.

Constructor & Destructor Documentation

◆ KIDIALOG() [1/2]

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

Definition at line 33 of file kidialog.cpp.

◆ KIDIALOG() [2/2]

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

Definition at line 42 of file kidialog.cpp.

Member Function Documentation

◆ DoNotShowAgain()

bool KIDIALOG::DoNotShowAgain ( ) const

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

Definition at line 59 of file kidialog.cpp.

References doNotShowAgainDlgs, and m_hash.

Referenced by DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), and DIALOG_CONFIGURE_PATHS::OnGridCellChanging().

◆ DoNotShowCheckbox()

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

Shows the 'do not show again' checkbox.

Definition at line 51 of file kidialog.cpp.

References _, and m_hash.

Referenced by PCB_CONTROL::AppendBoard(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), DIALOG_TRACK_VIA_PROPERTIES::confirmShortingNets(), DESIGN_BLOCK_PANE::createNewDesignBlockLibrary(), PCB_BASE_EDIT_FRAME::createNewLibrary(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), SYMBOL_EDIT_FRAME::ExportSymbol(), ZONE_FILLER::Fill(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SYMBOL_EDIT_FRAME::ImportSymbol(), ROUTER_TOOL::InlineBreakTrack(), CLIPBOARD_IO::LoadBoard(), KICAD_MANAGER_CONTROL::NewFromTemplate(), PANEL_EMBEDDED_FILES::onExportFiles(), DIALOG_CONFIGURE_PATHS::OnGridCellChanging(), PCB_EDIT_FRAME::OpenProjectFiles(), ROUTER_TOOL::performDragging(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_FRAME::SelectUnit(), PNS_KICAD_IFACE_BASE::syncZone(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_EXPORT_IDF3::TransferDataFromWindow(), and DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataFromWindow().

◆ ForceShowAgain()

void KIDIALOG::ForceShowAgain ( )

Definition at line 65 of file kidialog.cpp.

References doNotShowAgainDlgs, and m_hash.

◆ getCaption()

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

staticprotected

Definition at line 115 of file kidialog.cpp.

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

◆ getStyle()

long KIDIALOG::getStyle ( KD_TYPE aType )

staticprotected

Definition at line 133 of file kidialog.cpp.

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

◆ SetOKCancelLabels()

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

inlineoverride

Definition at line 60 of file kidialog.h.

References cancel.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), DIALOG_TRACK_VIA_PROPERTIES::confirmShortingNets(), ZONE_FILLER::Fill(), and PANEL_EMBEDDED_FILES::onExportFiles().

◆ Show()

bool KIDIALOG::Show ( bool aShow = true )

override

Definition at line 71 of file kidialog.cpp.

References doNotShowAgainDlgs, m_cancelMeansCancel, and m_hash.

◆ ShowModal()

int KIDIALOG::ShowModal ( )

override

Definition at line 95 of file kidialog.cpp.

References doNotShowAgainDlgs, m_cancelMeansCancel, and m_hash.

Referenced by PANEL_EMBEDDED_FILES::AddEmbeddedFile(), PCB_CONTROL::AppendBoard(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::checkFootprintName(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), DIALOG_TRACK_VIA_PROPERTIES::confirmShortingNets(), DESIGN_BLOCK_PANE::createNewDesignBlockLibrary(), PCB_BASE_EDIT_FRAME::createNewLibrary(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), SYMBOL_EDIT_FRAME::ExportSymbol(), ZONE_FILLER::Fill(), DIALOG_EXPORT_ODBPP::GenerateODBPPFiles(), KICAD_MANAGER_FRAME::ImportNonKiCadProject(), SYMBOL_EDIT_FRAME::ImportSymbol(), ROUTER_TOOL::InlineBreakTrack(), CLIPBOARD_IO::LoadBoard(), KICAD_MANAGER_CONTROL::NewFromTemplate(), PANEL_EMBEDDED_FILES::onExportFiles(), DIALOG_CONFIGURE_PATHS::OnGridCellChanging(), PCB_EDIT_FRAME::OpenProjectFiles(), ROUTER_TOOL::performDragging(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SYMBOL_EDITOR_CONTROL::RenameSymbol(), FOOTPRINT_EDIT_FRAME::SaveFootprintAs(), SYMBOL_EDIT_FRAME::saveSymbolCopyAs(), SCH_EDIT_FRAME::SelectUnit(), SYMBOL_EDIT_FRAME::SetCurSymbol(), PNS_KICAD_IFACE_BASE::syncZone(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_EXPORT_IDF3::TransferDataFromWindow(), DIALOG_GENCAD_EXPORT_OPTIONS::TransferDataFromWindow(), PANEL_FP_EDITOR_GRAPHICS_DEFAULTS::TransferDataFromWindow(), and PANEL_SETUP_TEXT_AND_GRAPHICS::TransferDataFromWindow().

Member Data Documentation

◆ m_cancelMeansCancel

bool KIDIALOG::m_cancelMeansCancel

protected

Definition at line 83 of file kidialog.h.

Referenced by Show(), and ShowModal().

◆ m_hash

unsigned long KIDIALOG::m_hash