pqConsoleWidget Class Reference

Qt widget that provides an interactive console - you can send text to the console by calling printString() and receive user input by connecting to the executeCommand() slot. More...

#include <pqConsoleWidget.h>

List of all members.

Public Slots
void	printString (const QString &Text)
	Writes the supplied text to the console.
void	printCommand (const QString &cmd)
	Updates the current command.
void	clear ()
	Clears the contents of the console.
void	prompt (const QString &text)
	Puts out an input accepting prompt.
void	insertCompletion (const QString &text)
	Inserts the given completion string at the cursor.
Signals
void	executeCommand (const QString &Command)
	Signal emitted whenever the user enters a command.
Public Member Functions
	pqConsoleWidget (QWidget *Parent)
virtual	~pqConsoleWidget ()
QTextCharFormat	getFormat ()
	Returns the current formatting that will be used by printString.
void	setFormat (const QTextCharFormat &Format)
	Sets formatting that will be used by printString.
void	setCompleter (pqConsoleWidgetCompleter *completer)
	Set a completer for this console widget.
QPoint	getCursorPosition ()
Friends
class	pqImplementation

---

Detailed Description

Qt widget that provides an interactive console - you can send text to the console by calling printString() and receive user input by connecting to the executeCommand() slot.

See also:

pqPythonShell, pqOutputWindow

Definition at line 51 of file pqConsoleWidget.h.

---

Constructor & Destructor Documentation

pqConsoleWidget::pqConsoleWidget

(

QWidget *

Parent

)

virtual pqConsoleWidget::~pqConsoleWidget

(

)

[virtual]

---

Member Function Documentation

QTextCharFormat pqConsoleWidget::getFormat

(

)

Returns the current formatting that will be used by printString.

void pqConsoleWidget::setFormat

(

const QTextCharFormat &

Format

)

Sets formatting that will be used by printString.

void pqConsoleWidget::setCompleter

(

pqConsoleWidgetCompleter *

completer

)

Set a completer for this console widget.

QPoint pqConsoleWidget::getCursorPosition

(

)

void pqConsoleWidget::executeCommand

(

const QString &

Command

)

[signal]

Signal emitted whenever the user enters a command.

void pqConsoleWidget::printString

(

const QString &

Text

)

[slot]

Writes the supplied text to the console.

void pqConsoleWidget::printCommand

(

const QString &

cmd

)

[slot]

Updates the current command.

Unlike printString, this will affect the current command being typed.

void pqConsoleWidget::clear

(

)

[slot]

Clears the contents of the console.

void pqConsoleWidget::prompt

(

const QString &

text

)

[slot]

Puts out an input accepting prompt.

It is recommended that one uses prompt instead of printString() to print an input prompt since this call ensures that the prompt is shown on a new line.

void pqConsoleWidget::insertCompletion

(

const QString &

text

)

[slot]

Inserts the given completion string at the cursor.

This will replace the current word that the cursor is touching with the given text. Determines the word using QTextCursor::StartOfWord, EndOfWord.

---

Friends And Related Function Documentation

friend class pqImplementation [friend]

Definition at line 104 of file pqConsoleWidget.h.

---

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

• /home/kitware/Dashboards/My Tests/ParaView/Qt/Widgets/pqConsoleWidget.h