Class SBGActionWidget

ClassList > SBGActionWidget

This class implements an action widget. More...

• #include <SBGActionWidget.hpp>

Inherits the following classes: QWidgetAction

Public Functions

Type	Name
	SBGActionWidget (QObject * parent) Builds an action widget.
virtual QWidget *	createWidget (QWidget * parent) Creates a new widget with the parent parent .
virtual QString	getDescriptionImagePath () const Returns a path to an image which will be placed into the action's description. If not specified, the action's icon might be used instead.
virtual QString	getName () const Returns the action's class name.
virtual SBUUID	getUUID () const Returns the action's UUID.
virtual bool	isDiscoverable () const Returns true if can be discovered by the user.
virtual	~SBGActionWidget () Destructor.

Detailed Description

Short name: SBActionWidget

Public Functions Documentation

function SBGActionWidget

Builds an action widget.

SBGActionWidget::SBGActionWidget (
    QObject * parent
) 

Constructs an SBGActionWidget with the specified parent.

Parameters:

• parent The parent QObject that owns this widget action.

---

function createWidget

Creates a new widget with the parent parent .

virtual QWidget * SBGActionWidget::createWidget (
    QWidget * parent
) 

Creates a widget associated with this action.

Parameters:

• parent The parent widget for the created widget.

Returns:

A pointer to the newly created widget.

---

function getDescriptionImagePath

Returns a path to an image which will be placed into the action's description. If not specified, the action's icon might be used instead.

virtual QString SBGActionWidget::getDescriptionImagePath () const

Returns the path to an image used in the action's description.

Returns:

A string containing the image path, or an empty string if none is specified.

---

function getName

Returns the action's class name.

virtual QString SBGActionWidget::getName () const

Returns the class name of the action widget.

Returns:

The name of the action.

---

function getUUID

Returns the action's UUID.

virtual SBUUID SBGActionWidget::getUUID () const

Returns the UUID of the action widget.

Returns:

The UUID of the action.

---

function isDiscoverable

Returns true if can be discovered by the user.

virtual bool SBGActionWidget::isDiscoverable () const

Indicates whether the action widget can be discovered by the user.

Returns:

true if the action widget is discoverable; otherwise false.

---

function ~SBGActionWidget

Destructor.

virtual SBGActionWidget::~SBGActionWidget () 

Destroys the SBGActionWidget.

---