SynthApplication Class Reference

The main application class for Vital's standalone version. More...

Inheritance diagram for SynthApplication:

Classes
class	MainWindow
	The main window of the Vital standalone application. More...

Public Member Functions
	SynthApplication ()=default
const String	getApplicationName () override
	Returns the application's name.
const String	getApplicationVersion () override
	Returns the application's version number.
bool	moreThanOneInstanceAllowed () override
	Indicates whether multiple instances of this application are allowed.
void	initialise (const String &command_line) override
	Initializes the application. Parses command-line options and may run headless tasks.
bool	loadFromCommandLine (const String &command_line)
	Attempts to load a file passed in from the command line.
void	shutdown () override
	Called when the application is being shut down. Cleans up the main window.
void	systemRequestedQuit () override
	Called when the system requests the application to quit.
void	anotherInstanceStarted (const String &command_line) override
	Called when another instance of this application starts up.

Detailed Description

The main application class for Vital's standalone version.

SynthApplication sets up the command-line interface, the main window (if not running headless), and handles tasks such as exporting wavetables, rendering audio to files, and showing help/version information.

Constructor & Destructor Documentation

SynthApplication()

SynthApplication::SynthApplication ( )

default

Member Function Documentation

anotherInstanceStarted()

void SynthApplication::anotherInstanceStarted ( const String & command_line )

inlineoverride

Called when another instance of this application starts up.

This attempts to load a file provided by the other instance's command line.

Parameters

command_line

The command-line arguments from the new instance.

getApplicationName()

const String SynthApplication::getApplicationName ( )

inlineoverride

Returns the application's name.

Returns

The application name string.

getApplicationVersion()

const String SynthApplication::getApplicationVersion ( )

inlineoverride

Returns the application's version number.

Returns

The application version string.

initialise()

void SynthApplication::initialise ( const String & command_line )

inlineoverride

Initializes the application. Parses command-line options and may run headless tasks.

Depending on flags, this may show version/help information, run table-to-wav conversion, render images or audio, or launch the GUI.

Parameters

command_line

The raw command-line string.

loadFromCommandLine()

bool SynthApplication::loadFromCommandLine ( const String & command_line )

inline

Attempts to load a file passed in from the command line.

Parameters

command_line

The file path or command-line argument to attempt to load.

Returns

True if the file was loaded successfully; false otherwise.

moreThanOneInstanceAllowed()

bool SynthApplication::moreThanOneInstanceAllowed ( )

inlineoverride

Indicates whether multiple instances of this application are allowed.

Returns

True if multiple instances are allowed; false otherwise.

shutdown()

void SynthApplication::shutdown ( )

inlineoverride

Called when the application is being shut down. Cleans up the main window.

systemRequestedQuit()

void SynthApplication::systemRequestedQuit ( )

inlineoverride

Called when the system requests the application to quit.

---

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

• /Users/davidvogel/repos/VitalHelp/src/standalone/main.cpp