Description

A widget allowing node classes to be dragged out of it (and onto, e.g., a composition editor canvas).

Definition at line 20 of file VuoNodeClassList.hh.

Signals
void	componentsAdded (QList< QGraphicsItem * > addedComponents, VuoEditorComposition *target)
	Emitted when the user has used the Node Library to add nodes to the composition. More...

void	nodePopoverRequestedForClass (VuoNodeClass *nodeClass)
	Emitted when documentation for the specified node class has been requested. More...

void	nodeClassListHeightChanged (int newHeight)
	Emitted when the node class list's height changes. More...

Public Member Functions
	VuoNodeClassList (QWidget *parent=0)
	Creates a node class list widget. More...

void	setFilterText (QString filterText)
	Sets the filter text used to search for node classes within the library. More...

void	enablePopovers ()
	Enables display of popovers in response to user interaction. More...

void	enablePopoversAndDisplayCurrent ()
	Enables display of popovers in response to user interaction and displays the popover for the current item. More...

VuoCompilerNodeClass *	getNodeClassForItem (QListWidgetItem *item)
	Returns the node class for the provided `item`, or NULL if none. More...

void	disablePopovers ()
	Disables display of popovers in response to user interaction. More...

Static Public Member Functions
static void	populateContextMenuForNodeClass (QMenu contextMenu, VuoCompilerNodeClass nodeClass)
	Populates the provided context menu with options corresponding to the provided node class. More...

Public Attributes
bool	selectionFinalized
	True when list filtering has completed. More...

Protected Slots
void	addDoubleClickedNode (QListWidgetItem *nodeClass)
	Instantiates and adds a node of class `nodeClass` to the associated composition editor. More...

void	displayPopoverForItem (QListWidgetItem *targetNodeClassItem)
	Displays the popover for the `targetNodeClass` item. More...

Protected Member Functions
void	keyPressEvent (QKeyEvent *event)
	If a user selects a node class and presses 'Return', trigger node instantiation. More...

void	mousePressEvent (QMouseEvent *event)
	Handle mouse press events. More...

void	mouseReleaseEvent (QMouseEvent *event)
	Handle mouse release events. More...

void	wheelEvent (QWheelEvent *event)
	Handle mouse wheel events. More...

void	contextMenuEvent (QContextMenuEvent *event)
	Handle context menu events. More...

Constructor & Destructor Documentation

◆ VuoNodeClassList()

VuoNodeClassList::VuoNodeClassList ( QWidget * parent = 0 )

explicit

Creates a node class list widget.

Definition at line 24 of file VuoNodeClassList.cc.

Member Function Documentation

◆ addDoubleClickedNode

void VuoNodeClassList::addDoubleClickedNode ( QListWidgetItem * nodeClass )

protectedslot

Instantiates and adds a node of class nodeClass to the associated composition editor.

Definition at line 218 of file VuoNodeClassList.cc.

◆ componentsAdded

void VuoNodeClassList::componentsAdded	(	QList< QGraphicsItem * >	addedComponents,
		VuoEditorComposition *	target
	)

signal

Emitted when the user has used the Node Library to add nodes to the composition.

◆ contextMenuEvent()

void VuoNodeClassList::contextMenuEvent ( QContextMenuEvent * event )

protected

Handle context menu events.

Definition at line 370 of file VuoNodeClassList.cc.

◆ disablePopovers()

void VuoNodeClassList::disablePopovers ( )

Disables display of popovers in response to user interaction.

Definition at line 326 of file VuoNodeClassList.cc.

◆ displayPopoverForItem

void VuoNodeClassList::displayPopoverForItem ( QListWidgetItem * targetNodeClassItem )

protectedslot

Displays the popover for the targetNodeClass item.

Definition at line 237 of file VuoNodeClassList.cc.

◆ enablePopovers()

void VuoNodeClassList::enablePopovers ( )

Enables display of popovers in response to user interaction.

Definition at line 308 of file VuoNodeClassList.cc.

◆ enablePopoversAndDisplayCurrent()

void VuoNodeClassList::enablePopoversAndDisplayCurrent ( )

Enables display of popovers in response to user interaction and displays the popover for the current item.

Definition at line 317 of file VuoNodeClassList.cc.

◆ getNodeClassForItem()

VuoCompilerNodeClass * VuoNodeClassList::getNodeClassForItem ( QListWidgetItem * item )

Returns the node class for the provided item, or NULL if none.

Definition at line 277 of file VuoNodeClassList.cc.

◆ keyPressEvent()

void VuoNodeClassList::keyPressEvent ( QKeyEvent * event )

protected

If a user selects a node class and presses 'Return', trigger node instantiation.

Definition at line 86 of file VuoNodeClassList.cc.

◆ mousePressEvent()

void VuoNodeClassList::mousePressEvent ( QMouseEvent * event )

protected

Handle mouse press events.

Definition at line 286 of file VuoNodeClassList.cc.

◆ mouseReleaseEvent()

void VuoNodeClassList::mouseReleaseEvent ( QMouseEvent * event )

protected

Handle mouse release events.

Definition at line 295 of file VuoNodeClassList.cc.

◆ nodeClassListHeightChanged

void VuoNodeClassList::nodeClassListHeightChanged ( int newHeight )

signal

Emitted when the node class list's height changes.

◆ nodePopoverRequestedForClass

void VuoNodeClassList::nodePopoverRequestedForClass ( VuoNodeClass * nodeClass )

signal

Emitted when documentation for the specified node class has been requested.

◆ populateContextMenuForNodeClass()

void VuoNodeClassList::populateContextMenuForNodeClass	(	QMenu *	contextMenu,
		VuoCompilerNodeClass *	nodeClass
	)

static

Populates the provided context menu with options corresponding to the provided node class.

Definition at line 392 of file VuoNodeClassList.cc.

◆ setFilterText()

void VuoNodeClassList::setFilterText ( QString filterText )

Sets the filter text used to search for node classes within the library.

Definition at line 269 of file VuoNodeClassList.cc.

◆ wheelEvent()

void VuoNodeClassList::wheelEvent ( QWheelEvent * event )

protected

Handle mouse wheel events.

Definition at line 355 of file VuoNodeClassList.cc.

Member Data Documentation

◆ selectionFinalized

bool VuoNodeClassList::selectionFinalized

True when list filtering has completed.

Definition at line 32 of file VuoNodeClassList.hh.

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

editor/VuoNodeClassList.hh
editor/VuoNodeClassList.cc

Description

Signals

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Slots

Protected Member Functions

Constructor & Destructor Documentation

◆ VuoNodeClassList()

Member Function Documentation

◆ addDoubleClickedNode

◆ componentsAdded

◆ contextMenuEvent()

◆ disablePopovers()

◆ displayPopoverForItem

◆ enablePopovers()

◆ enablePopoversAndDisplayCurrent()

◆ getNodeClassForItem()

◆ keyPressEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ nodeClassListHeightChanged

◆ nodePopoverRequestedForClass

◆ populateContextMenuForNodeClass()

◆ setFilterText()

◆ wheelEvent()

Member Data Documentation

◆ selectionFinalized