ManiVault 1.0.0
A Flexible and Extensible Visual Analytics Framework for High-Dimensional Data
Loading...
Searching...
No Matches
hdps::gui::ColorAction Class Reference

#include <ColorAction.h>

Inheritance diagram for hdps::gui::ColorAction:
hdps::gui::WidgetAction hdps::util::Serializable

Classes

class  PushButtonWidget
 

Public Types

enum  WidgetFlag { Picker = 0x00001 , ResetPushButton = 0x00002 , Basic = Picker , All = Picker | ResetPushButton }
 
- Public Types inherited from hdps::gui::WidgetAction
enum class  Scope { Private , Public }
 
enum class  HighlightOption { None , Moderate , Strong }
 
enum class  ConfigurationFlag {
  VisibleInMenu = 0x00001 , InternalUseOnly = 0x00002 , NoLabelInGroup = 0x00004 , ForceCollapsedInGroup = 0x00008 ,
  ForceExpandedInGroup = 0x00010 , User = 0x00100 , Default = 0
}
 
enum  ConnectionContextFlag { Api = 0x00008 , Gui = 0x00010 , ApiAndGui = Api | Gui }
 ‍** Describes the connection context options *‍/ More...
 
enum class  ConnectionPermissionFlag {
  None = 0x00000 , PublishViaApi = 0x00001 , PublishViaGui = 0x00002 , PublishViaApiAndGui = PublishViaApi | PublishViaGui ,
  ConnectViaApi = 0x00008 , ConnectViaGui = 0x00010 , ConnectViaApiAndGui = ConnectViaApi | ConnectViaGui , DisconnectViaApi = 0x00040 ,
  DisconnectViaGui = 0x00080 , DisconnectViaApiAndGui = DisconnectViaApi | DisconnectViaGui , ForceNone = 0x00100 , All = PublishViaApiAndGui | ConnectViaApiAndGui | DisconnectViaApiAndGui ,
  Default = All
}
 
- Public Types inherited from hdps::util::Serializable
enum class  State { Idle , Reading , Writing }
 

Signals

void colorChanged (const QColor &color)
 
- Signals inherited from hdps::gui::WidgetAction
void idChanged (const QString &id)
 
void sortIndexChanged (std::int32_t sortIndex)
 
void stretchChanged (std::int32_t stretch)
 
void forceHiddenChanged (bool forceHidden)
 
void forceDisabledChanged (bool forceDisabled)
 
void highlightingChanged (const HighlightOption &highlightOption)
 
void isPublishedChanged (const bool &isPublished)
 
void isConnectedChanged (const bool &isConnected)
 
void actionConnected (WidgetAction *action)
 
void actionDisconnected (WidgetAction *action)
 
void connectionPermissionsChanged (std::int32_t connectionPermissions)
 
void configurationFlagToggled (const ConfigurationFlag &configurationFlag, bool set)
 
void configurationChanged (std::int32_t configuration)
 
void scopeChanged (const Scope &scope)
 
void textChanged (const QString &text)
 
void locationChanged (const QString &location)
 

Public Member Functions

Q_INVOKABLE ColorAction (QObject *parent, const QString &title, const QColor &color=DEFAULT_COLOR)
 
QColor getColor () const
 
void setColor (const QColor &color)
 
void fromVariantMap (const QVariantMap &variantMap) override
 
QVariantMap toVariantMap () const override
 
- Public Member Functions inherited from hdps::gui::WidgetAction
 WidgetAction (QObject *parent, const QString &title)
 
 ~WidgetAction ()
 
virtual WidgetActiongetParentAction () const final
 
virtual WidgetActions getParentActions () const final
 
virtual WidgetActions getChildren () const final
 
virtual bool isRoot () const final
 
virtual bool isLeaf () const final
 
virtual QWidget * createWidget (QWidget *parent) override final
 
virtual QWidget * createCollapsedWidget (QWidget *parent) const final
 
virtual QWidget * createLabelWidget (QWidget *parent, const std::int32_t &widgetFlags=0x00001) const final
 
virtual QMenu * getContextMenu (QWidget *parent=nullptr)
 
QWidget * createWidget (QWidget *parent, const std::int32_t &widgetFlags)
 
virtual std::int32_t getSortIndex () const final
 
virtual void setSortIndex (const std::int32_t &sortIndex) final
 
virtual std::int32_t getStretch () const final
 
virtual void setStretch (const std::int32_t &stretch) final
 
virtual bool getForceHidden () const final
 
virtual void setForceHidden (bool forceHidden) final
 
virtual bool isVisible () const final
 
virtual bool getForceDisabled () const final
 
virtual void setForceDisabled (bool forceDisabled) final
 
virtual bool isEnabled () const final
 
void setText (const QString &text)
 
virtual QString getLocation () const
 
virtual std::int32_t getDefaultWidgetFlags () const final
 
virtual void setDefaultWidgetFlags (const std::int32_t &widgetFlags) final
 
virtual void setDefaultWidgetFlag (const std::int32_t &widgetFlags, bool unset=false) final
 
virtual HighlightOption getHighlighting () const final
 
virtual bool isHighlighted () const final
 
virtual void setHighlighting (const HighlightOption &highlighting) final
 
virtual void setHighlighted (bool highlighted) final
 
virtual void highlight () final
 
virtual void unHighlight () final
 
virtual Scope getScope () const final
 
virtual bool isPrivate () const final
 
virtual bool isPublic () const final
 
virtual bool isPublished () const final
 
virtual bool isConnected () const final
 
virtual bool mayConnectToPublicAction (const WidgetAction *publicAction) const final
 
virtual bool publish (const QString &name="", bool allowDuplicateName=false) final
 
virtual WidgetActiongetPublicAction () final
 
virtual WidgetActiongetPublicCopy () const final
 
virtual const WidgetActions getConnectedActions () const final
 
virtual WidgetActionsgetConnectedActions () final
 
virtual bool mayPublish (ConnectionContextFlag connectionContextFlags) const final
 
virtual bool mayConnect (ConnectionContextFlag connectionContextFlags) const final
 
virtual bool mayDisconnect (ConnectionContextFlag connectionContextFlags) const final
 
virtual std::int32_t getConnectionPermissions () const final
 
virtual bool isConnectionPermissionFlagSet (ConnectionPermissionFlag connectionPermissionsFlag) final
 
virtual void setConnectionPermissionsFlag (ConnectionPermissionFlag connectionPermissionsFlag, bool unset=false, bool recursive=false) final
 
virtual void setConnectionPermissions (std::int32_t connectionPermissions, bool recursive=false) final
 
virtual void setConnectionPermissionsToNone (bool recursive=false) final
 
virtual void setConnectionPermissionsToForceNone (bool recursive=false) final
 
virtual void setConnectionPermissionsToAll (bool recursive=false) final
 
virtual void cacheConnectionPermissions (bool recursive=false) final
 
virtual void restoreConnectionPermissions (bool recursive=false) final
 
virtual void startDrag () final
 
virtual bool isResettable () const final
 
virtual void reset () final
 
virtual void setSettingsPrefix (const QString &settingsPrefix, const bool &load=true) final
 
virtual void setSettingsPrefix (plugin::Plugin *plugin, const QString &settingsPrefix, const bool &load=true) final
 
virtual QString getSettingsPrefix () const
 
virtual void loadFromSettings () final
 
virtual void saveToSettings () final
 
virtual QVector< WidgetAction * > findChildren (const QString &searchString, bool recursive=true) const final
 
virtual QSize getPopupSizeHint () const final
 
virtual void setPopupSizeHint (const QSize &popupSizeHint) final
 
virtual std::int32_t getConfiguration () const final
 
virtual bool isConfigurationFlagSet (ConfigurationFlag configurationFlag) const final
 
virtual void setConfigurationFlag (ConfigurationFlag configurationFlag, bool unset=false, bool recursive=false) final
 
virtual void setConfiguration (std::int32_t configuration, bool recursive=false) final
 
virtual QString getTypeString (bool humanFriendly=false) const final
 
void fromVariantMap (const QVariantMap &variantMap) override
 
QVariantMap toVariantMap () const override
 
virtual void cacheState (const QString &name="cache") final
 
virtual void restoreState (const QString &name="cache", bool remove=true) final
 
virtual void setStudioMode (bool studioMode, bool recursive=true) final
 
- Public Member Functions inherited from hdps::util::Serializable
 Serializable (const QString &serializationName="")
 
virtual QString getId () const final
 
virtual void setId (const QString &id) final
 
virtual QString getSerializationName () const final
 
virtual void setSerializationName (const QString &serializationName) final
 
virtual void fromParentVariantMap (const QVariantMap &parentVariantMap)
 
virtual void insertIntoVariantMap (QVariantMap &variantMap) const final
 
virtual void fromJsonDocument (const QJsonDocument &jsonDocument) final
 
virtual QJsonDocument toJsonDocument () const final
 
virtual void fromJsonFile (const QString &filePath="") final
 
virtual void toJsonFile (const QString &filePath="") final
 
virtual void makeUnique () final
 

Protected Member Functions

QWidget * getWidget (QWidget *parent, const std::int32_t &widgetFlags) override
 
void connectToPublicAction (WidgetAction *publicAction, bool recursive) override
 
void disconnectFromPublicAction (bool recursive) override
 
- Protected Member Functions inherited from hdps::gui::WidgetAction
virtual void makePublic (bool recursive=true) final
 
virtual void connectToPublicActionByName (const QString &publicActionName) final
 

Protected Attributes

QColor _color
 

Static Protected Attributes

static const QColor DEFAULT_COLOR = Qt::gray
 

Friends

class AbstractActionsManager
 

Additional Inherited Members

- Static Public Member Functions inherited from hdps::util::Serializable
static QString createId ()
 
- Static Public Attributes inherited from hdps::gui::WidgetAction
static QMap< Scope, QString > scopeNames
 
- Static Protected Member Functions inherited from hdps::util::Serializable
static void fromVariantMap (Serializable *serializable, const QVariantMap &variantMap)
 
static void fromVariantMap (Serializable &serializable, const QVariantMap &variantMap, const QString &key)
 
static QVariantMap toVariantMap (const Serializable *serializable)
 
static void insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap, const QString &key)
 
static void insertIntoVariantMap (const Serializable &serializable, QVariantMap &variantMap)
 

Detailed Description

Color widget action class

Stores a color and creates widgets to interact with it

Author
Thomas Kroes

Member Enumeration Documentation

◆ WidgetFlag

Describes the widget flags

Enumerator
Picker 
ResetPushButton 

The widget includes a color picker

Basic 

The widget includes a reset push button

All 

Constructor & Destructor Documentation

◆ ColorAction()

hdps::gui::ColorAction::ColorAction ( QObject *  parent,
const QString &  title,
const QColor &  color = DEFAULT_COLOR 
)

Constructor

Parameters
parentPointer to parent object
titleTitle of the action
colorInitial color

Member Function Documentation

◆ colorChanged

void hdps::gui::ColorAction::colorChanged ( const QColor &  color)
signal

Signals that the current color changed

Parameters
colorCurrent color that changed

◆ connectToPublicAction()

void hdps::gui::ColorAction::connectToPublicAction ( WidgetAction publicAction,
bool  recursive 
)
overrideprotectedvirtual

Connect this action to a public action

Parameters
publicActionPointer to public action to connect to
recursiveWhether to also connect descendant child actions

Reimplemented from hdps::gui::WidgetAction.

◆ disconnectFromPublicAction()

void hdps::gui::ColorAction::disconnectFromPublicAction ( bool  recursive)
overrideprotectedvirtual

Disconnect this action from its public action

Parameters
recursiveWhether to also disconnect descendant child actions

Reimplemented from hdps::gui::WidgetAction.

◆ fromVariantMap()

void hdps::gui::ColorAction::fromVariantMap ( const QVariantMap &  variantMap)
overridevirtual

Load widget action from variant map

Parameters
Variantmap representation of the widget action

Reimplemented from hdps::util::Serializable.

◆ getColor()

QColor hdps::gui::ColorAction::getColor ( ) const

Gets the current color

◆ getWidget()

QWidget * hdps::gui::ColorAction::getWidget ( QWidget *  parent,
const std::int32_t &  widgetFlags 
)
overrideprotectedvirtual

Get widget representation of the color action

Parameters
parentPointer to parent widget
widgetFlagsWidget flags for the configuration of the widget (type)

Reimplemented from hdps::gui::WidgetAction.

◆ setColor()

void hdps::gui::ColorAction::setColor ( const QColor &  color)

Sets the current color

Parameters
colorCurrent color

◆ toVariantMap()

QVariantMap hdps::gui::ColorAction::toVariantMap ( ) const
overridevirtual

Save widget action to variant map

Returns
Variant map representation of the widget action

Reimplemented from hdps::util::Serializable.

Friends And Related Symbol Documentation

◆ AbstractActionsManager

friend class AbstractActionsManager
friend

Member Data Documentation

◆ _color

QColor hdps::gui::ColorAction::_color
protected

◆ DEFAULT_COLOR

const QColor hdps::gui::ColorAction::DEFAULT_COLOR = Qt::gray
staticprotected

Current color Default default color


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