pqProxyAction Class Reference

: a wrapper around a QAction used for proxy creation. More...

#include <pqProxyAction.h>

Inherits QObject.

Public Member Functions
	pqProxyAction (QObject *parent, QAction *action)
	~pqProxyAction () override
QAction *	GetAction ()
	Returns the underlying QAction. More...
bool	IsEnabled ()
	Returns true if the action is enabled. More...
QString	GetDisplayName ()
	Returns the display name, i.e. More...
QIcon	GetIcon ()
	Returns the icon for this action. More...
QString	GetRequirement ()
	Returns the first unmet requirement (if any). More...
QString	GetProxyName ()
	Returns the SMProxy Name. More...
QString	GetProxyGroup ()
	Returns the SMProxy Group. More...
QString	GetDocumentation ()
	Returns the short documentation for the SMProxy. More...

Static Public Member Functions
static QString	GetProxyDocumentation (QAction *)
	Returns the proxy documentation for the given action, if any. More...
static vtkSMProxy *	GetProxyPrototype (QAction *)
	Returns the proxy prototype for the given action, if any. More...
static QString	GetProxyName (QAction *)
	Returns the proxy name for the given action, if any. More...
static QString	GetProxyGroup (QAction *)
	Returns the proxy group for the given action, if any. More...
static void	updateActionsState (QList< QAction *> actions)
	Update the state of the given actions. More...

Detailed Description

: a wrapper around a QAction used for proxy creation.

: pqProxyAction can retrieve SMProxy information from the QAction UserData, and also update the QAction status tip depending on the active output ports.

An action for a proxy is expected to store {proxyGroup, proxyName} under QAction::data()

Definition at line 26 of file pqProxyAction.h.

Constructor & Destructor Documentation

pqProxyAction()

pqProxyAction::pqProxyAction	(	QObject *	parent,
		QAction *	action
	)

~pqProxyAction()

pqProxyAction::~pqProxyAction ( )

override

Member Function Documentation

GetAction()

QAction* pqProxyAction::GetAction

(

)

Returns the underlying QAction.

IsEnabled()

bool pqProxyAction::IsEnabled

(

)

Returns true if the action is enabled.

GetDisplayName()

QString pqProxyAction::GetDisplayName

(

)

Returns the display name, i.e.

the text of the QAction.

GetIcon()

QIcon pqProxyAction::GetIcon

(

)

Returns the icon for this action.

GetRequirement()

QString pqProxyAction::GetRequirement

(

)

Returns the first unmet requirement (if any).

Also update the QAction status.

GetProxyName() [1/2]

QString pqProxyAction::GetProxyName

(

)

Returns the SMProxy Name.

GetProxyGroup() [1/2]

QString pqProxyAction::GetProxyGroup

(

)

Returns the SMProxy Group.

GetDocumentation()

QString pqProxyAction::GetDocumentation

(

)

Returns the short documentation for the SMProxy.

GetProxyDocumentation()

static QString pqProxyAction::GetProxyDocumentation ( QAction *  )

static

Returns the proxy documentation for the given action, if any.

GetProxyPrototype()

static vtkSMProxy* pqProxyAction::GetProxyPrototype ( QAction *  )

static

Returns the proxy prototype for the given action, if any.

GetProxyName() [2/2]

static QString pqProxyAction::GetProxyName ( QAction *  )

static

Returns the proxy name for the given action, if any.

GetProxyGroup() [2/2]

static QString pqProxyAction::GetProxyGroup ( QAction *  )

static

Returns the proxy group for the given action, if any.

updateActionsState()

static void pqProxyAction::updateActionsState ( QList< QAction *>  actions )

static

Update the state of the given actions.

This includes: enabled state and status tip (with unmet requirement).

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/Components/pqProxyAction.h