Vuo
0.5.7
|
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. | |
|
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.
|
protected |
Returns the font that input editors are recommended to use.
|
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.
|
pure virtual |
Displays the input editor and waits until the user has finished or canceled editing.
portLeftCenter | The left center point (in global coordinates) of the port whose value is to be edited. Used to position the input editor. |
originalValue | The value to display initially in the input editor. |
portName | The name of the port whose value is to be edited. |
portNamesAndValues | An 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. |
details | Additional 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. |
Implemented in VuoInputEditorColor, VuoInputEditorFont, VuoInputEditorWithMenu, and VuoInputEditorWithDialog.
|
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.
|
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).
newValue | The updated value. |