VSTGUI  4.10
Graphical User Interface Framework not only for VST plugins
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IDelegate Class Referenceabstract

Application delegate interface. More...

+ Inheritance diagram for IDelegate:

Public Member Functions

virtual void finishLaunching ()=0
 Called when the application has finished launching.
 
virtual void onQuit ()=0
 Called when the application is terminating.
 
virtual bool canQuit ()=0
 Called to check if it is currently possible to quit.
 
virtual void showAboutDialog ()=0
 The delegate should show the about dialog.
 
virtual bool hasAboutDialog ()=0
 Is there an about dialog ?
 
virtual void showPreferenceDialog ()=0
 The delegate should show the preference dialog.
 
virtual bool hasPreferenceDialog ()=0
 Is there a preference dialog ?
 
virtual const InfogetInfo () const =0
 Get the application info.
 
virtual UTF8StringPtr getSharedUIResourceFilename () const =0
 Get the filename of the shared UI resources.
 
virtual bool openFiles (const std::vector< UTF8String > &paths)=0
 Called when the system wants the app to open files.
 
- Public Member Functions inherited from Interface
virtual ~Interface () noexcept
 
 Interface ()=default
 
 Interface (const Interface &)=delete
 
 Interface (Interface &&)=delete
 
Interfaceoperator= (const Interface &)=delete
 
Interfaceoperator= (Interface &&)=delete
 
template<typename T >
const auto dynamicCast () const
 
template<typename T >
auto dynamicCast ()
 

Detailed Description

Application delegate interface.

Every VSTGUI application needs a delegate. It's a global instance which handles custom application behaviour.

You define it via Application::Init (std::make_unique<YourDelegateClassType> ())

Member Function Documentation

virtual bool canQuit ( )
pure virtual

Called to check if it is currently possible to quit.

Implemented in DelegateAdapter.

virtual void finishLaunching ( )
pure virtual

Called when the application has finished launching.

Implemented in DelegateAdapter.

virtual const Info& getInfo ( ) const
pure virtual

Get the application info.

Implemented in DelegateAdapter.

virtual UTF8StringPtr getSharedUIResourceFilename ( ) const
pure virtual

Get the filename of the shared UI resources.

If this returns a name than all the UI resources are shared between different uidesc files. If this returns a nullptr, every uidesc file has its own resources.

Implemented in DelegateAdapter.

virtual bool hasAboutDialog ( )
pure virtual

Is there an about dialog ?

Implemented in DelegateAdapter.

virtual bool hasPreferenceDialog ( )
pure virtual

Is there a preference dialog ?

Implemented in DelegateAdapter.

virtual void onQuit ( )
pure virtual

Called when the application is terminating.

Implemented in DelegateAdapter.

virtual bool openFiles ( const std::vector< UTF8String > &  paths)
pure virtual

Called when the system wants the app to open files.

Parameters
pathsUTF-8 encoded paths to the files
Returns
true on success

Implemented in DelegateAdapter.

virtual void showAboutDialog ( )
pure virtual

The delegate should show the about dialog.

Implemented in DelegateAdapter.

virtual void showPreferenceDialog ( )
pure virtual

The delegate should show the preference dialog.

Implemented in DelegateAdapter.


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