Description
An input editor that displays a text area for entering comment text.
The text area has a fixed width but automatically adjusts its height (up to a point) to fit the text.
Definition at line 19 of file VuoCommentEditor.hh.
Public Member Functions | |
| VuoCommentEditor (void) | |
| Creates an input editor whose show() function displays a text edit. More... | |
| json_object * | show (QPoint portLeftCenter, json_object *originalValue, json_object *details) |
Convenience function for VuoInputEditorWithDialog::show(portLeftCenter, originalValue, details, portNamesAndValues) , useful for comment editors since the portNamesAndValues does not apply. More... | |
| bool | supportsTabbingBetweenPorts (void) |
| Returns false. More... | |
| void | setWidth (int width) |
| Sets the width of the comment editor. More... | |
| void | setHeight (int height) |
| Sets the height of the comment editor. More... | |
| json_object * | show (QPoint portLeftCenter, json_object *originalValue, json_object *details, map< QString, json_object * > portNamesAndValues) |
| Displays a frameless dialog. More... | |
 Public Member Functions inherited from VuoTextEditor | |
| VuoTextEditor (void) | |
| Creates an input editor whose show() function displays a text edit. More... | |
| bool | supportsTabbingBetweenPorts (void) |
| Returns true. More... | |
| Public Member Functions inherited from VuoInputEditorWithDialog | |
| json_object * | show (QPoint portLeftCenter, json_object *originalValue, json_object *details, map< QString, json_object * > portNamesAndValues) |
| Displays a frameless dialog. More... | |
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. More... | |
| 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. More... | |
| 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. More... | |
| Static Public Member Functions inherited from VuoInputEditor | |
| static QFont | getDefaultFont (void) |
| Returns the font that input editors are recommended to use. More... | |
| static QString | getDefaultFontCss (void) |
| Returns a CSS representation of the font that input editors are recommended to use. More... | |
| Protected Slots inherited from VuoTextEditor | |
| virtual void | resizeToFitText () |
| Resizes the text edit and dialog to the height of the text. More... | |
| Protected Member Functions inherited from VuoTextEditor | |
| void | setUpDialog (QDialog &dialog, json_object *originalValue, json_object *details) |
| Sets up a dialog containing a text edit. More... | |
| json_object * | getAcceptedValue (void) |
| Returns the current text in the text edit. More... | |
| QString | convertToTextEditFormat (json_object *value) |
| Removes quotation marks from the value to display in the text edit. More... | |
| json_object * | convertFromTextEditFormat (const QString &valueAsString) |
| Adds quotation marks around the value from the text edit. More... | |
| void | resizeToFitTextWithBaseline (int baselineWidth=0, int baselineHeight=0) |
Resizes the text edit and dialog to the height of the text, taking the requested baselineWidth and baselineHeight into account. More... | |
| bool | eventFilter (QObject *object, QEvent *event) VuoWarnUnusedResult |
| Handles some events before they reach the text edit or related widgets. More... | |
| bool | event (QEvent *event) VuoWarnUnusedResult |
| Handles some events received by the input editor. More... | |
| Protected Member Functions inherited from VuoInputEditorWithDialog | |
| VuoInputEditorWithDialog (void) | |
| Creates an input editor whose show() function displays a frameless dialog. More... | |
| QDialog * | getDialog (void) |
| Returns a pointer to the dialog displayed by show(). More... | |
| void | setFirstWidgetInTabOrder (QWidget *widget) |
| Makes the given widget the first in this input editor's tab order. More... | |
| void | setLastWidgetInTabOrder (QWidget *widget) |
| Makes the given widget the last in this input editor's tab order. More... | |
| bool | eventFilter (QObject *object, QEvent *event) VuoWarnUnusedResult |
| Handles tabbing past the last widget or reverse-tabbing past the first widget in the tab order. More... | |
| Protected Attributes inherited from VuoTextEditor | |
| QPlainTextEdit * | textEdit |
| The text area widget. More... | |
| bool | isCodeEditor |
| Whether or not to treat the input text as code. More... | |
| Protected Attributes inherited from VuoInputEditorWithDialog | |
| bool | isDark |
| Is Vuo Editor in Dark Interface Mode? More... | |
Constructor & Destructor Documentation
◆ VuoCommentEditor()
| VuoCommentEditor::VuoCommentEditor | ( | void | ) |
Creates an input editor whose show() function displays a text edit.
Definition at line 22 of file VuoCommentEditor.cc.
Member Function Documentation
◆ setHeight()
| void VuoCommentEditor::setHeight | ( | int | height | ) |
Sets the height of the comment editor.
Definition at line 59 of file VuoCommentEditor.cc.
◆ setWidth()
| void VuoCommentEditor::setWidth | ( | int | width | ) |
Sets the width of the comment editor.
Definition at line 51 of file VuoCommentEditor.cc.
◆ show() [1/2]
| json_object * VuoCommentEditor::show | ( | QPoint | portLeftCenter, |
| json_object * | originalValue, | ||
| json_object * | details | ||
| ) |
Convenience function for VuoInputEditorWithDialog::show(portLeftCenter, originalValue, details, portNamesAndValues) , useful for comment editors since the portNamesAndValues does not apply.
Definition at line 33 of file VuoCommentEditor.cc.
◆ show() [2/2]
| json_object * VuoInputEditorWithDialog::show |
Displays a frameless dialog.
Definition at line 21 of file VuoInputEditorWithDialog.cc.
◆ supportsTabbingBetweenPorts()
|
virtual |
Returns false.
Reimplemented from VuoInputEditor.
Definition at line 76 of file VuoCommentEditor.cc.
The documentation for this class was generated from the following files:
- editor/VuoCommentEditor.hh
- editor/VuoCommentEditor.cc
