wxWidgetsBasicUI Class Reference

An implementation of BasicUI::Services in terms of the wxWidgets toolkit. More...

#include <wxWidgetsBasicUI.h>

Inheritance diagram for wxWidgetsBasicUI:

Collaboration diagram for wxWidgetsBasicUI:

Public Member Functions
	~wxWidgetsBasicUI () override
Public Member Functions inherited from BasicUI::Services
virtual	~Services ()
virtual void	DoCallAfter (const Action &action)=0
virtual void	DoYield ()=0
virtual void	DoShowErrorDialog (const WindowPlacement &placement, const TranslatableString &dlogTitle, const TranslatableString &message, const ManualPageID &helpPage, const ErrorDialogOptions &options)=0
virtual MessageBoxResult	DoMessageBox (const TranslatableString &message, MessageBoxOptions options)=0
virtual std::unique_ptr< ProgressDialog >	DoMakeProgress (const TranslatableString &title, const TranslatableString &message, unsigned flag, const TranslatableString &remainingLabelText)=0
virtual std::unique_ptr< GenericProgressDialog >	DoMakeGenericProgress (const WindowPlacement &placement, const TranslatableString &title, const TranslatableString &message, int style)=0
virtual int	DoMultiDialog (const TranslatableString &message, const TranslatableString &title, const TranslatableStrings &buttons, const ManualPageID &helpPage, const TranslatableString &boxMsg, bool log)=0
virtual bool	DoOpenInDefaultBrowser (const wxString &url)=0
virtual std::unique_ptr< WindowPlacement >	DoFindFocus ()=0
virtual void	DoSetFocus (const WindowPlacement &focus)=0
virtual bool	IsUsingRtlLayout () const =0
virtual bool	IsUiThread () const =0

Protected Member Functions
void	DoCallAfter (const BasicUI::Action &action) override
void	DoYield () override
void	DoShowErrorDialog (const BasicUI::WindowPlacement &placement, const TranslatableString &dlogTitle, const TranslatableString &message, const ManualPageID &helpPage, const BasicUI::ErrorDialogOptions &options) override
BasicUI::MessageBoxResult	DoMessageBox (const TranslatableString &message, BasicUI::MessageBoxOptions options) override
std::unique_ptr< BasicUI::ProgressDialog >	DoMakeProgress (const TranslatableString &title, const TranslatableString &message, unsigned flags, const TranslatableString &remainingLabelText) override
std::unique_ptr< BasicUI::GenericProgressDialog >	DoMakeGenericProgress (const BasicUI::WindowPlacement &placement, const TranslatableString &title, const TranslatableString &message, int style) override
int	DoMultiDialog (const TranslatableString &message, const TranslatableString &title, const TranslatableStrings &buttons, const ManualPageID &helpPage, const TranslatableString &boxMsg, bool log) override
bool	DoOpenInDefaultBrowser (const wxString &url) override
std::unique_ptr< BasicUI::WindowPlacement >	DoFindFocus () override
void	DoSetFocus (const BasicUI::WindowPlacement &focus) override
bool	IsUsingRtlLayout () const override
bool	IsUiThread () const override

Detailed Description

An implementation of BasicUI::Services in terms of the wxWidgets toolkit.

This is a singleton that doesn't need WX_INIT_API visibility

Definition at line 20 of file wxWidgetsBasicUI.h.

Constructor & Destructor Documentation

~wxWidgetsBasicUI()

wxWidgetsBasicUI::~wxWidgetsBasicUI ( )

overridedefault

Member Function Documentation

DoCallAfter()

void wxWidgetsBasicUI::DoCallAfter ( const BasicUI::Action &  action )

overrideprotectedvirtual

Implements BasicUI::Services.

Definition at line 29 of file wxWidgetsBasicUI.cpp.

{
   wxTheApp->CallAfter(action);
}

DoFindFocus()

std::unique_ptr< BasicUI::WindowPlacement > wxWidgetsBasicUI::DoFindFocus ( )

overrideprotectedvirtual

Implements BasicUI::Services.

Definition at line 243 of file wxWidgetsBasicUI.cpp.

{
   return std::make_unique<wxWidgetsWindowPlacement>(wxWindow::FindFocus());
}

References BasicUI::FindFocus().

Here is the call graph for this function:

DoMakeGenericProgress()

std::unique_ptr< GenericProgressDialog > wxWidgetsBasicUI::DoMakeGenericProgress ( const BasicUI::WindowPlacement &  placement, const TranslatableString &  title, const TranslatableString &  message, int  style  )

overrideprotectedvirtual

Implements BasicUI::Services.

Definition at line 208 of file wxWidgetsBasicUI.cpp.

{
   // Compute the style argument to pass to wxWidgets
   int flags = 0;
   if ((style & ProgressCanAbort))
      flags |= wxPD_CAN_ABORT;
   if ((style & ProgressAppModal))
      flags |= wxPD_APP_MODAL;
   if ((style & ProgressShowElapsedTime))
      flags |= wxPD_ELAPSED_TIME;
   if ((style & ProgressSmooth))
      flags |= wxPD_SMOOTH;
 
   return std::make_unique<MyGenericProgress>(
      title, message, wxWidgetsWindowPlacement::GetParent(placement), flags);
}

References wxWidgetsWindowPlacement::GetParent(), BasicUI::ProgressAppModal, BasicUI::ProgressCanAbort, BasicUI::ProgressShowElapsedTime, BasicUI::ProgressSmooth, anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style, and title.

Here is the call graph for this function:

DoMakeProgress()

std::unique_ptr< BasicUI::ProgressDialog > wxWidgetsBasicUI::DoMakeProgress ( const TranslatableString &  title, const TranslatableString &  message, unsigned  flags, const TranslatableString &  remainingLabelText  )

overrideprotectedvirtual

Implements BasicUI::Services.

Definition at line 159 of file wxWidgetsBasicUI.cpp.

{
   unsigned options = 0;
   if (!(flags & ProgressShowStop))
      options |= pdlgHideStopButton;
   if (!(flags & ProgressShowCancel))
      options |= pdlgHideCancelButton;
   if ((flags & ProgressHideTime))
      options |= pdlgHideElapsedTime;
   if ((flags & ProgressConfirmStopOrCancel))
      options |= pdlgConfirmStopCancel;
   // Usually wxWindow objects should not be managed by std::unique_ptr
   // See https://docs.wxwidgets.org/3.0/overview_windowdeletion.html
   // But on macOS the use of wxWindowPtr for the progress dialog sometimes
   // causes hangs.
   return std::make_unique<::ProgressDialog>(
      title, message, options, remainingLabelText);
}

References pdlgConfirmStopCancel, pdlgHideCancelButton, pdlgHideElapsedTime, pdlgHideStopButton, BasicUI::ProgressConfirmStopOrCancel, BasicUI::ProgressHideTime, BasicUI::ProgressShowCancel, BasicUI::ProgressShowStop, and title.

DoMessageBox()

BasicUI::MessageBoxResult wxWidgetsBasicUI::DoMessageBox ( const TranslatableString &  message, BasicUI::MessageBoxOptions  options  )

overrideprotectedvirtual

Implements BasicUI::Services.

Definition at line 88 of file wxWidgetsBasicUI.cpp.

{
   // Compute the style argument to pass to wxWidgets
   long style = 0;
   switch (options.iconStyle) {
      case Icon::Warning :
         style = wxICON_WARNING;
         break;
      case Icon::Error :
         style = wxICON_ERROR;
         break;
      case Icon::Question :
         style = wxICON_QUESTION;
         break;
      case Icon::Information :
         style = wxICON_INFORMATION;
         break;
      default:
         break;
   }
   switch (options.buttonStyle) {
      case Button::Ok :
         style |= wxOK;
         break;
      case Button::YesNo :
         style |= wxYES_NO;
         break;
      default:
         break;
   }
   if (!options.yesOrOkDefaultButton && options.buttonStyle == Button::YesNo)
      style |= wxNO_DEFAULT;
   if (options.cancelButton)
      style |= wxCANCEL;
   if (options.centered)
      style |= wxCENTER;
 
   // Preserving the default style AudacityMessageBox had,
   // when none of the above were explicitly specified
   if (!style)
      style = wxOK | wxCENTRE;
 
   // This calls through to ::wxMessageBox:
   auto wxResult =
      ::AudacityMessageBox(message, options.caption, style,
         options.parent
           ? wxWidgetsWindowPlacement::GetParent(*options.parent)
           : nullptr);
   // This switch exhausts all possibilities for the return from::wxMessageBox.
   // see utilscmn.cpp in wxWidgets.
   // Remap to our toolkit-neutral enumeration.
   switch (wxResult) {
   case wxYES:
      return MessageBoxResult::Yes;
   case wxNO:
      return MessageBoxResult::No;
   case wxOK:
      return MessageBoxResult::Ok;
   case wxCANCEL:
      return MessageBoxResult::Cancel;
   case wxHELP:
      // should not happen, because we don't ever pass wxHELP
   default:
      wxASSERT(false);
      return MessageBoxResult::None;
   }
}

References AudacityMessageBox(), BasicUI::MessageBoxOptions::buttonStyle, BasicUI::MessageBoxOptions::cancelButton, BasicUI::MessageBoxOptions::caption, BasicUI::MessageBoxOptions::centered, wxWidgetsWindowPlacement::GetParent(), BasicUI::MessageBoxOptions::iconStyle, BasicUI::MessageBoxOptions::parent, anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style, and BasicUI::MessageBoxOptions::yesOrOkDefaultButton.

Here is the call graph for this function:

DoMultiDialog()

int wxWidgetsBasicUI::DoMultiDialog ( const TranslatableString &  message, const TranslatableString &  title, const TranslatableStrings &  buttons, const ManualPageID &  helpPage, const TranslatableString &  boxMsg, bool  log  )

overrideprotectedvirtual

Implements BasicUI::Services.

Definition at line 229 of file wxWidgetsBasicUI.cpp.

{
   return ::ShowMultiDialog(message, title, buttons, helpPage, boxMsg, log);
}

References BasicUI::ShowMultiDialog(), and title.

Here is the call graph for this function:

DoOpenInDefaultBrowser()

bool wxWidgetsBasicUI::DoOpenInDefaultBrowser ( const wxString &  url )

overrideprotectedvirtual

Implements BasicUI::Services.

Definition at line 238 of file wxWidgetsBasicUI.cpp.

{
   return wxLaunchDefaultBrowser(url);
}

DoSetFocus()

void wxWidgetsBasicUI::DoSetFocus ( const BasicUI::WindowPlacement &  focus )

overrideprotectedvirtual

Implements BasicUI::Services.

Definition at line 248 of file wxWidgetsBasicUI.cpp.

{
   auto pWindow = wxWidgetsWindowPlacement::GetParent(focus);
   pWindow->SetFocus();
}

References wxWidgetsWindowPlacement::GetParent().

Here is the call graph for this function:

DoShowErrorDialog()

void wxWidgetsBasicUI::DoShowErrorDialog ( const BasicUI::WindowPlacement &  placement, const TranslatableString &  dlogTitle, const TranslatableString &  message, const ManualPageID &  helpPage, const BasicUI::ErrorDialogOptions &  options  )

overrideprotectedvirtual

Implements BasicUI::Services.

Definition at line 39 of file wxWidgetsBasicUI.cpp.

{
   using namespace BasicUI;
   bool modal = true;
   auto parent = wxWidgetsWindowPlacement::GetParent(placement);
   switch (options.type) {
      case ErrorDialogType::ModalErrorReport: {
#ifdef HAS_SENTRY_REPORTING
         ErrorReportDialog dlog(parent, dlogTitle, message, helpPage,
            options.log, modal);
 
         dlog.CentreOnParent();
         dlog.ShowModal();
         return;
#else
         break;
#endif
      }
      case ErrorDialogType::ModelessError: {
         if (!parent)
            parent = wxTheApp->GetTopWindow();
         // To be nonmodal, either it needs a parent, to avoid leaks, or it must
         // guarantee eventual deletion of itself.  There might be no top window
         // on MacOS.  Let's just force it to be modal in that case.
         if (parent)
            modal = false;
         break;
      }
      default:
         break;
   }
   auto pDlog = Destroy_ptr<ErrorDialog>( safenew ErrorDialog{ parent,
      dlogTitle, message, helpPage, options.log,
      options.modalHelp, modal } );
   pDlog->CentreOnParent();
   if (modal)
      pDlog->ShowModal();
   else {
      pDlog->Show();
      pDlog.release(); // not a memory leak, because it has a parent
   }
}

References wxWidgetsWindowPlacement::GetParent(), BasicUI::ErrorDialogOptions::log, BasicUI::ErrorDialogOptions::modalHelp, safenew, and BasicUI::ErrorDialogOptions::type.

Here is the call graph for this function:

DoYield()

void wxWidgetsBasicUI::DoYield ( )

overrideprotectedvirtual

Implements BasicUI::Services.

Definition at line 34 of file wxWidgetsBasicUI.cpp.

{
   wxTheApp->Yield();
}

IsUiThread()

bool wxWidgetsBasicUI::IsUiThread ( ) const

overrideprotectedvirtual

Implements BasicUI::Services.

Definition at line 259 of file wxWidgetsBasicUI.cpp.

{
   return wxIsMainThread();
}

IsUsingRtlLayout()

bool wxWidgetsBasicUI::IsUsingRtlLayout ( ) const

overrideprotectedvirtual

Implements BasicUI::Services.

Definition at line 254 of file wxWidgetsBasicUI.cpp.

{
   return wxLayout_RightToLeft == wxTheApp->GetLayoutDirection();
}

---

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

• wxWidgetsBasicUI.h
• wxWidgetsBasicUI.cpp