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. More... | |
| bool | MergeFromXML (const std::string &_xml) |
| Update this config from an XML string. Only fields present on the XML will be overriden / appended / created. More... | |
| std::string | XMLString () const |
| Return this configuration in XML format as a string. More... | |
Public Attributes | |
| int | height {-1} |
| Window height in px. More... | |
| std::set< std::string > | ignoredProps |
| List of window properties which should be ignored on load. More... | |
| std::string | materialAccent {""} |
| Material accent color. More... | |
| std::string | materialPrimary {""} |
| Material primary color. More... | |
| std::string | materialTheme {""} |
| Material theme (light / dark) More... | |
| std::string | plugins {""} |
| Concatenation of all plugin configurations. More... | |
| bool | pluginsFromPaths {true} |
| True if plugins found in plugin paths should be listed under the Plugins menu. True by default. More... | |
| int | posX {-1} |
| Window X position in px. More... | |
| int | posY {-1} |
| Window Y position in px. More... | |
| bool | showDefaultDrawerOpts {true} |
| bool | showDrawer {true} |
| bool | showPluginMenu {true} |
| std::vector< std::string > | showPlugins |
| List of plugins which should be shown on the list. More... | |
| QByteArray | state |
| Window state (dock configuration) More... | |
| int | width {-1} |
| Window width in px. More... | |
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 overriden / 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.
◆ posX
| int posX {-1} |
Window X position in px.
◆ posY
| int posY {-1} |
Window Y position in px.
◆ showDefaultDrawerOpts
| bool showDefaultDrawerOpts {true} |
◆ showDrawer
| bool showDrawer {true} |
◆ showPluginMenu
| bool showPluginMenu {true} |
◆ showPlugins
| std::vector<std::string> showPlugins |
List of plugins which should be shown on the list.
◆ state
| QByteArray state |
Window state (dock configuration)
◆ width
| int width {-1} |
Window width in px.
The documentation for this struct was generated from the following file: