Workspace 6.21.5
Public Member Functions | List of all members
RenderingSettingsPluginConfig Class Reference

Provides a configuration widget for the rendering plugin.

#include <Rendering/renderingsettingspluginconfig.h>

Inheritance diagram for RenderingSettingsPluginConfig:
[legend]

Public Member Functions

 RenderingSettingsPluginConfig (RenderingSettings &settings)
 
 ~RenderingSettingsPluginConfig () override
 
void applyConfig () override
 
void destroy () override
 
QWidget & getQWidget () override
 
bool isTopLevelConfig () const override
 
void resetConfig () override
 
virtual void applyConfig ()=0
 
virtual void destroy ()=0
 
virtual QWidget & getQWidget ()=0
 
virtual bool isTopLevelConfig () const
 
virtual void resetConfig ()=0
 

Additional Inherited Members

- Signals inherited from PluginConfig
void modified ()
 
- Protected Member Functions inherited from PluginConfig
 ~PluginConfig () override=default
 

Constructor & Destructor Documentation

◆ RenderingSettingsPluginConfig()

Creats a configuration widget with just a simple, read-only text label indicating that the plugin has no configurable parameters.

◆ ~RenderingSettingsPluginConfig()

~RenderingSettingsPluginConfig ( )
overridedefault

Deletes the configuration widget.

Member Function Documentation

◆ applyConfig()

void applyConfig ( )
overridevirtual

Subclasses must implement this function to take whatever action is necessary to apply any changes made to them. This will normally be to update the plugin's relevant settings obtained from Settings::getPluginSettings(), but subclasses would not normally call Settings::save(). Rather, it is assumed that whatever created this PluginConfig object will do so at the relevant time (usually after calling applyConfig() on all loaded plugins).

Implements PluginConfig.

◆ destroy()

void destroy ( )
overridevirtual

Subclasses will almost always implement this function simply as a call to the delete operator, or to some kind of factory singleton which does this. Since PluginConfig subclass objects are usually instantiated by a singleton within the plugin, the destroy() function is necessary to ensure that the plugin also deletes instances.

Implements PluginConfig.

◆ getQWidget()

QWidget & getQWidget ( )
overridevirtual
Returns
A QWidget that can be used to configure the plugin. The caller must never delete the returned object, since it is assumed that the PluginConfig object will be able to delete it again safely in its own destructor, invoked as a result of calling destroy().

Implements PluginConfig.

◆ isTopLevelConfig()

bool isTopLevelConfig ( ) const
overridevirtual

Subclasses can implement this function to indicate that this plugin is a top level plugin configuration.

Reimplemented from PluginConfig.

◆ resetConfig()

void resetConfig ( )
overridevirtual

Subclasses must implement this function to take whatever action is necessary to revert any changes made to them. This will normally be to reload the plugin's relevant settings into the widget again, as obtained from Settings::getPluginSettings(). It is the caller's responsibility to ensure that Settings::load() has already been called, so subclasses should not need to call it for themselves.

Implements PluginConfig.