VuoCompositionMetadataPanel Class Reference

Description

A widget that shows information about the composition.

Definition at line 19 of file VuoCompositionMetadataPanel.hh.

Public Slots
void	setTextWidth (int width)
	Sets the fixed text width of the panel to the provided width minus 2 * VuoCompositionMetadataPanel::margin. More...

Signals
void	metadataEditRequested ()
	Emitted when the user has clicked the "Edit" link. More...
Signals inherited from VuoPanelDocumentation
void	textSelectionChanged ()
	Emitted when the documentation's text selection changes. More...

Public Member Functions
	VuoCompositionMetadataPanel (VuoComposition *composition, QWidget *parent=0)
	Creates a new panel widget to display information about a composition. More...
	~VuoCompositionMetadataPanel ()
	Destroys a panel. More...
QString	generateCompositionMetadataText ()
	Generates a descriptive text string containing information about the panel's associated composition. More...
QString	getSelectedText ()
	Returns the currently selected text within this widget's text field, or the empty string of not applicable. More...
void	update ()
	Updates the widget with the current background color and text content. More...
void	setIsUserComposition (bool userComposition)
	Sets the boolean indicating whether or not this is a user-created composition (rather than a built-in example composition). More...
Public Member Functions inherited from VuoPanelDocumentation
	VuoPanelDocumentation (QWidget *parent=0)
	Creates a new widget for displaying content within the documentation panel of the node library. More...

Protected Member Functions
void	paintEvent (QPaintEvent *event)
	Draws the composition metadata panel. More...
Protected Member Functions inherited from VuoPanelDocumentation
bool	event (QEvent *event) VuoWarnUnusedResult
	Handles events for the documentation widget. More...

Additional Inherited Members
Protected Attributes inherited from VuoPanelDocumentation
bool	documentationEntered
	Whether the cursor is currently positioned over this widget. More...

Constructor & Destructor Documentation

VuoCompositionMetadataPanel()

VuoCompositionMetadataPanel::VuoCompositionMetadataPanel ( VuoComposition *  composition, QWidget *  parent = 0  )

explicit

Creates a new panel widget to display information about a composition.

Definition at line 27 of file VuoCompositionMetadataPanel.cc.

~VuoCompositionMetadataPanel()

VuoCompositionMetadataPanel::~VuoCompositionMetadataPanel

(

)

Destroys a panel.

Definition at line 254 of file VuoCompositionMetadataPanel.cc.

Member Function Documentation

generateCompositionMetadataText()

QString VuoCompositionMetadataPanel::generateCompositionMetadataText

(

)

Generates a descriptive text string containing information about the panel's associated composition.

Definition at line 102 of file VuoCompositionMetadataPanel.cc.

getSelectedText()

QString VuoCompositionMetadataPanel::getSelectedText ( )

virtual

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

Reimplemented from VuoPanelDocumentation.

Definition at line 211 of file VuoCompositionMetadataPanel.cc.

metadataEditRequested

void VuoCompositionMetadataPanel::metadataEditRequested ( )

signal

Emitted when the user has clicked the "Edit" link.

paintEvent()

void VuoCompositionMetadataPanel::paintEvent ( QPaintEvent *  event )

protected

Draws the composition metadata panel.

Definition at line 85 of file VuoCompositionMetadataPanel.cc.

setIsUserComposition()

void VuoCompositionMetadataPanel::setIsUserComposition

(

bool

userComposition

)

Sets the boolean indicating whether or not this is a user-created composition (rather than a built-in example composition).

Definition at line 242 of file VuoCompositionMetadataPanel.cc.

setTextWidth

void VuoCompositionMetadataPanel::setTextWidth ( int  width )

slot

Sets the fixed text width of the panel to the provided width minus 2 * VuoCompositionMetadataPanel::margin.

Definition at line 193 of file VuoCompositionMetadataPanel.cc.

update()

void VuoCompositionMetadataPanel::update

(

)

Updates the widget with the current background color and text content.

Definition at line 222 of file VuoCompositionMetadataPanel.cc.

---

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

• editor/VuoCompositionMetadataPanel.hh
• editor/VuoCompositionMetadataPanel.cc