ErrorDialog Class Reference

Gives an Error message with an option for help. More...

#include <ErrorDialog.h>

Inheritance diagram for ErrorDialog:

Collaboration diagram for ErrorDialog:

Public Member Functions
	ErrorDialog (wxWindow *parent, const TranslatableString &dlogTitle, const TranslatableString &message, const ManualPageID &helpPage, const std::wstring &log, const bool Close=true, const bool modal=true)
virtual	~ErrorDialog ()
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	OnPane (wxCollapsiblePaneEvent &event)
void	OnOk (wxCommandEvent &event)
void	OnHelp (wxCommandEvent &event)

Private Attributes
ManualPageID	dhelpPage
bool	dClose
bool	dModal

Detailed Description

Gives an Error message with an option for help.

Definition at line 25 of file ErrorDialog.h.

Constructor & Destructor Documentation

ErrorDialog()

ErrorDialog::ErrorDialog	(	wxWindow *	parent,
		const TranslatableString &	dlogTitle,
		const TranslatableString &	message,
		const ManualPageID &	helpPage,
		const std::wstring &	log,
		const bool	Close = true,
		const bool	modal = true
	)

Definition at line 45 of file ErrorDialog.cpp.

:  wxDialogWrapper(parent, wxID_ANY, dlogTitle,
                   wxDefaultPosition, wxDefaultSize,
                   wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)
{
   SetName();
 
   long buttonMask;
 
   // only add the help button if we have a URL
   buttonMask = (helpPage.empty()) ? eOkButton : (eHelpButton | eOkButton);
   dhelpPage = helpPage;
   dClose = Close;
   dModal = modal;
 
   ShuttleGui S(this, eIsCreating);
 
   S.SetBorder(2);
   S.StartHorizontalLay(wxEXPAND, 0);
   {
      S.SetBorder(20);
      wxBitmap bitmap = wxArtProvider::GetBitmap(wxART_WARNING);
      S.AddWindow(safenew wxStaticBitmap(S.GetParent(), -1, bitmap));
 
      S.SetBorder(20);
      S.AddFixedText(message, false, 500);
   }
   S.EndHorizontalLay();
 
   S.SetBorder(2);
   if (!log.empty())
   {
      S.StartHorizontalLay(wxEXPAND, 1);
      {
         S.SetBorder(5);
 
         auto pane = safenew wxCollapsiblePane(S.GetParent(),
                                               wxID_ANY,
                                               XO("Show &Log...").Translation());
         S.Style(wxEXPAND | wxALIGN_LEFT);
         S.Prop(1);
         S.AddWindow(pane);
 
         ShuttleGui SI(pane->GetPane(), eIsCreating);
         auto text = SI.AddTextWindow(log);
         text->SetInsertionPointEnd();
         text->ShowPosition(text->GetLastPosition());
         text->SetMinSize(wxSize(700, 250));
      }
      S.EndHorizontalLay();
   }
 
   S.SetBorder(2);
   S.AddStandardButtons(buttonMask);
 
   Layout();
   GetSizer()->Fit(this);
   SetMinSize(GetSize());
   Center();
}

References ShuttleGuiBase::AddTextWindow(), eHelpButton, eIsCreating, eOkButton, S, safenew, and XO().

Here is the call graph for this function:

~ErrorDialog()

virtual ErrorDialog::~ErrorDialog ( )

inlinevirtual

Definition at line 36 of file ErrorDialog.h.

{}

Member Function Documentation

OnHelp()

void ErrorDialog::OnHelp ( wxCommandEvent &  event )

private

Definition at line 128 of file ErrorDialog.cpp.

{
   const auto &str = dhelpPage.GET();
   if( str.StartsWith(wxT("innerlink:")) )
   {
      HelpSystem::ShowHtmlText(
         this,
         TitleText(str.Mid( 10 ) ),
         HelpText( str.Mid( 10 )),
         false,
         true );
      return;
   }
   HelpSystem::ShowHelp( this, dhelpPage, dClose );
   //OpenInDefaultBrowser( dhelpURL );
   if(dClose)
      EndModal(true);
}

References dClose, dhelpPage, Identifier::GET(), HelpText(), HelpSystem::ShowHelp(), HelpSystem::ShowHtmlText(), str, TitleText(), and wxT().

Here is the call graph for this function:

OnOk()

void ErrorDialog::OnOk ( wxCommandEvent &  event )

private

Definition at line 120 of file ErrorDialog.cpp.

{
   if (dModal)
      EndModal(true);
   else
      Destroy();
}

References dModal.

OnPane()

void ErrorDialog::OnPane ( wxCollapsiblePaneEvent &  event )

private

Definition at line 112 of file ErrorDialog.cpp.

{
   if (!event.GetCollapsed())
   {
      Center();
   }
}

Member Data Documentation

dClose

bool ErrorDialog::dClose

private

Definition at line 40 of file ErrorDialog.h.

Referenced by OnHelp().

dhelpPage

ManualPageID ErrorDialog::dhelpPage

private

Definition at line 39 of file ErrorDialog.h.

Referenced by OnHelp().

dModal

bool ErrorDialog::dModal

private

Definition at line 41 of file ErrorDialog.h.

Referenced by OnOk().

---

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

• ErrorDialog.h
• ErrorDialog.cpp