Holds configurations related to a MainWindow. More...
#include <MainWindow.hh>
Public Member Functions | |
| bool | IsIgnoring (const std::string &_prop) const |
| Get whether a property should be ignored. | |
| bool | MergeFromXML (const std::string &_xml) |
| Update this config from an XML string. Only fields present on the XML will be overridden / appended / created. | |
| std::string | XMLString () const |
| Return this configuration in XML format as a string. | |
Public Attributes | |
| int | height {-1} |
| Window height in px. | |
| std::set< std::string > | ignoredProps |
| List of window properties which should be ignored on load. | |
| std::string | materialAccent {""} |
| Material accent color. | |
| std::string | materialPrimary {""} |
| Material primary color. | |
| std::string | materialTheme {""} |
| Material theme (light / dark) | |
| std::string | plugins {""} |
| Concatenation of all plugin configurations. | |
| bool | pluginsFromPaths {true} |
| True if plugins found in plugin paths should be listed under the Plugins menu. True by default. | |
| std::string | pluginToolBarColorDark {""} |
| Plugin toolbar color dark. | |
| std::string | pluginToolBarColorLight {""} |
| Plugin toolbar color light. | |
| std::string | pluginToolBarTextColorDark {""} |
| Plugin toolbar text color dark. | |
| std::string | pluginToolBarTextColorLight {""} |
| Plugin toolbar text color light. | |
| int | posX {-1} |
| Window X position in px. | |
| int | posY {-1} |
| Window Y position in px. | |
| bool | showDefaultDrawerOpts {true} |
| Show the default options of the drawer. | |
| bool | showDrawer {true} |
| Show the side drawer. | |
| bool | showPluginMenu {true} |
| Show the plugins menu. | |
| std::vector< std::string > | showPlugins |
| List of plugins which should be shown on the list. | |
| QByteArray | state |
| Window state (dock configuration) | |
| std::string | toolBarColorDark {""} |
| Top toolbar color dark. | |
| std::string | toolBarColorLight {""} |
| Top toolbar color light. | |
| std::string | toolBarTextColorDark {""} |
| Top toolbar text color dark. | |
| std::string | toolBarTextColorLight {""} |
| Top toolbar text color light. | |
| int | width {-1} |
| Window width in px. | |
Detailed Description
Holds configurations related to a MainWindow.
Member Function Documentation
◆ IsIgnoring()
| bool IsIgnoring | ( | const std::string & | _prop | ) | const |
Get whether a property should be ignored.
- Returns
- True if it's being ignored
◆ MergeFromXML()
| bool MergeFromXML | ( | const std::string & | _xml | ) |
Update this config from an XML string. Only fields present on the XML will be overridden / appended / created.
- Parameters
-
[in] _xml A config XML file in string format
- Returns
- True if successful. It may fail for example if the string can't be parsed into XML.
◆ XMLString()
| std::string XMLString | ( | ) | const |
Return this configuration in XML format as a string.
- Returns
- String containing a complete config file.
Member Data Documentation
◆ height
| int height {-1} |
Window height in px.
◆ ignoredProps
| std::set<std::string> ignoredProps |
List of window properties which should be ignored on load.
◆ materialAccent
| std::string materialAccent {""} |
Material accent color.
◆ materialPrimary
| std::string materialPrimary {""} |
Material primary color.
◆ materialTheme
| std::string materialTheme {""} |
Material theme (light / dark)
◆ plugins
| std::string plugins {""} |
Concatenation of all plugin configurations.
◆ pluginsFromPaths
| bool pluginsFromPaths {true} |
True if plugins found in plugin paths should be listed under the Plugins menu. True by default.
◆ pluginToolBarColorDark
| std::string pluginToolBarColorDark {""} |
Plugin toolbar color dark.
◆ pluginToolBarColorLight
| std::string pluginToolBarColorLight {""} |
Plugin toolbar color light.
◆ pluginToolBarTextColorDark
| std::string pluginToolBarTextColorDark {""} |
Plugin toolbar text color dark.
◆ pluginToolBarTextColorLight
| std::string pluginToolBarTextColorLight {""} |
Plugin toolbar text color light.
◆ posX
| int posX {-1} |
Window X position in px.
◆ posY
| int posY {-1} |
Window Y position in px.
◆ showDefaultDrawerOpts
| bool showDefaultDrawerOpts {true} |
Show the default options of the drawer.
◆ showDrawer
| bool showDrawer {true} |
Show the side drawer.
◆ showPluginMenu
| bool showPluginMenu {true} |
Show the plugins menu.
◆ showPlugins
| std::vector<std::string> showPlugins |
List of plugins which should be shown on the list.
◆ state
| QByteArray state |
Window state (dock configuration)
◆ toolBarColorDark
| std::string toolBarColorDark {""} |
Top toolbar color dark.
◆ toolBarColorLight
| std::string toolBarColorLight {""} |
Top toolbar color light.
◆ toolBarTextColorDark
| std::string toolBarTextColorDark {""} |
Top toolbar text color dark.
◆ toolBarTextColorLight
| std::string toolBarTextColorLight {""} |
Top toolbar text color light.
◆ width
| int width {-1} |
Window width in px.
The documentation for this struct was generated from the following file: