Gives a warning message, that can be dismissed, with crucially the ability to not see similar warnings again for this session. More...

Inheritance diagram for WarningDialog:

[legend]

Collaboration diagram for WarningDialog:

[legend]

Public Member Functions
	WarningDialog (wxWindow *parent, const TranslatableString &message, const TranslatableString &footer, bool showCancelButton)

Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()

	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

void	SetTitle (const TranslatableString &title)

void	SetLabel (const TranslatableString &title)

void	SetName (const TranslatableString &title)

void	SetName ()

Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	OnOK (wxCommandEvent &event)

Private Attributes
wxCheckBox *	mCheckBox

Detailed Description

Gives a warning message, that can be dismissed, with crucially the ability to not see similar warnings again for this session.

Definition at line 30 of file Warning.cpp.

Constructor & Destructor Documentation

◆ WarningDialog()

WarningDialog::WarningDialog	(	wxWindow *	parent,
		const TranslatableString &	message,
		const TranslatableString &	footer,
		bool	showCancelButton
	)

Definition at line 57 of file Warning.cpp.

:  wxDialogWrapper(parent, wxID_ANY, XO("Warning"),
            wxDefaultPosition, wxDefaultSize,
            (showCancelButton ? wxDEFAULT_DIALOG_STYLE : wxCAPTION | wxSYSTEM_MENU)) // Unlike wxDEFAULT_DIALOG_STYLE, no wxCLOSE_BOX.
{
   SetName();
 
   SetIcon(wxArtProvider::GetIcon(wxART_WARNING, wxART_MESSAGE_BOX));
   ShuttleGui S(this, eIsCreating);
 
   S.SetBorder(10);
   S.StartVerticalLay(false);
   {
      S.AddFixedText(message);
      mCheckBox = S.AddCheckBox(footer, false);
   }
   S.EndVerticalLay();
 
   S.SetBorder(0);
   S.AddStandardButtons(showCancelButton ? eOkButton | eCancelButton : eOkButton);
 
   Layout();
   GetSizer()->Fit(this);
   CentreOnParent();
}

References eCancelButton, eIsCreating, eOkButton, mCheckBox, S, and wxDialogWrapper::SetName().

Here is the call graph for this function:

Member Function Documentation

◆ OnOK()

void WarningDialog::OnOK ( wxCommandEvent & event )

private

Definition at line 85 of file Warning.cpp.

{
   EndModal(mCheckBox->GetValue() ? wxID_NO : wxID_YES); // return YES, if message should be shown again
}

References mCheckBox.

Member Data Documentation

◆ mCheckBox

wxCheckBox* WarningDialog::mCheckBox

private

Definition at line 42 of file Warning.cpp.

Referenced by OnOK(), and WarningDialog().

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

Warning.cpp

Public Member Functions

Private Member Functions