ASPiK SDK
VSTGUI::Standalone::IApplication Class Referenceabstract

#include <iapplication.h>

Inheritance diagram for VSTGUI::Standalone::IApplication:
VSTGUI::Interface VSTGUI::Standalone::Detail::IPlatformApplication VSTGUI::Standalone::Detail::Application

Public Types

using WindowList = std::vector< WindowPtr >
 
using CommandLineArguments = std::vector< UTF8String >
 

Public Member Functions

virtual Application::IDelegategetDelegate () const =0
 
virtual IPreferencegetPreferences () const =0
 
virtual const CommandLineArguments & getCommandLineArguments () const =0
 
virtual const ISharedUIResourcesgetSharedUIResources () const =0
 
virtual const ICommonDirectoriesgetCommonDirectories () const =0
 
virtual WindowPtr createWindow (const WindowConfiguration &config, const WindowControllerPtr &controller)=0
 
virtual const WindowList & getWindows () const =0
 
virtual AlertResult showAlertBox (const AlertBoxConfig &config)=0
 
virtual void showAlertBoxForWindow (const AlertBoxForWindowConfig &config)=0
 
virtual void registerCommand (const Command &command, char16_t defaultCommandKey)=0
 
virtual void quit ()=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 ()
 

Static Public Member Functions

static IApplicationinstance ()
 

Detailed Description

Application interface.

Member Function Documentation

◆ createWindow()

virtual WindowPtr VSTGUI::Standalone::IApplication::createWindow ( const WindowConfiguration config,
const WindowControllerPtr &  controller 
)
pure virtual

Create a new window

Parameters
configwindow configuration
controllerwindow controller (can be nullptr)
Returns
shared window pointer

Implemented in VSTGUI::Standalone::Detail::Application.

◆ getCommandLineArguments()

virtual const CommandLineArguments& VSTGUI::Standalone::IApplication::getCommandLineArguments ( ) const
pure virtual

Get the command line arguments

Implemented in VSTGUI::Standalone::Detail::Application.

◆ getCommonDirectories()

virtual const ICommonDirectories& VSTGUI::Standalone::IApplication::getCommonDirectories ( ) const
pure virtual

Get common directories

Implemented in VSTGUI::Standalone::Detail::Application.

◆ getDelegate()

virtual Application::IDelegate& VSTGUI::Standalone::IApplication::getDelegate ( ) const
pure virtual

Get the application delegate

Implemented in VSTGUI::Standalone::Detail::Application.

◆ getPreferences()

virtual IPreference& VSTGUI::Standalone::IApplication::getPreferences ( ) const
pure virtual

Get the application preferences

Implemented in VSTGUI::Standalone::Detail::Application.

◆ getSharedUIResources()

virtual const ISharedUIResources& VSTGUI::Standalone::IApplication::getSharedUIResources ( ) const
pure virtual

Get the shared UI resources

Implemented in VSTGUI::Standalone::Detail::Application.

◆ getWindows()

virtual const WindowList& VSTGUI::Standalone::IApplication::getWindows ( ) const
pure virtual

Get all application windows

Note
The active window will be the first in the list.
Returns
a list of all windows

Implemented in VSTGUI::Standalone::Detail::Application.

◆ instance()

IApplication & VSTGUI::Standalone::IApplication::instance ( )
static

Get the global instance of the application

◆ quit()

virtual void VSTGUI::Standalone::IApplication::quit ( )
pure virtual

Quit the application

Implemented in VSTGUI::Standalone::Detail::Application.

◆ registerCommand()

virtual void VSTGUI::Standalone::IApplication::registerCommand ( const Command command,
char16_t  defaultCommandKey 
)
pure virtual

Register a command

The command will be added to the application menu. When the menu item is selected the command is first dispatched to the active window and then to the application delegate.

Parameters
commandcommand name and group
defaultCommandKeydefault command key

Implemented in VSTGUI::Standalone::Detail::Application.

◆ showAlertBox()

virtual AlertResult VSTGUI::Standalone::IApplication::showAlertBox ( const AlertBoxConfig config)
pure virtual

Show an application wide modal alert box

Parameters
configalert box configuration
Returns
alert result

Implemented in VSTGUI::Standalone::Detail::Application.

◆ showAlertBoxForWindow()

virtual void VSTGUI::Standalone::IApplication::showAlertBoxForWindow ( const AlertBoxForWindowConfig config)
pure virtual

Show an alert box modal to a window

Parameters
configalert box configuration

Implemented in VSTGUI::Standalone::Detail::Application.


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