The main window class creates a QQuickWindow and acts as an interface which provides properties and functions which can be called from Main.qml. More...

#include <MainWindow.hh>

Public Slots
void	OnAddPlugin (QString _plugin)
	Add a plugin to the window.

void	OnLoadConfig (const QString &_path)
	Callback when load configuration is selected.

void	OnSaveConfig ()
	Callback when "save configuration" is selected.

void	OnSaveConfigAs (const QString &_path)
	Callback when "save configuration as" is selected.

void	OnStopServer ()
	Callback when "shutdown simulation" is called.

Signals
void	configChanged ()
	Notifies when the window config has changed.

void	DefaultExitActionChanged ()
	Notifies when the defaultExitAction has changed.

void	DialogOnExitTextChanged ()
	Notifies when dialogOnExitText has changed.

void	ExitDialogCloseGuiTextChanged ()
	Notifies when exitDialogCloseGuiText has changed.

void	ExitDialogShowCloseGuiChanged ()
	Notifies when the exitDialogShowCloseGui flag has changed.

void	ExitDialogShowShutdownChanged ()
	Notifies when the exitDialogShowShutdown flag has changed.

void	ExitDialogShutdownTextChanged ()
	Notifies when exitDialogShutdownText has changed.

void	MaterialAccentChanged ()
	Notifies when the accent color has changed.

void	MaterialPrimaryChanged ()
	Notifies when the primary color has changed.

void	MaterialThemeChanged ()
	Notifies when the theme has changed.

void	notify (const QString &_message)
	Displays a message to the user The message will appear in a snackbar, this message requires to click on the button "Dismiss" to close the dialog.

void	notifyWithDuration (const QString &_message, int _duration)
	Displays a message to the user The message will appear in a snackbar, this message disappear when the duration is over, or if the user clicks outside or escape before that.

void	PluginCountChanged ()
	Notifies when the number of plugins has changed.

void	PluginToolBarColorDarkChanged ()
	Notifies when the toolbar color dark has changed.

void	PluginToolBarColorLightChanged ()
	Notifies when the toolbar color light has changed.

void	PluginToolBarTextColorDarkChanged ()
	Notifies when the toolbar text color dark has changed.

void	PluginToolBarTextColorLightChanged ()
	Notifies when the toolbar text color light has changed.

void	ShowDefaultDrawerOptsChanged ()
	Notifies when the show drawer default options flag has changed.

void	ShowDialogOnExitChanged ()
	Notifies when the showDialogOnExit flag has changed.

void	ShowDrawerChanged ()
	Notifies when the show drawer flag has changed.

void	ShowPluginMenuChanged ()
	Notifies when the show menu flag has changed.

void	ToolBarColorDarkChanged ()
	Notifies when the toolbar color dark has changed.

void	ToolBarColorLightChanged ()
	Notifies when the toolbar color light has changed.

void	ToolBarTextColorDarkChanged ()
	Notifies when the toolbar text color dark has changed.

void	ToolBarTextColorLightChanged ()
	Notifies when the toolbar text color light has changed.

Public Member Functions
	MainWindow ()
	Constructor.

virtual	~MainWindow ()
	Destructor.

bool	ApplyConfig (const WindowConfig &_config)
	Apply a WindowConfig to this window and keep a copy of it.

WindowConfig	CurrentWindowConfig () const
	Get the current window configuration.

Q_INVOKABLE ExitAction	DefaultExitAction () const
	Get the action performed when GUI closes without prompt.

Q_INVOKABLE QString	DialogOnExitText () const
	Get the text of prompt in exit dialog.

Q_INVOKABLE QString	ExitDialogCloseGuiText () const
	Get the text of the "Close GUI" button in exit dialog.

Q_INVOKABLE bool	ExitDialogShowCloseGui () const
	Get the flag to show "Close GUI" button in exit dialog.

Q_INVOKABLE bool	ExitDialogShowShutdown () const
	Get the flag to show "shutdown" button in exit dialog.

Q_INVOKABLE QString	ExitDialogShutdownText () const
	Get the text of the "shutdown" button in exit dialog.

Q_INVOKABLE QString	MaterialAccent () const
	Returns the material accent color.

Q_INVOKABLE QString	MaterialPrimary () const
	Returns the material primary color.

Q_INVOKABLE QString	MaterialTheme () const
	Returns the material theme.

Q_INVOKABLE int	PluginCount () const
	Returns the number of plugins current instantiated in the window.

Q_INVOKABLE QStringList	PluginListModel () const
	Return a list of all plugin names found.

Q_INVOKABLE QString	PluginToolBarColorDark () const
	Returns the plugin toolbar color for dark theme.

Q_INVOKABLE QString	PluginToolBarColorLight () const
	Returns the plugin toolbar color for light theme.

Q_INVOKABLE QString	PluginToolBarTextColorDark () const
	Returns the plugin toolbar text color for dark theme.

Q_INVOKABLE QString	PluginToolBarTextColorLight () const
	Returns the plugin toolbar text color for light theme.

QQuickWindow *	QuickWindow () const
	Get the QtQuick window created by this object.

void	SaveConfig (const std::string &_path)
	Save current window and plugin configuration to a file on disk. Will open an error dialog in case it's not possible to write to the path.

Q_INVOKABLE std::string	ServerControlService () const
	Get the topic of the server control service.

Q_INVOKABLE void	SetDefaultExitAction (enum ExitAction _defaultExitAction)
	Set the action performed when GUI closes without prompt.

Q_INVOKABLE void	SetDialogOnExitText (const QString &_dialogOnExitText)
	Set the text of the prompt in exit dialog.

Q_INVOKABLE void	SetExitDialogCloseGuiText (const QString &_exitDialogCloseGuiText)
	Set the text of the "Close GUI" button in exit dialog.

Q_INVOKABLE void	SetExitDialogShowCloseGui (bool _exitDialogShowCloseGui)
	Set the flag to show "Close GUI" button in exit dialog.

Q_INVOKABLE void	SetExitDialogShowShutdown (bool _exitDialogShowShutdown)
	Set the flag to show "shutdown" button in exit dialog.

Q_INVOKABLE void	SetExitDialogShutdownText (const QString &_exitDialogShutdownText)
	Set the text of the "shutdown" button in exit dialog.

Q_INVOKABLE void	SetMaterialAccent (const QString &_materialAccent)
	Sets the material accent color.

Q_INVOKABLE void	SetMaterialPrimary (const QString &_materialPrimary)
	Sets the material primary color.

Q_INVOKABLE void	SetMaterialTheme (const QString &_materialTheme)
	Sets the material theme.

Q_INVOKABLE void	SetPluginCount (const int _pluginCount)
	Sets the number of plugins current instantiated in the window.

Q_INVOKABLE void	SetPluginToolBarColorDark (const QString &_pluginPluginToolBarColorDark)
	Sets the plugin toolbar color for dark theme.

Q_INVOKABLE void	SetPluginToolBarColorLight (const QString &_pluginPluginToolBarColorLight)
	Sets the plugin toolbar color for light theme.

Q_INVOKABLE void	SetPluginToolBarTextColorDark (const QString &_pluginPluginToolBarTextColorDark)
	Sets the plugin toolbar text color for dark theme.

Q_INVOKABLE void	SetPluginToolBarTextColorLight (const QString &_pluginPluginToolBarTextColorLight)
	Sets the plugin toolbar text color for light theme.

void	SetRenderEngine (const std::string &_renderEngine)
	Set the Render engine GUI name passed by the command line.

Q_INVOKABLE void	SetServerControlService (const std::string &_service)
	Set the topic of the server control service.

Q_INVOKABLE void	SetShowDefaultDrawerOpts (const bool _showDefaultDrawerOpts)
	Set the flag to show the side drawer's default options.

Q_INVOKABLE void	SetShowDialogOnExit (bool _showDialogOnExit)
	Set the flag to show the confirmation dialog when exiting.

Q_INVOKABLE void	SetShowDrawer (const bool _showDrawer)
	Set the flag to show the side drawer.

Q_INVOKABLE void	SetShowPluginMenu (const bool _showPluginMenu)
	Set the flag to show the plugin menu.

Q_INVOKABLE void	SetToolBarColorDark (const QString &_toolBarColorDark)
	Sets the top toolbar color for dark theme.

Q_INVOKABLE void	SetToolBarColorLight (const QString &_toolBarColorLight)
	Sets the top toolbar color for light theme.

Q_INVOKABLE void	SetToolBarTextColorDark (const QString &_toolBarTextColorDark)
	Sets the top toolbar text color for dark theme.

Q_INVOKABLE void	SetToolBarTextColorLight (const QString &_toolBarTextColorLight)
	Sets the top toolbar text color for light theme.

Q_INVOKABLE bool	ShowDefaultDrawerOpts () const
	Get the flag to show the side drawer's default options.

Q_INVOKABLE bool	ShowDialogOnExit () const
	Get the flag to show the plugin menu.

Q_INVOKABLE bool	ShowDrawer () const
	Get the flag to show the side drawer.

Q_INVOKABLE bool	ShowPluginMenu () const
	Get the flag to show the plugin menu.

Q_INVOKABLE QString	ToolBarColorDark () const
	Returns the top toolbar color for dark theme.

Q_INVOKABLE QString	ToolBarColorLight () const
	Returns the top toolbar color for light theme.

Q_INVOKABLE QString	ToolBarTextColorDark () const
	Returns the top toolbar text color for dark theme.

Q_INVOKABLE QString	ToolBarTextColorLight () const
	Returns the top toolbar text color for light theme.

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method)

bool	disconnect (const QObject receiver, const char method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Properties
ExitAction	defaultExitAction
	Flag to enable confirmation dialog on exit.

QString	dialogOnExitText
	Text of the prompt in confirmation dialog on exit.

QString	exitDialogCloseGuiText
	Text of the "Close GUI" button in confirmation dialog on exit.

bool	exitDialogShowCloseGui
	Flag to show "close GUI" button in confirmation dialog on exit.

bool	exitDialogShowShutdown
	Flag to show "shutdown" button in confirmation dialog on exit.

QString	exitDialogShutdownText
	Text of the "shutdown" button in confirmation dialog on exit.

QString	materialAccent
	Material accent color (Pre-defined color name or hex value)

QString	materialPrimary
	Material primary color (Pre-defined color name or hex value)

QString	materialTheme
	Material theme (Light / Dark)

int	pluginCount
	Number of plugins currently instantiated inside the window.

QString	pluginToolBarColorDark
	Plugin toolbar color for dark theme (Pre-defined color name or hex value). Defaults to material accent.

QString	pluginToolBarColorLight
	Plugin toolbar color for light theme (Pre-defined color name or hex value). Defaults to material accent.

QString	pluginToolBarTextColorDark
	Plugin toolbar text color for dark theme (Pre-defined color name or hex value). Defaults to material foreground.

QString	pluginToolBarTextColorLight
	Plugin toolbar text color for light theme (Pre-defined color name or hex value). Defaults to material foreground.

bool	showDefaultDrawerOpts
	Flag to show side drawer's default options.

bool	showDialogOnExit
	Flag to enable confirmation dialog on exit.

bool	showDrawer
	Flag to show side drawer.

bool	showPluginMenu
	Flag to show plugins menu.

QString	toolBarColorDark
	Top toolbar color for dark theme (Pre-defined color name or hex value). Defaults to material primary.

QString	toolBarColorLight
	Top toolbar color for light theme (Pre-defined color name or hex value). Defaults to material primary.

QString	toolBarTextColorDark
	Top toolbar text color for dark theme (Pre-defined color name or hex value). Defaults to material background.

QString	toolBarTextColorLight
	Top toolbar text color for light theme (Pre-defined color name or hex value). Defaults to material background.

Properties inherited from QObject
	objectName

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Detailed Description

The main window class creates a QQuickWindow and acts as an interface which provides properties and functions which can be called from Main.qml.

Constructor & Destructor Documentation

◆ MainWindow()

MainWindow ( )

Constructor.

◆ ~MainWindow()

virtual ~MainWindow ( )

virtual

Destructor.

Member Function Documentation

◆ ApplyConfig()

bool ApplyConfig ( const WindowConfig & _config )

Apply a WindowConfig to this window and keep a copy of it.

Parameters

[in] _config The configuration to apply.

Returns: True if successful.

◆ configChanged

void configChanged ( )

signal

Notifies when the window config has changed.

◆ CurrentWindowConfig()

WindowConfig CurrentWindowConfig ( ) const

Get the current window configuration.

Returns: Updated window config

◆ DefaultExitAction()

Q_INVOKABLE ExitAction DefaultExitAction ( ) const

Get the action performed when GUI closes without prompt.

Returns: The action.

◆ DefaultExitActionChanged

void DefaultExitActionChanged ( )

signal

Notifies when the defaultExitAction has changed.

◆ DialogOnExitText()

Q_INVOKABLE QString DialogOnExitText ( ) const

Get the text of prompt in exit dialog.

Returns: Prompt text.

◆ DialogOnExitTextChanged

void DialogOnExitTextChanged ( )

signal

Notifies when dialogOnExitText has changed.

◆ ExitDialogCloseGuiText()

Q_INVOKABLE QString ExitDialogCloseGuiText ( ) const

Get the text of the "Close GUI" button in exit dialog.

Returns: Button text.

◆ ExitDialogCloseGuiTextChanged

void ExitDialogCloseGuiTextChanged ( )

signal

Notifies when exitDialogCloseGuiText has changed.

◆ ExitDialogShowCloseGui()

Q_INVOKABLE bool ExitDialogShowCloseGui ( ) const

Get the flag to show "Close GUI" button in exit dialog.

Returns: True to show.

◆ ExitDialogShowCloseGuiChanged

void ExitDialogShowCloseGuiChanged ( )

signal

Notifies when the exitDialogShowCloseGui flag has changed.

◆ ExitDialogShowShutdown()

Q_INVOKABLE bool ExitDialogShowShutdown ( ) const

Get the flag to show "shutdown" button in exit dialog.

Returns: True to show.

◆ ExitDialogShowShutdownChanged

void ExitDialogShowShutdownChanged ( )

signal

Notifies when the exitDialogShowShutdown flag has changed.

◆ ExitDialogShutdownText()

Q_INVOKABLE QString ExitDialogShutdownText ( ) const

Get the text of the "shutdown" button in exit dialog.

Returns: Button text.

◆ ExitDialogShutdownTextChanged

void ExitDialogShutdownTextChanged ( )

signal

Notifies when exitDialogShutdownText has changed.

◆ MaterialAccent()

Q_INVOKABLE QString MaterialAccent ( ) const

Returns the material accent color.

Returns: Accent color

◆ MaterialAccentChanged

void MaterialAccentChanged ( )

signal

Notifies when the accent color has changed.

◆ MaterialPrimary()

Q_INVOKABLE QString MaterialPrimary ( ) const

Returns the material primary color.

Returns: Primary color

◆ MaterialPrimaryChanged

void MaterialPrimaryChanged ( )

signal

Notifies when the primary color has changed.

◆ MaterialTheme()

Q_INVOKABLE QString MaterialTheme ( ) const

Returns the material theme.

Returns: Theme (Light / Dark)

◆ MaterialThemeChanged

void MaterialThemeChanged ( )

signal

Notifies when the theme has changed.

◆ notify

void notify ( const QString & _message )

signal

Displays a message to the user The message will appear in a snackbar, this message requires to click on the button "Dismiss" to close the dialog.

◆ notifyWithDuration

void notifyWithDuration	(	const QString &	_message,
		int	_duration
	)

signal

Displays a message to the user The message will appear in a snackbar, this message disappear when the duration is over, or if the user clicks outside or escape before that.

Parameters

[in]	_message	Message to show
[in]	_duration	Time in milliseconds that the message will appear

◆ OnAddPlugin

void OnAddPlugin ( QString _plugin )

slot

Add a plugin to the window.

Parameters

[in] _plugin Plugin filename

◆ OnLoadConfig

void OnLoadConfig ( const QString & _path )

slot

Callback when load configuration is selected.

◆ OnSaveConfig

void OnSaveConfig ( )

slot

Callback when "save configuration" is selected.

◆ OnSaveConfigAs

void OnSaveConfigAs ( const QString & _path )

slot

Callback when "save configuration as" is selected.

◆ OnStopServer

void OnStopServer ( )

slot

Callback when "shutdown simulation" is called.

◆ PluginCount()

Q_INVOKABLE int PluginCount ( ) const

Returns the number of plugins current instantiated in the window.

Returns: Number of plugins

◆ PluginCountChanged

void PluginCountChanged ( )

signal

Notifies when the number of plugins has changed.

◆ PluginListModel()

Q_INVOKABLE QStringList PluginListModel ( ) const

Return a list of all plugin names found.

Returns: List with plugin names

◆ PluginToolBarColorDark()

Q_INVOKABLE QString PluginToolBarColorDark ( ) const

Returns the plugin toolbar color for dark theme.

Returns: Toolbar color

◆ PluginToolBarColorDarkChanged

void PluginToolBarColorDarkChanged ( )

signal

Notifies when the toolbar color dark has changed.

◆ PluginToolBarColorLight()

Q_INVOKABLE QString PluginToolBarColorLight ( ) const

Returns the plugin toolbar color for light theme.

Returns: Toolbar color

◆ PluginToolBarColorLightChanged

void PluginToolBarColorLightChanged ( )

signal

Notifies when the toolbar color light has changed.

◆ PluginToolBarTextColorDark()

Q_INVOKABLE QString PluginToolBarTextColorDark ( ) const

Returns the plugin toolbar text color for dark theme.

Returns: Toolbar text color

◆ PluginToolBarTextColorDarkChanged

void PluginToolBarTextColorDarkChanged ( )

signal

Notifies when the toolbar text color dark has changed.

◆ PluginToolBarTextColorLight()

Q_INVOKABLE QString PluginToolBarTextColorLight ( ) const

Returns the plugin toolbar text color for light theme.

Returns: Toolbar text color

◆ PluginToolBarTextColorLightChanged

void PluginToolBarTextColorLightChanged ( )

signal

Notifies when the toolbar text color light has changed.

◆ QuickWindow()

QQuickWindow * QuickWindow ( ) const

Get the QtQuick window created by this object.

Returns: Pointer to the QtQuick window

◆ SaveConfig()

void SaveConfig ( const std::string & _path )

Save current window and plugin configuration to a file on disk. Will open an error dialog in case it's not possible to write to the path.

Parameters

[in] _path The full destination path including filename.

◆ ServerControlService()

Q_INVOKABLE std::string ServerControlService ( ) const

Get the topic of the server control service.

Returns: The service topic.

◆ SetDefaultExitAction()

Q_INVOKABLE void SetDefaultExitAction ( enum ExitAction _defaultExitAction )

Set the action performed when GUI closes without prompt.

Parameters

[in] _defaultExitAction The action.

◆ SetDialogOnExitText()

Q_INVOKABLE void SetDialogOnExitText ( const QString & _dialogOnExitText )

Set the text of the prompt in exit dialog.

Parameters

[in] _dialogOnExitText Prompt text.

◆ SetExitDialogCloseGuiText()

Q_INVOKABLE void SetExitDialogCloseGuiText ( const QString & _exitDialogCloseGuiText )

Set the text of the "Close GUI" button in exit dialog.

Parameters

[in] _exitDialogCloseGuiText Button text.

◆ SetExitDialogShowCloseGui()

Q_INVOKABLE void SetExitDialogShowCloseGui ( bool _exitDialogShowCloseGui )

Set the flag to show "Close GUI" button in exit dialog.

Parameters

[in] _exitDialogShowCloseGui True to show.

◆ SetExitDialogShowShutdown()

Q_INVOKABLE void SetExitDialogShowShutdown ( bool _exitDialogShowShutdown )

Set the flag to show "shutdown" button in exit dialog.

Parameters

[in] _exitDialogShowShutdown True to show.

◆ SetExitDialogShutdownText()

Q_INVOKABLE void SetExitDialogShutdownText ( const QString & _exitDialogShutdownText )

Set the text of the "shutdown" button in exit dialog.

Parameters

[in] _exitDialogShutdownText Button text.

◆ SetMaterialAccent()

Q_INVOKABLE void SetMaterialAccent ( const QString & _materialAccent )

Sets the material accent color.

Parameters

[in] _materialAccent Accent color

◆ SetMaterialPrimary()

Q_INVOKABLE void SetMaterialPrimary ( const QString & _materialPrimary )

Sets the material primary color.

Parameters

[in] _materialPrimary Primary color

◆ SetMaterialTheme()

Q_INVOKABLE void SetMaterialTheme ( const QString & _materialTheme )

Sets the material theme.

Parameters

[in] _materialTheme Theme (Light / Dark)

◆ SetPluginCount()

Q_INVOKABLE void SetPluginCount ( const int _pluginCount )

Sets the number of plugins current instantiated in the window.

Parameters

[in] _pluginCount Number of plugins

◆ SetPluginToolBarColorDark()

Q_INVOKABLE void SetPluginToolBarColorDark ( const QString & _pluginPluginToolBarColorDark )

Sets the plugin toolbar color for dark theme.

Parameters

[in] _pluginPluginToolBarColorDark Toolbar color

◆ SetPluginToolBarColorLight()

Q_INVOKABLE void SetPluginToolBarColorLight ( const QString & _pluginPluginToolBarColorLight )

Sets the plugin toolbar color for light theme.

Parameters

[in] _pluginPluginToolBarColorLight Toolbar color

◆ SetPluginToolBarTextColorDark()

Q_INVOKABLE void SetPluginToolBarTextColorDark ( const QString & _pluginPluginToolBarTextColorDark )

Sets the plugin toolbar text color for dark theme.

Parameters

[in] _pluginPluginToolBarTextColorDark Toolbar text color

◆ SetPluginToolBarTextColorLight()

Q_INVOKABLE void SetPluginToolBarTextColorLight ( const QString & _pluginPluginToolBarTextColorLight )

Sets the plugin toolbar text color for light theme.

Parameters

[in] _pluginPluginToolBarTextColorLight Toolbar text color

◆ SetRenderEngine()

void SetRenderEngine ( const std::string & _renderEngine )

Set the Render engine GUI name passed by the command line.

Parameters

[in] _renderEngine name of the render engine to use

◆ SetServerControlService()

Q_INVOKABLE void SetServerControlService ( const std::string & _service )

Set the topic of the server control service.

Parameters

[in] _service The service topic.

◆ SetShowDefaultDrawerOpts()

Q_INVOKABLE void SetShowDefaultDrawerOpts ( const bool _showDefaultDrawerOpts )

Set the flag to show the side drawer's default options.

Parameters

[in] _showDefaultDrawerOpts True to show.

◆ SetShowDialogOnExit()

Q_INVOKABLE void SetShowDialogOnExit ( bool _showDialogOnExit )

Set the flag to show the confirmation dialog when exiting.

Parameters

[in] _showDialogOnExit True to show.

◆ SetShowDrawer()

Q_INVOKABLE void SetShowDrawer ( const bool _showDrawer )

Set the flag to show the side drawer.

Parameters

[in] _showDrawer True to show.

◆ SetShowPluginMenu()

Q_INVOKABLE void SetShowPluginMenu ( const bool _showPluginMenu )

Set the flag to show the plugin menu.

Parameters

[in] _showPluginMenu True to show.

◆ SetToolBarColorDark()

Q_INVOKABLE void SetToolBarColorDark ( const QString & _toolBarColorDark )

Sets the top toolbar color for dark theme.

Parameters

[in] _toolBarColorDark Toolbar color

◆ SetToolBarColorLight()

Q_INVOKABLE void SetToolBarColorLight ( const QString & _toolBarColorLight )

Sets the top toolbar color for light theme.

Parameters

[in] _toolBarColorLight Toolbar color

◆ SetToolBarTextColorDark()

Q_INVOKABLE void SetToolBarTextColorDark ( const QString & _toolBarTextColorDark )

Sets the top toolbar text color for dark theme.

Parameters

[in] _toolBarTextColorDark Toolbar text color

◆ SetToolBarTextColorLight()

Q_INVOKABLE void SetToolBarTextColorLight ( const QString & _toolBarTextColorLight )

Sets the top toolbar text color for light theme.

Parameters

[in] _toolBarTextColorLight Toolbar text color

◆ ShowDefaultDrawerOpts()

Q_INVOKABLE bool ShowDefaultDrawerOpts ( ) const

Get the flag to show the side drawer's default options.

Returns: True to show.

◆ ShowDefaultDrawerOptsChanged

void ShowDefaultDrawerOptsChanged ( )

signal

Notifies when the show drawer default options flag has changed.

◆ ShowDialogOnExit()

Q_INVOKABLE bool ShowDialogOnExit ( ) const

Get the flag to show the plugin menu.

Returns: True to show.

◆ ShowDialogOnExitChanged

void ShowDialogOnExitChanged ( )

signal

Notifies when the showDialogOnExit flag has changed.

◆ ShowDrawer()

Q_INVOKABLE bool ShowDrawer ( ) const

Get the flag to show the side drawer.

Returns: True to show.

◆ ShowDrawerChanged

void ShowDrawerChanged ( )

signal

Notifies when the show drawer flag has changed.

◆ ShowPluginMenu()

Q_INVOKABLE bool ShowPluginMenu ( ) const

Get the flag to show the plugin menu.

Returns: True to show.

◆ ShowPluginMenuChanged

void ShowPluginMenuChanged ( )

signal

Notifies when the show menu flag has changed.

◆ ToolBarColorDark()

Q_INVOKABLE QString ToolBarColorDark ( ) const

Returns the top toolbar color for dark theme.

Returns: Toolbar color

◆ ToolBarColorDarkChanged

void ToolBarColorDarkChanged ( )

signal

Notifies when the toolbar color dark has changed.

◆ ToolBarColorLight()

Q_INVOKABLE QString ToolBarColorLight ( ) const

Returns the top toolbar color for light theme.

Returns: Toolbar color

◆ ToolBarColorLightChanged

void ToolBarColorLightChanged ( )

signal

Notifies when the toolbar color light has changed.

◆ ToolBarTextColorDark()

Q_INVOKABLE QString ToolBarTextColorDark ( ) const

Returns the top toolbar text color for dark theme.

Returns: Toolbar text color

◆ ToolBarTextColorDarkChanged

void ToolBarTextColorDarkChanged ( )

signal

Notifies when the toolbar text color dark has changed.

◆ ToolBarTextColorLight()

Q_INVOKABLE QString ToolBarTextColorLight ( ) const

Returns the top toolbar text color for light theme.

Returns: Toolbar text color

◆ ToolBarTextColorLightChanged

void ToolBarTextColorLightChanged ( )

signal

Notifies when the toolbar text color light has changed.

Property Documentation

◆ defaultExitAction

ExitAction defaultExitAction

readwrite

Flag to enable confirmation dialog on exit.

◆ dialogOnExitText

QString dialogOnExitText

readwrite

Text of the prompt in confirmation dialog on exit.

◆ exitDialogCloseGuiText

QString exitDialogCloseGuiText

readwrite

Text of the "Close GUI" button in confirmation dialog on exit.

◆ exitDialogShowCloseGui

bool exitDialogShowCloseGui

readwrite

Flag to show "close GUI" button in confirmation dialog on exit.

◆ exitDialogShowShutdown

bool exitDialogShowShutdown

readwrite

Flag to show "shutdown" button in confirmation dialog on exit.

◆ exitDialogShutdownText

QString exitDialogShutdownText

readwrite

Text of the "shutdown" button in confirmation dialog on exit.

◆ materialAccent

QString materialAccent

readwrite

Material accent color (Pre-defined color name or hex value)

◆ materialPrimary

QString materialPrimary

readwrite

Material primary color (Pre-defined color name or hex value)

◆ materialTheme

QString materialTheme

readwrite

Material theme (Light / Dark)

◆ pluginCount

int pluginCount

readwrite

Number of plugins currently instantiated inside the window.

◆ pluginToolBarColorDark

QString pluginToolBarColorDark

readwrite

Plugin toolbar color for dark theme (Pre-defined color name or hex value). Defaults to material accent.

◆ pluginToolBarColorLight

QString pluginToolBarColorLight

readwrite

Plugin toolbar color for light theme (Pre-defined color name or hex value). Defaults to material accent.

◆ pluginToolBarTextColorDark

QString pluginToolBarTextColorDark

readwrite

Plugin toolbar text color for dark theme (Pre-defined color name or hex value). Defaults to material foreground.

◆ pluginToolBarTextColorLight

QString pluginToolBarTextColorLight

readwrite

Plugin toolbar text color for light theme (Pre-defined color name or hex value). Defaults to material foreground.

◆ showDefaultDrawerOpts

bool showDefaultDrawerOpts

readwrite

Flag to show side drawer's default options.

◆ showDialogOnExit

bool showDialogOnExit

readwrite

Flag to enable confirmation dialog on exit.

◆ showDrawer

bool showDrawer

readwrite

Flag to show side drawer.

◆ showPluginMenu

bool showPluginMenu

readwrite

Flag to show plugins menu.

◆ toolBarColorDark

QString toolBarColorDark

readwrite

Top toolbar color for dark theme (Pre-defined color name or hex value). Defaults to material primary.

◆ toolBarColorLight

QString toolBarColorLight

readwrite

Top toolbar color for light theme (Pre-defined color name or hex value). Defaults to material primary.

◆ toolBarTextColorDark

QString toolBarTextColorDark

readwrite

Top toolbar text color for dark theme (Pre-defined color name or hex value). Defaults to material background.

◆ toolBarTextColorLight

QString toolBarTextColorLight

readwrite

Top toolbar text color for light theme (Pre-defined color name or hex value). Defaults to material background.

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

MainWindow.hh

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MainWindow()

◆ ~MainWindow()

Member Function Documentation

◆ ApplyConfig()

◆ configChanged

◆ CurrentWindowConfig()

◆ DefaultExitAction()

◆ DefaultExitActionChanged

◆ DialogOnExitText()

◆ DialogOnExitTextChanged

◆ ExitDialogCloseGuiText()

◆ ExitDialogCloseGuiTextChanged

◆ ExitDialogShowCloseGui()

◆ ExitDialogShowCloseGuiChanged

◆ ExitDialogShowShutdown()

◆ ExitDialogShowShutdownChanged

◆ ExitDialogShutdownText()

◆ ExitDialogShutdownTextChanged

◆ MaterialAccent()

◆ MaterialAccentChanged

◆ MaterialPrimary()

◆ MaterialPrimaryChanged

◆ MaterialTheme()

◆ MaterialThemeChanged

◆ notify

◆ notifyWithDuration

◆ OnAddPlugin

◆ OnLoadConfig

◆ OnSaveConfig

◆ OnSaveConfigAs

◆ OnStopServer

◆ PluginCount()

◆ PluginCountChanged

◆ PluginListModel()

◆ PluginToolBarColorDark()

◆ PluginToolBarColorDarkChanged

◆ PluginToolBarColorLight()

◆ PluginToolBarColorLightChanged

◆ PluginToolBarTextColorDark()

◆ PluginToolBarTextColorDarkChanged

◆ PluginToolBarTextColorLight()

◆ PluginToolBarTextColorLightChanged

◆ QuickWindow()

◆ SaveConfig()

◆ ServerControlService()

◆ SetDefaultExitAction()

◆ SetDialogOnExitText()

◆ SetExitDialogCloseGuiText()

◆ SetExitDialogShowCloseGui()

◆ SetExitDialogShowShutdown()

◆ SetExitDialogShutdownText()

◆ SetMaterialAccent()

◆ SetMaterialPrimary()

◆ SetMaterialTheme()

◆ SetPluginCount()

◆ SetPluginToolBarColorDark()

◆ SetPluginToolBarColorLight()

◆ SetPluginToolBarTextColorDark()

◆ SetPluginToolBarTextColorLight()

◆ SetRenderEngine()

◆ SetServerControlService()

◆ SetShowDefaultDrawerOpts()

◆ SetShowDialogOnExit()

◆ SetShowDrawer()

◆ SetShowPluginMenu()

◆ SetToolBarColorDark()

◆ SetToolBarColorLight()

◆ SetToolBarTextColorDark()

◆ SetToolBarTextColorLight()

◆ ShowDefaultDrawerOpts()

◆ ShowDefaultDrawerOptsChanged

◆ ShowDialogOnExit()

◆ ShowDialogOnExitChanged