ASPiK SDK
VSTGUI::Standalone::Detail::Application Class Referencefinal
Inheritance diagram for VSTGUI::Standalone::Detail::Application:
VSTGUI::Standalone::Detail::IPlatformApplication VSTGUI::Standalone::IApplication VSTGUI::Standalone::IWindowListener VSTGUI::Standalone::ICommandHandler VSTGUI::Interface VSTGUI::Interface VSTGUI::Interface

Public Member Functions

void setDelegate (Standalone::Application::DelegatePtr &&delegate)
 
IPreferencegetPreferences () const override
 
const CommandLineArguments & getCommandLineArguments () const override
 
const ISharedUIResourcesgetSharedUIResources () const override
 
const ICommonDirectoriesgetCommonDirectories () const override
 
Standalone::Application::IDelegategetDelegate () const override
 
WindowPtr createWindow (const WindowConfiguration &config, const WindowControllerPtr &controller) override
 
const WindowList & getWindows () const override
 
AlertResult showAlertBox (const AlertBoxConfig &config) override
 
void showAlertBoxForWindow (const AlertBoxForWindowConfig &config) override
 
void registerCommand (const Command &command, char16_t defaultCommandKey=0) override
 
void quit () override
 
void onSizeChanged (const IWindow &window, const CPoint &newSize) override
 
void onPositionChanged (const IWindow &window, const CPoint &newPosition) override
 
void onShow (const IWindow &window) override
 
void onHide (const IWindow &window) override
 
void onClosed (const IWindow &window) override
 
void onActivated (const IWindow &window) override
 
void onDeactivated (const IWindow &window) override
 
bool canHandleCommand (const Command &command) override
 
bool handleCommand (const Command &command) override
 
void init (const InitParams &params) override
 
CommandList getCommandList (const Platform::IWindow *window) override
 
const CommandList & getKeyCommandList () override
 
bool canQuit () override
 
bool dontClosePopupOnDeactivation (Platform::IWindow *window) override
 
- 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 Applicationinstance ()
 
- Static Public Member Functions inherited from VSTGUI::Standalone::IApplication
static IApplicationinstance ()
 

Additional Inherited Members

- Public Types inherited from VSTGUI::Standalone::Detail::IPlatformApplication
using CommandWithKeyList = std::vector< CommandWithKey >
 
using CommandListPair = std::pair< UTF8String, CommandWithKeyList >
 
using CommandList = std::vector< CommandListPair >
 
- Public Types inherited from VSTGUI::Standalone::IApplication
using WindowList = std::vector< WindowPtr >
 
using CommandLineArguments = std::vector< UTF8String >
 

Member Function Documentation

◆ canHandleCommand()

bool VSTGUI::Standalone::Detail::Application::canHandleCommand ( const Command command)
overridevirtual

Check if command can be handled.

Implements VSTGUI::Standalone::ICommandHandler.

◆ createWindow()

WindowPtr VSTGUI::Standalone::Detail::Application::createWindow ( const WindowConfiguration config,
const WindowControllerPtr &  controller 
)
overridevirtual

Create a new window

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

Implements VSTGUI::Standalone::IApplication.

◆ getCommandLineArguments()

const Application::CommandLineArguments & VSTGUI::Standalone::Detail::Application::getCommandLineArguments ( ) const
overridevirtual

Get the command line arguments

Implements VSTGUI::Standalone::IApplication.

◆ getCommonDirectories()

const ICommonDirectories & VSTGUI::Standalone::Detail::Application::getCommonDirectories ( ) const
overridevirtual

Get common directories

Implements VSTGUI::Standalone::IApplication.

◆ getDelegate()

Standalone::Application::IDelegate & VSTGUI::Standalone::Detail::Application::getDelegate ( ) const
overridevirtual

Get the application delegate

Implements VSTGUI::Standalone::IApplication.

◆ getPreferences()

IPreference & VSTGUI::Standalone::Detail::Application::getPreferences ( ) const
overridevirtual

Get the application preferences

Implements VSTGUI::Standalone::IApplication.

◆ getSharedUIResources()

const ISharedUIResources & VSTGUI::Standalone::Detail::Application::getSharedUIResources ( ) const
overridevirtual

Get the shared UI resources

Implements VSTGUI::Standalone::IApplication.

◆ getWindows()

const WindowList& VSTGUI::Standalone::Detail::Application::getWindows ( ) const
inlineoverridevirtual

Get all application windows

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

Implements VSTGUI::Standalone::IApplication.

◆ handleCommand()

bool VSTGUI::Standalone::Detail::Application::handleCommand ( const Command command)
overridevirtual

Handle command.

Implements VSTGUI::Standalone::ICommandHandler.

◆ onActivated()

void VSTGUI::Standalone::Detail::Application::onActivated ( const IWindow window)
overridevirtual

Window is activated.

Implements VSTGUI::Standalone::IWindowListener.

◆ onClosed()

void VSTGUI::Standalone::Detail::Application::onClosed ( const IWindow window)
overridevirtual

◆ onDeactivated()

void VSTGUI::Standalone::Detail::Application::onDeactivated ( const IWindow window)
inlineoverridevirtual

Window is deactivated.

Implements VSTGUI::Standalone::IWindowListener.

◆ onHide()

void VSTGUI::Standalone::Detail::Application::onHide ( const IWindow window)
inlineoverridevirtual

◆ onPositionChanged()

void VSTGUI::Standalone::Detail::Application::onPositionChanged ( const IWindow window,
const CPoint newPosition 
)
inlineoverridevirtual

Position of window is changed.

Implements VSTGUI::Standalone::IWindowListener.

◆ onShow()

void VSTGUI::Standalone::Detail::Application::onShow ( const IWindow window)
inlineoverridevirtual

◆ onSizeChanged()

void VSTGUI::Standalone::Detail::Application::onSizeChanged ( const IWindow window,
const CPoint newSize 
)
inlineoverridevirtual

Size of window is changed.

Implements VSTGUI::Standalone::IWindowListener.

◆ quit()

void VSTGUI::Standalone::Detail::Application::quit ( )
overridevirtual

Quit the application

Implements VSTGUI::Standalone::IApplication.

◆ registerCommand()

void VSTGUI::Standalone::Detail::Application::registerCommand ( const Command command,
char16_t  defaultCommandKey = 0 
)
overridevirtual

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

Implements VSTGUI::Standalone::IApplication.

◆ showAlertBox()

AlertResult VSTGUI::Standalone::Detail::Application::showAlertBox ( const AlertBoxConfig config)
overridevirtual

Show an application wide modal alert box

Parameters
configalert box configuration
Returns
alert result

Implements VSTGUI::Standalone::IApplication.

◆ showAlertBoxForWindow()

void VSTGUI::Standalone::Detail::Application::showAlertBoxForWindow ( const AlertBoxForWindowConfig config)
overridevirtual

Show an alert box modal to a window

Parameters
configalert box configuration

Implements VSTGUI::Standalone::IApplication.


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