Audacity 3.2.0
Public Member Functions | List of all members
BasicUI::Services Class Referenceabstract

Abstract class defines a few user interface services, not mentioning particular toolkits. More...

#include <BasicUI.h>

Inheritance diagram for BasicUI::Services:
[legend]

Public Member Functions

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< ProgressDialogDoMakeProgress (const TranslatableString &title, const TranslatableString &message, unsigned flag, const TranslatableString &remainingLabelText)=0
 
virtual std::unique_ptr< GenericProgressDialogDoMakeGenericProgress (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< WindowPlacementDoFindFocus ()=0
 
virtual void DoSetFocus (const WindowPlacement &focus)=0
 
virtual bool IsUsingRtlLayout () const =0
 
virtual bool IsUiThread () const =0
 

Detailed Description

Abstract class defines a few user interface services, not mentioning particular toolkits.

The intention is that the application supplies a concrete implementation at startup. Most code will not use this class directly, but call the inline functions that follow.

Definition at line 199 of file BasicUI.h.

Constructor & Destructor Documentation

◆ ~Services()

BasicUI::Services::~Services ( )
virtualdefault

Member Function Documentation

◆ DoCallAfter()

virtual void BasicUI::Services::DoCallAfter ( const Action action)
pure virtual

Implemented in wxWidgetsBasicUI.

◆ DoFindFocus()

virtual std::unique_ptr< WindowPlacement > BasicUI::Services::DoFindFocus ( )
pure virtual

Implemented in wxWidgetsBasicUI.

◆ DoMakeGenericProgress()

virtual std::unique_ptr< GenericProgressDialog > BasicUI::Services::DoMakeGenericProgress ( const WindowPlacement placement,
const TranslatableString title,
const TranslatableString message,
int  style 
)
pure virtual

Implemented in wxWidgetsBasicUI.

◆ DoMakeProgress()

virtual std::unique_ptr< ProgressDialog > BasicUI::Services::DoMakeProgress ( const TranslatableString title,
const TranslatableString message,
unsigned  flag,
const TranslatableString remainingLabelText 
)
pure virtual

Implemented in wxWidgetsBasicUI.

◆ DoMessageBox()

virtual MessageBoxResult BasicUI::Services::DoMessageBox ( const TranslatableString message,
MessageBoxOptions  options 
)
pure virtual

Implemented in wxWidgetsBasicUI.

◆ DoMultiDialog()

virtual int BasicUI::Services::DoMultiDialog ( const TranslatableString message,
const TranslatableString title,
const TranslatableStrings buttons,
const ManualPageID helpPage,
const TranslatableString boxMsg,
bool  log 
)
pure virtual

Implemented in wxWidgetsBasicUI.

◆ DoOpenInDefaultBrowser()

virtual bool BasicUI::Services::DoOpenInDefaultBrowser ( const wxString &  url)
pure virtual

Implemented in wxWidgetsBasicUI.

◆ DoSetFocus()

virtual void BasicUI::Services::DoSetFocus ( const WindowPlacement focus)
pure virtual

Implemented in wxWidgetsBasicUI.

◆ DoShowErrorDialog()

virtual void BasicUI::Services::DoShowErrorDialog ( const WindowPlacement placement,
const TranslatableString dlogTitle,
const TranslatableString message,
const ManualPageID helpPage,
const ErrorDialogOptions options 
)
pure virtual

Implemented in wxWidgetsBasicUI.

◆ DoYield()

virtual void BasicUI::Services::DoYield ( )
pure virtual

Implemented in wxWidgetsBasicUI.

◆ IsUiThread()

virtual bool BasicUI::Services::IsUiThread ( ) const
pure virtual

Implemented in wxWidgetsBasicUI.

◆ IsUsingRtlLayout()

virtual bool BasicUI::Services::IsUsingRtlLayout ( ) const
pure virtual

Implemented in wxWidgetsBasicUI.


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