Vuo  2.1.0
Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
VuoNodePopover Class Reference

Description

A popover widget for displaying information about a node or node class.

Definition at line 23 of file VuoNodePopover.hh.

Public Slots

void setTextWidth (int width)
 Sets the fixed text width of the popover to the provided width minus 2 * VuoNodePopover::margin. More...
 

Signals

void popoverDisplayRequested (QWidget *, QString)
 Emitted when a node popover is to be displayed. More...
 
- Signals inherited from VuoPanelDocumentation
void textSelectionChanged ()
 Emitted when the documentation's text selection changes. More...
 

Public Member Functions

 VuoNodePopover (VuoNodeClass *nodeClass, VuoCompiler *compiler, QWidget *parent=0)
 Creates a new popover widget to display information about a node class. More...
 
void cleanup ()
 Temporarily moved the destructor's disconnect call here. More...
 
 ~VuoNodePopover ()
 Destroys a popover. More...
 
int getTextWidth ()
 Returns the popover's fixed text width. More...
 
void prepareResourcesAndShow ()
 Displays the popover, extracting any necessary resources (e.g., images) first. More...
 
bool containsImage ()
 Returns a boolean indicating whether this popover description contains an embedded image. More...
 
VuoNodeClassgetNodeClass ()
 Returns the node class associated with this popover. More...
 
VuoRendererNodegetModelNode ()
 Returns the model renderer node associated with this popover. More...
 
QString getSelectedText ()
 Returns the currently selected text within this popover's text field, or the empty string of not applicable. 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...
 

Static Public Member Functions

static QString generateTextStyleString (void)
 Returns the stylesheet for text areas. More...
 

Protected Member Functions

void mouseMoveEvent (QMouseEvent *event)
 Handle mouse move events. More...
 
void mouseDoubleClickEvent (QMouseEvent *event)
 Handle mouse double-click events. More...
 
void contextMenuEvent (QContextMenuEvent *event)
 Handle context menu events. 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

◆ VuoNodePopover()

VuoNodePopover::VuoNodePopover ( VuoNodeClass nodeClass,
VuoCompiler compiler,
QWidget *  parent = 0 
)
explicit

Creates a new popover widget to display information about a node class.

Definition at line 34 of file VuoNodePopover.cc.

◆ ~VuoNodePopover()

VuoNodePopover::~VuoNodePopover ( )

Destroys a popover.

Definition at line 142 of file VuoNodePopover.cc.

Member Function Documentation

◆ cleanup()

void VuoNodePopover::cleanup ( )

Temporarily moved the destructor's disconnect call here.

https://b33p.net/kosada/node/13263 https://b33p.net/kosada/node/15784

Definition at line 134 of file VuoNodePopover.cc.

◆ containsImage()

bool VuoNodePopover::containsImage ( )

Returns a boolean indicating whether this popover description contains an embedded image.

Definition at line 499 of file VuoNodePopover.cc.

◆ contextMenuEvent()

void VuoNodePopover::contextMenuEvent ( QContextMenuEvent *  event)
protected

Handle context menu events.

Definition at line 639 of file VuoNodePopover.cc.

◆ generateTextStyleString()

QString VuoNodePopover::generateTextStyleString ( void  )
static

Returns the stylesheet for text areas.

Definition at line 524 of file VuoNodePopover.cc.

◆ getModelNode()

VuoRendererNode * VuoNodePopover::getModelNode ( )

Returns the model renderer node associated with this popover.

Definition at line 516 of file VuoNodePopover.cc.

◆ getNodeClass()

VuoNodeClass * VuoNodePopover::getNodeClass ( )

Returns the node class associated with this popover.

Definition at line 508 of file VuoNodePopover.cc.

◆ getSelectedText()

QString VuoNodePopover::getSelectedText ( )
virtual

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

Reimplemented from VuoPanelDocumentation.

Definition at line 437 of file VuoNodePopover.cc.

◆ getTextWidth()

int VuoNodePopover::getTextWidth ( )

Returns the popover's fixed text width.

Definition at line 428 of file VuoNodePopover.cc.

◆ mouseDoubleClickEvent()

void VuoNodePopover::mouseDoubleClickEvent ( QMouseEvent *  event)
protected

Handle mouse double-click events.

Definition at line 620 of file VuoNodePopover.cc.

◆ mouseMoveEvent()

void VuoNodePopover::mouseMoveEvent ( QMouseEvent *  event)
protected

Handle mouse move events.

Definition at line 575 of file VuoNodePopover.cc.

◆ popoverDisplayRequested

void VuoNodePopover::popoverDisplayRequested ( QWidget *  ,
QString   
)
signal

Emitted when a node popover is to be displayed.

◆ prepareResourcesAndShow()

void VuoNodePopover::prepareResourcesAndShow ( )

Displays the popover, extracting any necessary resources (e.g., images) first.

Definition at line 470 of file VuoNodePopover.cc.

◆ setTextWidth

void VuoNodePopover::setTextWidth ( int  width)
slot

Sets the fixed text width of the popover to the provided width minus 2 * VuoNodePopover::margin.

Definition at line 451 of file VuoNodePopover.cc.


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