VSTGUI 4.10 Graphical User Interface Framework not only for VST plugins

Public Types | Public Member Functions | Static Public Member Functions | List of all members
IApplication Class Referenceabstract
Standalone Library

Application interface. More...

`#include <iapplication.h>`

Inheritance diagram for IApplication:

## Public Types
using | WindowList = std::vector< WindowPtr >
using | CommandLineArguments = std::vector< UTF8String >

## Public Member Functions
virtual Application::IDelegate & | getDelegate () const =0
| Get the application delegate. More...
virtual IPreference & | getPreferences () const =0
| Get the application preferences. More...
virtual const CommandLineArguments & | getCommandLineArguments () const =0
| Get the command line arguments. More...
virtual const ISharedUIResources & | getSharedUIResources () const =0
| Get the shared UI resources. More...
virtual const ICommonDirectories & | getCommonDirectories () const =0
| Get common directories. More...
virtual WindowPtr | createWindow (const WindowConfiguration &config, const WindowControllerPtr &controller)=0
| Create a new window. More...
virtual const WindowList & | getWindows () const =0
| Get all application windows. More...
virtual AlertResult | showAlertBox (const AlertBoxConfig &config)=0
| Show an application wide modal alert box. More...
virtual void | showAlertBoxForWindow (const AlertBoxForWindowConfig &config)=0
| Show an alert box modal to a window. More...
virtual void | registerCommand (const Command &command, char16_t defaultCommandKey)=0
| Register a command. More...
virtual bool | executeCommand (const Command &command)=0
| Execute a command. More...
virtual void | enableTooltips (bool state)=0
| Enable or disable tooltips in all windows. More...
virtual void | quit ()=0
| Quit the application. More...
Public Member Functions inherited from Interface
virtual | ~Interface () noexcept
| Interface ()=default
| Interface (const Interface &)=delete
| Interface (Interface &&)=delete
Interface & | operator= (const Interface &)=delete
Interface & | operator= (Interface &&)=delete
template<typename T >
const auto | dynamicCast () const
template<typename T >
auto | dynamicCast ()

## Static Public Member Functions
static IApplication & | instance ()
| Get the global instance of the application. More...

## Detailed Description

Application interface.

## Member Typedef Documentation

## ◆ CommandLineArguments

using CommandLineArguments = std::vector<UTF8String>

## ◆ WindowList

using WindowList = std::vector<WindowPtr>

## Member Function Documentation

## ◆ createWindow()

virtual WindowPtr createWindow | ( | const WindowConfiguration & | config,
|  | const WindowControllerPtr & | controller
| ) |  |
| pure virtual

Create a new window.

Parameters

  config | window configuration
  controller | window controller (can be nullptr)

Returns
  shared window pointer

## ◆ enableTooltips()

virtual void enableTooltips | ( | bool | state | ) |
| pure virtual

Enable or disable tooltips in all windows.

Parameters

  state | true to enable tooltips, false for disabling them

## ◆ executeCommand()

virtual bool executeCommand | ( | const Command & | command | ) |
| pure virtual

Execute a command.

The command will be first dispatched to the active window (if there is one) and if the window did not handle the command the command is dispatched to the application delegate.

Parameters

  command | command name and group

Returns
  if the command was executed

## ◆ getCommandLineArguments()

virtual const CommandLineArguments & getCommandLineArguments | ( |  | ) | const
| pure virtual

Get the command line arguments.

## ◆ getCommonDirectories()

virtual const ICommonDirectories & getCommonDirectories | ( |  | ) | const
| pure virtual

Get common directories.

## ◆ getDelegate()

virtual Application::IDelegate & getDelegate | ( |  | ) | const
| pure virtual

Get the application delegate.

## ◆ getPreferences()

virtual IPreference & getPreferences | ( |  | ) | const
| pure virtual

Get the application preferences.

## ◆ getSharedUIResources()

virtual const ISharedUIResources & getSharedUIResources | ( |  | ) | const
| pure virtual

Get the shared UI resources.

## ◆ getWindows()

virtual const WindowList & 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

## ◆ instance()

static IApplication & instance | ( |  | ) |
| static

Get the global instance of the application.

## ◆ quit()

virtual void quit | ( |  | ) |
| pure virtual

Quit the application.

## ◆ registerCommand()

virtual void 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

  command | command name and group
  defaultCommandKey | default command key

## ◆ showAlertBox()

virtual AlertResult showAlertBox | ( | const AlertBoxConfig & | config | ) |
| pure virtual

Show an application wide modal alert box.

Parameters

  config | alert box configuration

Returns
  alert result

## ◆ showAlertBoxForWindow()

virtual void showAlertBoxForWindow | ( | const AlertBoxForWindowConfig & | config | ) |
| pure virtual

Show an alert box modal to a window.

Parameters

  config | alert box configuration

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

- iapplication.h