Vuo  0.5.7
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Signals | Public Member Functions | Protected Member Functions | List of all members
VuoInputEditor Class Referenceabstract

Description

Base class for input editors.

To create a custom input editor, implement a derived class of this class. An input editor provides the widget for editing a constant value on an input port. Each class of data editor handles one type of input port data (e.g. VuoInteger, VuoText).

Signals

void valueChanged (json_object *newValue)
 An input editor can emit this signal to inform the Vuo Editor that the value has been edited.
 
void tabCycleCompleted ()
 An input editor can emit this signal to inform the Vuo Editor that a 'Tab' keypress was received while the final widget in this input editor's tab cycle already had focus.
 
void reverseTabCycleCompleted ()
 An input editor can emit this signal to inform the Vuo Editor that a 'Shift'+'Tab' keypress was received while the first widget in this input editor's tab cycle already had focus.
 

Public Member Functions

virtual json_object * show (QPoint portLeftCenter, json_object *originalValue, QString portName, vector< pair< QString, json_object * > > portNamesAndValues, json_object *details)=0
 Displays the input editor and waits until the user has finished or canceled editing.
 
virtual bool emitsTabCycleCompletionSignals (void)
 Returns a boolean indicating whether this input editor emits tabCycleCompleted() and reverseTabCycleCompleted() signals when appropriate.
 

Protected Member Functions

QFont getDefaultFont (void)
 Returns the font that input editors are recommended to use.
 

Member Function Documentation

bool VuoInputEditor::emitsTabCycleCompletionSignals ( void  )
virtual

Returns a boolean indicating whether this input editor emits tabCycleCompleted() and reverseTabCycleCompleted() signals when appropriate.

If true, the Vuo Editor will consider this input editor eligible for inclusion in the input editor tab cycle for a given node.

Reimplemented in VuoInputEditorWithLineEdit.

QFont VuoInputEditor::getDefaultFont ( void  )
protected

Returns the font that input editors are recommended to use.

void VuoInputEditor::reverseTabCycleCompleted ( )
signal

An input editor can emit this signal to inform the Vuo Editor that a 'Shift'+'Tab' keypress was received while the first widget in this input editor's tab cycle already had focus.

This indicates to the Vuo Editor that it should display the input editor for the previous eligible input port belonging to the same node.

virtual json_object* VuoInputEditor::show ( QPoint  portLeftCenter,
json_object *  originalValue,
QString  portName,
vector< pair< QString, json_object * > >  portNamesAndValues,
json_object *  details 
)
pure virtual

Displays the input editor and waits until the user has finished or canceled editing.

Parameters
portLeftCenterThe left center point (in global coordinates) of the port whose value is to be edited. Used to position the input editor.
originalValueThe value to display initially in the input editor.
portNameThe name of the port whose value is to be edited.
portNamesAndValuesAn ordered list of pairs consisting of the names and currently assigned values of each port that belongs to the same node as the target port and whose value is currently constant.
detailsAdditional details pertaining to the port data (e.g., suggested minimum and maximum values). A port in a node class implementation can optionally provide these details. To assist node class developers, the input editor's class description should document the JSON keys recognized by the input editor.
See Also
Built-in Types for information about types and their serialization to JSON.

Implemented in VuoInputEditorColor, VuoInputEditorFont, VuoInputEditorWithMenu, and VuoInputEditorWithDialog.

void VuoInputEditor::tabCycleCompleted ( )
signal

An input editor can emit this signal to inform the Vuo Editor that a 'Tab' keypress was received while the final widget in this input editor's tab cycle already had focus.

This indicates to the Vuo Editor that it should display the input editor for the next eligible input port belonging to the same node.

void VuoInputEditor::valueChanged ( json_object *  newValue)
signal

An input editor can emit this signal to inform the Vuo Editor that the value has been edited.

If the Vuo Editor receives this signal while a composition is running, it updates the running composition immediately to use the updated value (while the input editor is still showing).

Parameters
newValueThe updated value.

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