Description

A popover widget for displaying information about a port.

Definition at line 20 of file VuoPortPopover.hh.

Public Slots
void	setWindowLevel (bool top)
	Changes the popover to float on top of all windows (if `top` is true), or to behave as a normal window (if `top` is false). More...

void	setWindowLevelAndVisibility (bool top)
	Changes the popover to float on top of all windows (if `top` is true), or to behave as a normal window (if `top` is false). More...

void	setCompositionRunning (bool running, bool resetDataValue=true)
	Updates the popover to include or exclude information relevant only if the composition is currently running. More...

void	updateTextAndResize ()
	Updates the popover text and expands the popover to accommodate the updated text if necessary. More...

void	updateDataValueImmediately (QString value)
	Displays the new data value in the popover immediately, without waiting for the popover to refresh on its regular schedule. More...

void	updateLastEventTimeAndDataValue (bool event, bool data, QString value)
	Displays the new event time (if any) and data value (if any) the next time the popover's contents are refreshed. More...

void	incrementDroppedEventCount ()
	Increments the number of dropped events observed for the port (a trigger port). More...

Signals
void	popoverClosedForPort (string portID)
	Emitted when the popover is closed. More...

void	popoverDetachedFromPort (string portID)
	Emitted when the popover is detached from its port. More...

void	popoverResized ()
	Emitted when the popover has been resized. More...

Public Member Functions
	VuoPortPopover (VuoPort port, VuoEditorComposition composition, QWidget *parent=0)
	Creates a new popover widget to display information about a port. More...

	~VuoPortPopover ()
	Destroys a popover. More...

bool	getDetached ()
	Returns a boolean indicating whether the popover is detached from its port. More...

void	detach ()
	Detaches the popover from its port. More...

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

void	mouseMoveEvent (QMouseEvent *event)
	Handle mouse move events. More...

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

void	closeEvent (QCloseEvent *event)
	Handle close events. More...

void	resizeEvent (QResizeEvent *event)
	Handle resize events. More...

Constructor & Destructor Documentation

◆ VuoPortPopover()

VuoPortPopover::VuoPortPopover	(	VuoPort *	port,
		VuoEditorComposition *	composition,
		QWidget *	parent = `0`
	)

explicit

Creates a new popover widget to display information about a port.

Definition at line 43 of file VuoPortPopover.cc.

◆ ~VuoPortPopover()

VuoPortPopover::~VuoPortPopover ( )

Destroys a popover.

Definition at line 114 of file VuoPortPopover.cc.

Member Function Documentation

◆ closeEvent()

void VuoPortPopover::closeEvent ( QCloseEvent * event )

protected

Handle close events.

Definition at line 861 of file VuoPortPopover.cc.

◆ detach()

void VuoPortPopover::detach ( )

Detaches the popover from its port.

Definition at line 660 of file VuoPortPopover.cc.

◆ getDetached()

bool VuoPortPopover::getDetached ( )

Returns a boolean indicating whether the popover is detached from its port.

Definition at line 652 of file VuoPortPopover.cc.

◆ incrementDroppedEventCount

void VuoPortPopover::incrementDroppedEventCount ( )

slot

Increments the number of dropped events observed for the port (a trigger port).

Definition at line 180 of file VuoPortPopover.cc.

◆ mouseMoveEvent()

void VuoPortPopover::mouseMoveEvent ( QMouseEvent * event )

protected

Handle mouse move events.

Definition at line 835 of file VuoPortPopover.cc.

◆ mousePressEvent()

void VuoPortPopover::mousePressEvent ( QMouseEvent * event )

protected

Handle mouse press events.

Definition at line 818 of file VuoPortPopover.cc.

◆ mouseReleaseEvent()

void VuoPortPopover::mouseReleaseEvent ( QMouseEvent * event )

protected

Handle mouse release events.

Definition at line 850 of file VuoPortPopover.cc.

◆ popoverClosedForPort

void VuoPortPopover::popoverClosedForPort ( string portID )

signal

Emitted when the popover is closed.

◆ popoverDetachedFromPort

void VuoPortPopover::popoverDetachedFromPort ( string portID )

signal

Emitted when the popover is detached from its port.

◆ popoverResized

void VuoPortPopover::popoverResized ( )

signal

Emitted when the popover has been resized.

◆ resizeEvent()

void VuoPortPopover::resizeEvent ( QResizeEvent * event )

protected

Handle resize events.

Definition at line 870 of file VuoPortPopover.cc.

◆ setCompositionRunning

void VuoPortPopover::setCompositionRunning	(	bool	running,
		bool	resetDataValue = `true`
	)

slot

Updates the popover to include or exclude information relevant only if the composition is currently running.

Definition at line 194 of file VuoPortPopover.cc.

◆ setWindowLevel

void VuoPortPopover::setWindowLevel ( bool top )

slot

Changes the popover to float on top of all windows (if top is true), or to behave as a normal window (if top is false).

Definition at line 807 of file VuoPortPopover.cc.

◆ setWindowLevelAndVisibility

void VuoPortPopover::setWindowLevelAndVisibility ( bool top )

slot

Changes the popover to float on top of all windows (if top is true), or to behave as a normal window (if top is false).

If top is false, also lowers the popover, effectively hiding it.

Definition at line 795 of file VuoPortPopover.cc.

◆ updateDataValueImmediately

void VuoPortPopover::updateDataValueImmediately ( QString value )

slot

Displays the new data value in the popover immediately, without waiting for the popover to refresh on its regular schedule.

Parameters

value A string representation of the port's data value.

Definition at line 126 of file VuoPortPopover.cc.

◆ updateLastEventTimeAndDataValue

void VuoPortPopover::updateLastEventTimeAndDataValue	(	bool	event,
		bool	data,
		QString	value
	)

slot

Displays the new event time (if any) and data value (if any) the next time the popover's contents are refreshed.

If this function is called again before then, only the event time and data value from the later call are displayed.

Parameters

event	True if the popover's last event time should be updated.
data	True if the popover's data value should be updated.
value	A string representation of the port's data value.

Definition at line 147 of file VuoPortPopover.cc.

◆ updateTextAndResize

void VuoPortPopover::updateTextAndResize ( )

slot

Updates the popover text and expands the popover to accommodate the updated text if necessary.

This function may be called on any dispatch queue except popoverTextQueue.

Definition at line 235 of file VuoPortPopover.cc.

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

editor/VuoPortPopover.hh
editor/VuoPortPopover.cc

Description

Public Slots

Signals

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ VuoPortPopover()

◆ ~VuoPortPopover()

Member Function Documentation

◆ closeEvent()

◆ detach()

◆ getDetached()

◆ incrementDroppedEventCount

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ popoverClosedForPort

◆ popoverDetachedFromPort

◆ popoverResized

◆ resizeEvent()

◆ setCompositionRunning

◆ setWindowLevel

◆ setWindowLevelAndVisibility

◆ updateDataValueImmediately

◆ updateLastEventTimeAndDataValue

◆ updateTextAndResize