Description

A base class for input editors that display a frameless dialog.

Public Member Functions
json_object *	show (QPoint portLeftCenter, json_object originalValue, json_object details, map< QString, json_object * > portNamesAndValues)
	Displays a frameless dialog.

Public Member Functions inherited from VuoInputEditor
virtual bool	supportsTabbingBetweenPorts (void)
	Returns true if this input editor should be part of the Vuo Editor's tab order when using Tab / Shift-Tab to navigate between input ports.

Protected Member Functions
	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.

virtual void	setUpDialog (QDialog &dialog, json_object originalValue, json_object details)=0
	Adds widgets to the dialog and configures them to display the dialog's initial value.

virtual json_object *	getAcceptedValue (void)=0
	Returns the value currently set in the dialog's widgets.

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

VuoInputEditorWithDialog::VuoInputEditorWithDialog ( void )

protected

Creates an input editor whose show() function displays a frameless dialog.

bool VuoInputEditorWithDialog::eventFilter	(	QObject *	object,
		QEvent *	event
	)

protected

Handles tabbing past the last widget or reverse-tabbing past the first widget in the tab order.

virtual json_object* VuoInputEditorWithDialog::getAcceptedValue ( void )

protectedpure virtual

Returns the value currently set in the dialog's widgets.

QDialog * VuoInputEditorWithDialog::getDialog ( void )

protected

Returns a pointer to the dialog displayed by show().

This pointer is only valid during a call to show().

void VuoInputEditorWithDialog::setFirstWidgetInTabOrder ( QWidget * widget )

protected

Makes the given widget the first in this input editor's tab order.

This function sets up the input editor to emit tabbedBackwardPastFirstWidget() signals.

void VuoInputEditorWithDialog::setLastWidgetInTabOrder ( QWidget * widget )

protected

Makes the given widget the last in this input editor's tab order.

This function sets up the input editor to emit tabbedPastLastWidget() signals.

virtual void VuoInputEditorWithDialog::setUpDialog	(	QDialog &	dialog,
		json_object *	originalValue,
		json_object *	details
	)

protectedpure virtual

Adds widgets to the dialog and configures them to display the dialog's initial value.

Parameters

dialog	The dialog, which is initially empty. It has a style sheet that makes the dialog and any widgets added to it default to a standard style, which depends on the Vuo Editor's "Dark Interface" setting. If changing fonts of widgest, you may need to use `QWidget::setStyleSheet()` instead of `QWidget::setFont()`, since the latter may have no effect (http://doc.qt.io/qt-5/qwidget.html#font-prop).
originalValue	The value to display initially in the dialog.
details	Additional details (e.g., suggested min. and max. values) pertaining to the port data.

json_object * VuoInputEditorWithDialog::show	(	QPoint	portLeftCenter,
		json_object *	originalValue,
		json_object *	details,
		map< QString, json_object * >	portNamesAndValues
	)

virtual

Displays a frameless dialog.

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