Class SBGWidgetNodeIndexerSelector#

ClassList > SBGWidgetNodeIndexerSelector

The SBGWidgetNodeIndexerSelector class is a convenience widget for specifying a selection of nodes - it contains a label and push buttons to set the selection of nodes, to select them in the document, and clear the selection.More...

#include <SBGWidgetNodeIndexerSelector.hpp>

Inherits the following classes: QWidget

Public Slots#

Type	Name
slot void	onClear Slot invoked when the Clear button is clicked. Clears the selector's stored selection and disables related UI controls.
slot void	onSelect Slot invoked when the Select button is clicked. Selects the nodes stored in the selector within the active document.
slot void	onSet Slot invoked when the Set button is clicked. Updates the selector's internal selection based on the currently selected nodes in the active document.

Public Signals#

Type	Name
signal void	selectionChanged

Public Functions#

Type	Name
	SBGWidgetNodeIndexerSelector (QWidget * parent=nullptr) Constructs a selector widget.
QString	getLabel () const Returns the label shown in the selector.
SBPointerIndexer< SBNode > &	getSelection () Returns the selection.
const SBPointerIndexer< SBNode > &	getSelection () const Returns the selection.
bool	isEmpty () const Returns whether the selection contains at least one created node.
void	setLabel (const QString & label) Sets the label shown in the selector.
virtual	~SBGWidgetNodeIndexerSelector () Destructs the selector widget.

Detailed Description#

Short name: SBNodeIndexerSelector

Public Slots Documentation#

slot onClear#

Slot invoked when the Clear button is clicked. Clears the selector's stored selection and disables related UI controls.

void SBGWidgetNodeIndexerSelector::onClear;

slot onSelect#

Slot invoked when the Select button is clicked. Selects the nodes stored in the selector within the active document.

void SBGWidgetNodeIndexerSelector::onSelect;

slot onSet#

Slot invoked when the Set button is clicked. Updates the selector's internal selection based on the currently selected nodes in the active document.

void SBGWidgetNodeIndexerSelector::onSet;

Public Signals Documentation#

signal selectionChanged#

void SBGWidgetNodeIndexerSelector::selectionChanged;

Public Functions Documentation#

function SBGWidgetNodeIndexerSelector#

Constructs a selector widget.

SBGWidgetNodeIndexerSelector::SBGWidgetNodeIndexerSelector (
    QWidget * parent=nullptr
)

Parameters:

parent The parent widget, or nullptr if there is no parent.

function getLabel#

Returns the label shown in the selector.

QString SBGWidgetNodeIndexerSelector::getLabel () const

Returns:

The current label text.

function getSelection [1/2]#

Returns the selection.

SBPointerIndexer< SBNode > & SBGWidgetNodeIndexerSelector::getSelection ()

Returns the selection container.

Returns:

Reference to the node pointer indexer holding the selected nodes.

function getSelection [2/2]#

Returns the selection.

const SBPointerIndexer< SBNode > & SBGWidgetNodeIndexerSelector::getSelection () const

Returns the selection container (const overload).

Returns:

Const reference to the node pointer indexer holding the selected nodes.

function isEmpty#

Returns whether the selection contains at least one created node.

bool SBGWidgetNodeIndexerSelector::isEmpty () const

Returns:

true if the selection is empty, false otherwise.

function setLabel#

Sets the label shown in the selector.

void SBGWidgetNodeIndexerSelector::setLabel (
    const QString & label
)

Parameters:

label The new label text.

function ~SBGWidgetNodeIndexerSelector#

Destructs the selector widget.

virtual SBGWidgetNodeIndexerSelector::~SBGWidgetNodeIndexerSelector ()