A generic interactive console dialog used primarily by funnel plugins (e.g., Lua). More...

Inheritance diagram for IOConsoleDialog:

Public Member Functions
	IOConsoleDialog (QWidget &parent, QString title, funnel_console_eval_cb_t eval_cb, funnel_console_open_cb_t open_cb, funnel_console_close_cb_t close_cb, void *callback_data)
	Constructs a new IOConsoleDialog.

	~IOConsoleDialog ()
	Destroys the IOConsoleDialog.

void	appendOutputText (const QString &text)
	Appends text to the console's output area.

void	setHintText (const QString &text)
	Sets the hint text displayed near the input area.

void	clearHintText ()
	Clears the currently displayed hint text.

Public Member Functions inherited from GeometryStateDialog
	GeometryStateDialog (QWidget *parent, Qt::WindowFlags f=Qt::Window)
	Constructs a new GeometryStateDialog with the specified parent and window flags.

	~GeometryStateDialog ()
	Save the geometry and splitter state and then destroy the GeometryStateDialog.

void	setWindowModality (Qt::WindowModality windowModality)
	Sets the window modality for the dialog. On non-macOS platforms, this also sets the parent to ensure modal dialogs are always on top of their parent.

Additional Inherited Members
Protected Member Functions inherited from GeometryStateDialog
void	loadGeometry (int width=0, int height=0, const QString &dialog_name=QString())
	Loads the geometry and splitter state for the dialog.

void	loadSplitterState (QSplitter *splitter=nullptr)
	Loads the state of a splitter for the dialog.

Detailed Description

A generic interactive console dialog used primarily by funnel plugins (e.g., Lua).

Constructor & Destructor Documentation

IOConsoleDialog::IOConsoleDialog	(	QWidget &	parent,
		QString	title,
		funnel_console_eval_cb_t	eval_cb,
		funnel_console_open_cb_t	open_cb,
		funnel_console_close_cb_t	close_cb,
		void *	callback_data = `nullptr`
	)

explicit

Constructs a new IOConsoleDialog.

Parameters

parent	The parent widget.
title	The title of the console window.
eval_cb	The callback function used to evaluate text input from the user.
open_cb	The callback function executed when the console is successfully opened.
close_cb	The callback function executed when the console is closed.
callback_data	User data passed to the callback functions.

void IOConsoleDialog::appendOutputText ( const QString & text )

Appends text to the console's output area.

Parameters

text	The text string to append.

void IOConsoleDialog::setHintText ( const QString & text )

Sets the hint text displayed near the input area.

Parameters

text	The hint text string.

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