VSTGUI
4.10
Graphical User Interface Framework not only for VST plugins
|
Application interface. More...
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. | |
virtual IPreference & | getPreferences () const =0 |
Get the application preferences. | |
virtual const CommandLineArguments & | getCommandLineArguments () const =0 |
Get the command line arguments. | |
virtual const ISharedUIResources & | getSharedUIResources () const =0 |
Get the shared UI resources. | |
virtual const ICommonDirectories & | getCommonDirectories () const =0 |
Get common directories. | |
virtual WindowPtr | createWindow (const WindowConfiguration &config, const WindowControllerPtr &controller)=0 |
Create a new window. | |
virtual const WindowList & | getWindows () const =0 |
Get all application windows. | |
virtual AlertResult | showAlertBox (const AlertBoxConfig &config)=0 |
Show an application wide modal alert box. | |
virtual void | showAlertBoxForWindow (const AlertBoxForWindowConfig &config)=0 |
Show an alert box modal to a window. | |
virtual void | registerCommand (const Command &command, char16_t defaultCommandKey)=0 |
Register a command. | |
virtual bool | executeCommand (const Command &command)=0 |
Execute a command. | |
virtual void | enableTooltips (bool state)=0 |
Enable or disable tooltips in all windows. | |
virtual void | quit ()=0 |
Quit the application. | |
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. | |
Application interface.
using CommandLineArguments = std::vector<UTF8String> |
using WindowList = std::vector<WindowPtr> |
|
pure virtual |
Create a new window.
config | window configuration |
controller | window controller (can be nullptr) |
|
pure virtual |
Enable or disable tooltips in all windows.
state | true to enable tooltips, false for disabling them |
|
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.
command | command name and group |
|
pure virtual |
Get the command line arguments.
|
pure virtual |
Get common directories.
|
pure virtual |
Get the application delegate.
|
pure virtual |
Get the application preferences.
|
pure virtual |
Get the shared UI resources.
|
pure virtual |
Get all application windows.
|
static |
Get the global instance of the application.
|
pure virtual |
Quit the application.
|
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.
command | command name and group |
defaultCommandKey | default command key |
|
pure virtual |
Show an application wide modal alert box.
config | alert box configuration |
|
pure virtual |
Show an alert box modal to a window.
config | alert box configuration |