VuoPanelDocumentation Class Reference

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.

Public Member Functions
	VuoPanelDocumentation (QWidget *parent=0)
	Creates a new widget for displaying content within the documentation panel of the node library.
virtual QString	getSelectedText ()
	Returns the currently selected text within this widget's text field, or the empty string of not applicable.

Protected Slots
void	linkHovered (const QString &link)
	Invoked by QLabel when the user hovers the mouse over a hyperlink.

Protected Member Functions
bool	event (QEvent *event) VuoWarnUnusedResult
	Handles events for the documentation widget.
QString	getDescriptionForURL (const QString &url)
	Returns a translated text description of a URL, clarifying the meaning of the VuoEditor::vuo*Scheme URL schemes.
void	hideEvent (QHideEvent *event)
	Invoked by Qt when this widget is no longer visible.

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 18 of file VuoPanelDocumentation.cc.

Member Function Documentation

event()

bool VuoPanelDocumentation::event ( QEvent *  event )

protected

Handles events for the documentation widget.

Definition at line 28 of file VuoPanelDocumentation.cc.

getDescriptionForURL()

QString VuoPanelDocumentation::getDescriptionForURL ( const QString &  url )

protected

Returns a translated text description of a URL, clarifying the meaning of the VuoEditor::vuo*Scheme URL schemes.

Definition at line 63 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 VuoCompositionMetadataPanel, and VuoNodePopover.

Definition at line 54 of file VuoPanelDocumentation.cc.

hideEvent()

void VuoPanelDocumentation::hideEvent ( QHideEvent *  event )

protected

Invoked by Qt when this widget is no longer visible.

Definition at line 106 of file VuoPanelDocumentation.cc.

linkHovered

void VuoPanelDocumentation::linkHovered ( const QString &  link )

protectedslot

Invoked by QLabel when the user hovers the mouse over a hyperlink.

Definition at line 81 of file VuoPanelDocumentation.cc.

textSelectionChanged

void VuoPanelDocumentation::textSelectionChanged ( )

signal

Emitted when the documentation's text selection changes.

---

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

• editor/VuoPanelDocumentation.hh
• editor/VuoPanelDocumentation.cc