Vuo  1.2.3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
VuoInputEditorText Class Reference

Description

An input editor that displays a text area for entering plain text.

The text area has a fixed width but automatically adjusts its height (up to a point) to fit the text.

This input editor recognizes the following keys in the JSON details object:

Public Member Functions

 VuoInputEditorText (void)
 Creates an input editor whose show() function displays a text edit.
 
bool supportsTabbingBetweenPorts (void)
 Returns true.
 
- Public Member Functions inherited from VuoInputEditorWithDialog
json_objectshow (QPoint portLeftCenter, json_object *originalValue, json_object *details, map< QString, json_object * > portNamesAndValues)
 Displays a frameless dialog.
 

Protected Member Functions

void setUpDialog (QDialog &dialog, json_object *originalValue, json_object *details)
 Sets up a dialog containing a text edit.
 
json_objectgetAcceptedValue (void)
 Returns the current text in the text edit.
 
QString convertToTextEditFormat (json_object *value)
 Removes quotation marks from the value to display in the text edit.
 
json_objectconvertFromTextEditFormat (const QString &valueAsString)
 Adds quotation marks around the value from the text edit.
 
bool eventFilter (QObject *object, QEvent *event)
 Handles some events before they reach the text edit or related widgets.
 
bool event (QEvent *event)
 Handles some events received by the input editor.
 
- Protected Member Functions inherited from VuoInputEditorWithDialog
 VuoInputEditorWithDialog (void)
 Creates an input editor whose show() function displays a frameless dialog.
 
QDialog * getDialog (void)
 Returns a pointer to the dialog displayed by show().
 
void setFirstWidgetInTabOrder (QWidget *widget)
 Makes the given widget the first in this input editor's tab order.
 
void setLastWidgetInTabOrder (QWidget *widget)
 Makes the given widget the last in this input editor's tab order.
 
bool eventFilter (QObject *object, QEvent *event)
 Handles tabbing past the last widget or reverse-tabbing past the first widget in the tab order.
 

Additional Inherited Members

- Signals inherited from VuoInputEditor
void valueChanged (json_object *newValue)
 An input editor can emit this signal to inform the Vuo Editor that the value has been edited.
 
void tabbedPastLastWidget ()
 If supportsTabbingBetweenPorts() returns true, an input editor should emit this signal when the Tab key is pressed while the last widget in the input editor's tab order has focus.
 
void tabbedBackwardPastFirstWidget ()
 If supportsTabbingBetweenPorts() returns true, an input editor should emit this signal when the Shift-Tab key combination is pressed while the first widget in the input editor's tab order has focus.
 
- Static Public Member Functions inherited from VuoInputEditor
static QFont getDefaultFont (void)
 Returns the font that input editors are recommended to use.
 
static QString getDefaultFontCss (void)
 Returns a CSS representation of the font that input editors are recommended to use.
 

Constructor & Destructor Documentation

VuoInputEditorText::VuoInputEditorText ( void  )

Creates an input editor whose show() function displays a text edit.

Member Function Documentation

json_object * VuoInputEditorText::convertFromTextEditFormat ( const QString &  valueAsString)
protected

Adds quotation marks around the value from the text edit.

QString VuoInputEditorText::convertToTextEditFormat ( json_object value)
protected

Removes quotation marks from the value to display in the text edit.

bool VuoInputEditorText::event ( QEvent *  event)
protected

Handles some events received by the input editor.

bool VuoInputEditorText::eventFilter ( QObject *  object,
QEvent *  event 
)
protected

Handles some events before they reach the text edit or related widgets.

json_object * VuoInputEditorText::getAcceptedValue ( void  )
protectedvirtual

Returns the current text in the text edit.

Implements VuoInputEditorWithDialog.

void VuoInputEditorText::setUpDialog ( QDialog &  dialog,
json_object originalValue,
json_object details 
)
protectedvirtual

Sets up a dialog containing a text edit.

Removes the quotation marks surrounding originalValue before displaying it in the line edit.

Implements VuoInputEditorWithDialog.

bool VuoInputEditorText::supportsTabbingBetweenPorts ( void  )
virtual

Returns true.

Reimplemented from VuoInputEditor.


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