MultiDialog Class Reference

A dialog presenting an exclusive, multiple choice, help button, and log info. More...

Inheritance diagram for MultiDialog:

Collaboration diagram for MultiDialog:

Public Member Functions
	MultiDialog (wxWindow *pParent, const TranslatableString &message, const TranslatableString &title, const TranslatableStrings &buttons, const ManualPageID &helpPage, const TranslatableString &boxMsg, bool log)
	~MultiDialog ()
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)
void	OnShowLog (wxCommandEvent &event)
void	OnHelp (wxCommandEvent &event)

Private Attributes
wxRadioBox *	mRadioBox
ManualPageID	mHelpPage

Detailed Description

A dialog presenting an exclusive, multiple choice, help button, and log info.

Definition at line 41 of file MultiDialog.cpp.

Constructor & Destructor Documentation

MultiDialog()

MultiDialog::MultiDialog	(	wxWindow *	pParent,
		const TranslatableString &	message,
		const TranslatableString &	title,
		const TranslatableStrings &	buttons,
		const ManualPageID &	helpPage,
		const TranslatableString &	boxMsg,
		bool	log
	)

Definition at line 71 of file MultiDialog.cpp.

   : wxDialogWrapper(pParent, wxID_ANY, title,
               wxDefaultPosition, wxDefaultSize,
               wxCAPTION), // not wxDEFAULT_DIALOG_STYLE because we don't want wxCLOSE_BOX and wxSYSTEM_MENU
    mHelpPage( helpPage)
{
   SetName();
 
   ShuttleGui S{ this, eIsCreating };
   {
      S.SetBorder( 5 );
      S.StartVerticalLay( 0 );
      {
         S.StartHorizontalLay(wxALIGN_LEFT | wxALL, 0);
         {
            S.SetBorder( 0 );
            wxBitmap bitmap = wxArtProvider::GetIcon(wxART_WARNING,
               wxART_MESSAGE_BOX);
            auto icon = safenew wxStaticBitmap(S.GetParent(), -1, bitmap);
            S
               .Position( wxCENTER )
               .AddWindow( icon );
 
            S.SetBorder( 15 );
            S.Prop(1).AddVariableText( message, false, wxCENTER | wxLEFT );
         }
         S.EndHorizontalLay();
 
         const auto buttonLabels = transform_container<wxArrayStringEx>(
            buttons, std::mem_fn( &TranslatableString::Translation ) );
 
         const auto count = buttons.size();
         
         const auto boxStr = boxMsg.Translation();
 
         S.SetBorder( 5 );
 
         mRadioBox = safenew wxRadioBox(S.GetParent(), -1,
            boxStr,
            wxDefaultPosition, wxDefaultSize,
            count, count ? &buttonLabels[0] : nullptr,
            1, wxRA_SPECIFY_COLS);
         mRadioBox->SetSelection(0);
         S.Prop( 1 )
            .Name( boxMsg )
            .Position(wxEXPAND | wxALL)
            .AddWindow( mRadioBox );
 
 
         S.StartHorizontalLay(wxALIGN_CENTER | wxALL, 0);
         {
            if (log)
            {
               S
                  .Id(ID_SHOW_LOG_BUTTON)
                  .AddButton(
                     XXO("Show Log for Details"), wxALIGN_LEFT | wxALL,
                     // set default to encourage user to look at files.
                     true);
 
               S.AddSpace(40, 0);
            }
 
            auto pButton = S.Id(wxID_OK)
               .AddButton(XXO("OK"), wxALIGN_CENTER, !log);
 
            if (!mHelpPage.empty()) {
               auto pHelpBtn = S.Id(wxID_HELP)
                  .AddBitmapButton(theTheme.Bitmap(bmpHelpIcon), wxALIGN_CENTER, false);
               pHelpBtn->SetToolTip(XO("Help").Translation());
               pHelpBtn->SetLabel(XO("Help").Translation());       // for screen readers
            }
         }
         S.EndHorizontalLay();
      }
      S.EndVerticalLay();
   }
 
   SetAutoLayout(true);
   GetSizer()->Fit(this);
   GetSizer()->SetSizeHints(this);
}

References ThemeBase::Bitmap(), eIsCreating, ID_SHOW_LOG_BUTTON, S, safenew, theTheme, TranslatableString::Translation(), XO(), and XXO().

Here is the call graph for this function:

~MultiDialog()

MultiDialog::~MultiDialog ( )

inline

Definition at line 50 of file MultiDialog.cpp.

{};

Member Function Documentation

OnHelp()

void MultiDialog::OnHelp ( wxCommandEvent &  event )

private

Definition at line 171 of file MultiDialog.cpp.

{
   HelpSystem::ShowHelp(FindWindow(wxID_HELP), mHelpPage, true);
}

References mHelpPage, and HelpSystem::ShowHelp().

Here is the call graph for this function:

OnOK()

void MultiDialog::OnOK ( wxCommandEvent &  event )

private

Definition at line 161 of file MultiDialog.cpp.

{
   EndModal(mRadioBox->GetSelection());
}

References mRadioBox.

OnShowLog()

void MultiDialog::OnShowLog ( wxCommandEvent &  event )

private

Definition at line 166 of file MultiDialog.cpp.

{
   LogWindow::Show();
}

References LogWindow::Show().

Here is the call graph for this function:

Member Data Documentation

mHelpPage

ManualPageID MultiDialog::mHelpPage

private

Definition at line 58 of file MultiDialog.cpp.

Referenced by OnHelp().

mRadioBox

wxRadioBox* MultiDialog::mRadioBox

private

Definition at line 57 of file MultiDialog.cpp.

Referenced by OnOK().

---

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

• MultiDialog.cpp