Description

A widget for displaying content within the documentation panel of the node library.

Definition at line 17 of file VuoPanelDocumentation.hh.

Signals
void	textSelectionChanged ()
	Emitted when the documentation's text selection changes. More...

Public Member Functions
	VuoPanelDocumentation (QWidget *parent=0)
	Creates a new widget for displaying content within the documentation panel of the node library. More...

virtual QString	getSelectedText ()
	Returns the currently selected text within this widget's text field, or the empty string of not applicable. More...

Protected Member Functions
bool	event (QEvent *event) VuoWarnUnusedResult
	Handles events for the documentation widget. More...

Protected Attributes
bool	documentationEntered
	Whether the cursor is currently positioned over this widget. More...

Constructor & Destructor Documentation

◆ VuoPanelDocumentation()

VuoPanelDocumentation::VuoPanelDocumentation ( QWidget * parent = 0 )

explicit

Creates a new widget for displaying content within the documentation panel of the node library.

Definition at line 16 of file VuoPanelDocumentation.cc.

Member Function Documentation

◆ event()

bool VuoPanelDocumentation::event ( QEvent * event )

protected

Handles events for the documentation widget.

Definition at line 25 of file VuoPanelDocumentation.cc.

◆ getSelectedText()

QString VuoPanelDocumentation::getSelectedText ( )

virtual

Returns the currently selected text within this widget's text field, or the empty string of not applicable.

Should be implemented by subclasses.

Reimplemented in VuoNodePopover, and VuoCompositionMetadataPanel.

Definition at line 51 of file VuoPanelDocumentation.cc.

◆ textSelectionChanged

void VuoPanelDocumentation::textSelectionChanged ( )

signal

Emitted when the documentation's text selection changes.

Member Data Documentation

◆ documentationEntered

bool VuoPanelDocumentation::documentationEntered

protected

Whether the cursor is currently positioned over this widget.

Definition at line 29 of file VuoPanelDocumentation.hh.

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

editor/VuoPanelDocumentation.hh
editor/VuoPanelDocumentation.cc

Description

Signals

Public Member Functions

Protected Member Functions

Protected Attributes