 |
ImFusion SDK 4.3
|
|
ImFusion SDK 4.3
|
#include <ImFusion/GUI/ControllerDecorator.h>
Base interface for wrapper classes to decorate Controller instances and place them inside a MainWindowBase. More...
Inheritance diagram for ControllerDecorator:Base interface for wrapper classes to decorate Controller instances and place them inside a MainWindowBase.
This interface defines a set of generic functionality that must be implemented by container widgets. Subclasses can extend it with extra logic for decoration, docking, or other functionality needed for their intended GUI.
Instances of this interface are usually not created manually by SDK users but rather instantiated and maintained by MainWindowBase after calling MainWindowBase::addController().
Public Member Functions | |
| virtual bool | setLocation (Controller::Location location)=0 |
| Sets how the controller should be decorated and where it should be placed in the parent MainWindowBase. | |
| virtual Controller::Location | location () const =0 |
| Returns the current location of the controller, i.e. where it is placed in the parent MainWindowBase. | |
| virtual void | setVisible (bool value)=0 |
| Sets whether the controller should be visible or hidden from the GUI. | |
| virtual bool | isVisible () const =0 |
| Returns whether the controller widget is currently visible. | |
| virtual void | setUserClosable (bool closable)=0 |
| Sets whether the container widget should show a button to close the underlying Controller. | |
| virtual bool | isUserClosable () const =0 |
| Returns whether the container widget should show a button to close the underlying Controller. | |
| Public Member Functions inherited from SignalReceiver | |
| SignalReceiver ()=default | |
| Default constructor. | |
| SignalReceiver (const SignalReceiver &other) | |
| Copy constructor, does not copy any existing signal connections from other. | |
| SignalReceiver & | operator= (SignalReceiver rhs) |
| Assignment operator, disconnects all existing connections, does not copy any existing signal connections from rhs. | |
| virtual | ~SignalReceiver () |
| Virtual destructor disconnects from all connected signals. | |
| Public Member Functions inherited from Configurable | |
| virtual void | configure (const Properties *p) |
| Configure this object instance by de-serializing the given Properties. | |
| virtual void | configuration (Properties *p) const |
| Serialize the current object configuration into the given Properties object. | |
| virtual void | configureDefaults () |
| Retrieve the properties of this object, replaces values with their defaults and sets it again. | |
| void | registerParameter (ParameterBase *param) |
| Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration(). | |
| void | unregisterParameter (const ParameterBase *param) |
| Remove the given Parameter or SubProperty from the list of registered parameters. | |
| Configurable (const Configurable &rhs) | |
| Configurable (Configurable &&rhs) noexcept | |
| Configurable & | operator= (const Configurable &) |
| Configurable & | operator= (Configurable &&) noexcept |
Additional Inherited Members | |
| Public Attributes inherited from Configurable | |
| Signal | signalParametersChanged |
Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted. | |
| Protected Member Functions inherited from SignalReceiver | |
| void | disconnectAll () |
| Disconnects all existing connections. | |
| Protected Attributes inherited from Configurable | |
| std::vector< Param > | m_params |
| List of all registered Parameter and SubProperty instances. | |
|
pure virtual |
Sets how the controller should be decorated and where it should be placed in the parent MainWindowBase.
Returns false if requested location could not be set (e.g. because not in Controller::supportedLocations()).
Implemented in DefaultControllerDecorator.
|
pure virtual |
Returns the current location of the controller, i.e. where it is placed in the parent MainWindowBase.
Implemented in DefaultControllerDecorator.
|
pure virtual |
Sets whether the controller should be visible or hidden from the GUI.
Implemented in DefaultControllerDecorator.
|
pure virtual |
Returns whether the controller widget is currently visible.
Implemented in DefaultControllerDecorator.
|
pure virtual |
Sets whether the container widget should show a button to close the underlying Controller.
Implemented in DefaultControllerDecorator.
|
pure virtual |
Returns whether the container widget should show a button to close the underlying Controller.
Implemented in DefaultControllerDecorator.
