ASPiK SDK
VSTGUI::Standalone::Application::IDelegate Class Referenceabstract

#include <iappdelegate.h>

Inheritance diagram for VSTGUI::Standalone::Application::IDelegate:
VSTGUI::Interface VSTGUI::Standalone::Application::DelegateAdapter Mandelbrot::AppDelegate MyApp::Delegate MyApplication VSTGUI::Standalone::GFXTestApp VSTGUI::Standalone::UIDescriptionEditorApp

Public Member Functions

virtual void finishLaunching ()=0
 
virtual void onQuit ()=0
 
virtual bool canQuit ()=0
 
virtual void showAboutDialog ()=0
 
virtual bool hasAboutDialog ()=0
 
virtual void showPreferenceDialog ()=0
 
virtual bool hasPreferenceDialog ()=0
 
virtual const InfogetInfo () const =0
 
virtual UTF8StringPtr getSharedUIResourceFilename () const =0
 
virtual bool openFiles (const std::vector< UTF8String > &paths)=0
 
- Public Member Functions inherited from VSTGUI::Interface
 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

◆ canQuit()

virtual bool VSTGUI::Standalone::Application::IDelegate::canQuit ( )
pure virtual

Called to check if it is currently possible to quit.

Implemented in VSTGUI::Standalone::Application::DelegateAdapter.

◆ finishLaunching()

virtual void VSTGUI::Standalone::Application::IDelegate::finishLaunching ( )
pure virtual

◆ getInfo()

virtual const Info& VSTGUI::Standalone::Application::IDelegate::getInfo ( ) const
pure virtual

Get the application info.

Implemented in VSTGUI::Standalone::Application::DelegateAdapter.

◆ getSharedUIResourceFilename()

virtual UTF8StringPtr VSTGUI::Standalone::Application::IDelegate::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 MyApp::Delegate, and VSTGUI::Standalone::Application::DelegateAdapter.

◆ hasAboutDialog()

virtual bool VSTGUI::Standalone::Application::IDelegate::hasAboutDialog ( )
pure virtual

Is there an about dialog ?

Implemented in MyApp::Delegate, and VSTGUI::Standalone::Application::DelegateAdapter.

◆ hasPreferenceDialog()

virtual bool VSTGUI::Standalone::Application::IDelegate::hasPreferenceDialog ( )
pure virtual

Is there a preference dialog ?

Implemented in VSTGUI::Standalone::Application::DelegateAdapter.

◆ onQuit()

virtual void VSTGUI::Standalone::Application::IDelegate::onQuit ( )
pure virtual

Called when the application is terminating.

Implemented in VSTGUI::Standalone::Application::DelegateAdapter.

◆ openFiles()

virtual bool VSTGUI::Standalone::Application::IDelegate::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 VSTGUI::Standalone::Application::DelegateAdapter.

◆ showAboutDialog()

virtual void VSTGUI::Standalone::Application::IDelegate::showAboutDialog ( )
pure virtual

The delegate should show the about dialog.

Implemented in MyApp::Delegate, and VSTGUI::Standalone::Application::DelegateAdapter.

◆ showPreferenceDialog()

virtual void VSTGUI::Standalone::Application::IDelegate::showPreferenceDialog ( )
pure virtual

The delegate should show the preference dialog.

Implemented in VSTGUI::Standalone::Application::DelegateAdapter.


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