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	updateCachedDataValue (QString value)
	Stores a string representation of the most recent data value known to be associated with the port. More...

void	updateLastEventTime ()
	Updates the time of the last known event associated with the port. More...

void	updateLastEventTimeAndCachedDataValue (QString value)
	Updates both the time of the last known event and the last data value associated with the port. 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 113 of file VuoPortPopover.cc.

Member Function Documentation

◆ closeEvent()

void VuoPortPopover::closeEvent ( QCloseEvent * event )

protected

Handle close events.

Definition at line 884 of file VuoPortPopover.cc.

◆ detach()

void VuoPortPopover::detach ( )

Detaches the popover from its port.

Definition at line 664 of file VuoPortPopover.cc.

◆ getDetached()

bool VuoPortPopover::getDetached ( )

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

Definition at line 656 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 184 of file VuoPortPopover.cc.

◆ mouseMoveEvent()

void VuoPortPopover::mouseMoveEvent ( QMouseEvent * event )

protected

Handle mouse move events.

Definition at line 858 of file VuoPortPopover.cc.

◆ mousePressEvent()

void VuoPortPopover::mousePressEvent ( QMouseEvent * event )

protected

Handle mouse press events.

Definition at line 841 of file VuoPortPopover.cc.

◆ mouseReleaseEvent()

void VuoPortPopover::mouseReleaseEvent ( QMouseEvent * event )

protected

Handle mouse release events.

Definition at line 873 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 893 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 198 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 830 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 818 of file VuoPortPopover.cc.

◆ updateCachedDataValue

void VuoPortPopover::updateCachedDataValue ( QString value )

slot

Stores a string representation of the most recent data value known to be associated with the port.

Definition at line 123 of file VuoPortPopover.cc.

◆ updateLastEventTime

void VuoPortPopover::updateLastEventTime ( )

slot

Updates the time of the last known event associated with the port.

Definition at line 136 of file VuoPortPopover.cc.

◆ updateLastEventTimeAndCachedDataValue

void VuoPortPopover::updateLastEventTimeAndCachedDataValue ( QString value )

slot

Updates both the time of the last known event and the last data value associated with the port.

Definition at line 160 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 238 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

◆ updateCachedDataValue

◆ updateLastEventTime

◆ updateLastEventTimeAndCachedDataValue

◆ updateTextAndResize