Initial release

engine/vendor/vst3sdk/vstgui4/vstgui/standalone/include/iapplication.h

@@ -0,0 +1,95 @@
+// This file is part of VSTGUI. It is subject to the license terms 
+// in the LICENSE file found in the top-level directory of this
+// distribution and at http://github.com/steinbergmedia/vstgui/LICENSE
+
+#pragma once
+
+#include "fwd.h"
+#include "iwindow.h"
+#include "interface.h"
+#include <cstdint>
+#include <vector>
+
+//------------------------------------------------------------------------
+namespace VSTGUI {
+namespace Standalone {
+
+//------------------------------------------------------------------------
+/** %Application interface.
+ *
+ *	@ingroup standalone
+ */
+class IApplication : public Interface
+{
+public:
+	using WindowList = std::vector<WindowPtr>;
+	using CommandLineArguments = std::vector<UTF8String>;
+
+	/** Get the global instance of the application */
+	static IApplication& instance ();
+	/** Get the application delegate */
+	virtual Application::IDelegate& getDelegate () const = 0;
+	/** Get the application preferences */
+	virtual IPreference& getPreferences () const = 0;
+	/** Get the command line arguments */
+	virtual const CommandLineArguments& getCommandLineArguments () const = 0;
+	/** Get the shared UI resources */
+	virtual const ISharedUIResources& getSharedUIResources () const = 0;
+	/** Get common directories */
+	virtual const ICommonDirectories& getCommonDirectories () const = 0;
+
+	/** Create a new window
+	 *
+	 *	@param config window configuration
+	 *	@param controller window controller (can be nullptr)
+	 *	@return shared window pointer
+	 */
+	virtual WindowPtr createWindow (const WindowConfiguration& config,
+	                                const WindowControllerPtr& controller) = 0;
+	/** Get all application windows
+	 *
+	 *	@note The active window will be the first in the list.
+	 *	@return a list of all windows
+	 */
+	virtual const WindowList& getWindows () const = 0;
+	/** Show an application wide modal alert box
+	 *
+	 *	@param config alert box configuration
+	 *	@return alert result
+	 */
+	virtual AlertResult showAlertBox (const AlertBoxConfig& config) = 0;
+	/** Show an alert box modal to a window
+	 *
+	 *	@param config alert box configuration
+	 */
+	virtual void showAlertBoxForWindow (const AlertBoxForWindowConfig& config) = 0;
+	/** 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.
+	 *
+	 *	@param command command name and group
+	 *	@param defaultCommandKey default command key
+	 */
+	virtual void registerCommand (const Command& command, char16_t defaultCommandKey) = 0;
+	/** 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.
+	 *
+	 *	@param command command name and group
+	 *	@return if the command was executed
+	 */
+	virtual bool executeCommand (const Command& command) = 0;
+	/** Enable or disable tooltips in all windows
+	 *
+	 *	@param state true to enable tooltips, false for disabling them
+	 */
+	virtual void enableTooltips (bool state) = 0;
+	/** Quit the application */
+	virtual void quit () = 0;
+};
+
+//------------------------------------------------------------------------
+} // Standalone
+} // VSTGUI