te::qt::widgets::IOWidget Class Reference

#include <IOWidget.h>

Inheritance diagram for te::qt::widgets::IOWidget:

Public Slots
void	addPrompt ()
	addPrompt Adds the prompt to the text edit and unlocks the widget for input
void	append (QString text)
	append Appends the given text to the text edit and locks the widget for input

Signals
void	command (QString command)
	command Signal emitted when input is entered.

Public Member Functions
	IOWidget (QWidget *parent=0)
QString	prompt () const
	prompt Retrieves the current prompt.
void	setPrompt (const QString &prompt)
	setPrompt Sets a new prompt from a given string.

Protected Member Functions
void	keyPressEvent (QKeyEvent *e)

Private Member Functions
void	clearLine ()
	clearLine Clears the line under the cursor.
QString	getCommand () const
	getCommand Gets the input from the user.
int	getIndex (const QTextCursor &cursor)
	getIndex Gets the index of a given cursor.
void	handleEnter ()
	handleEnter Handles Enter and Return key press.
void	handleHome ()
	handleHome Handles Home key press.
void	handleLeft (QKeyEvent *event)
	handleLeft Handles Left arrow key press.
bool	isWritable (const QTextCursor &cursor)
	isWritable Checks if a given cursor is at a writable position.

Private Attributes
int	lastIndex
	lastIndex The index of the last character.
bool	locked
	locked False if the text edit can receive input, true otherwise.
QString	userPrompt
	userPrompt prompt to indicate that the text edit is waiting for input

Detailed Description

Definition at line 46 of file IOWidget.h.

Constructor & Destructor Documentation

IOWidget()

te::qt::widgets::IOWidget::IOWidget

(

QWidget *

parent = 0

)

Member Function Documentation

addPrompt

void te::qt::widgets::IOWidget::addPrompt ( )

slot

addPrompt Adds the prompt to the text edit and unlocks the widget for input

append

void te::qt::widgets::IOWidget::append ( QString  text )

slot

append Appends the given text to the text edit and locks the widget for input

Parameters

text	String to be appended

clearLine()

void te::qt::widgets::IOWidget::clearLine ( )

private

clearLine Clears the line under the cursor.

command

void te::qt::widgets::IOWidget::command ( QString  command )

signal

command Signal emitted when input is entered.

Parameters

command

String to be emitted.

getCommand()

QString te::qt::widgets::IOWidget::getCommand ( ) const

private

getCommand Gets the input from the user.

getIndex()

int te::qt::widgets::IOWidget::getIndex ( const QTextCursor &  cursor )

private

getIndex Gets the index of a given cursor.

Parameters

cursor

Cursor used to retrieve the index.

handleEnter()

void te::qt::widgets::IOWidget::handleEnter ( )

private

handleEnter Handles Enter and Return key press.

handleHome()

void te::qt::widgets::IOWidget::handleHome ( )

private

handleHome Handles Home key press.

handleLeft()

void te::qt::widgets::IOWidget::handleLeft ( QKeyEvent *  event )

private

handleLeft Handles Left arrow key press.

Parameters

event

The received event.

isWritable()

bool te::qt::widgets::IOWidget::isWritable ( const QTextCursor &  cursor )

private

isWritable Checks if a given cursor is at a writable position.

Parameters

cursor

Cursor that will be checked.

keyPressEvent()

void te::qt::widgets::IOWidget::keyPressEvent ( QKeyEvent *  e )

protected

prompt()

QString te::qt::widgets::IOWidget::prompt

(

)

const

prompt Retrieves the current prompt.

setPrompt()

void te::qt::widgets::IOWidget::setPrompt

(

const QString &

prompt

)

setPrompt Sets a new prompt from a given string.

Parameters

prompt

String of the new prompt

Member Data Documentation

lastIndex

int te::qt::widgets::IOWidget::lastIndex

private

lastIndex The index of the last character.

Definition at line 121 of file IOWidget.h.

locked

bool te::qt::widgets::IOWidget::locked

private

locked False if the text edit can receive input, true otherwise.

Definition at line 116 of file IOWidget.h.

userPrompt

QString te::qt::widgets::IOWidget::userPrompt

private

userPrompt prompt to indicate that the text edit is waiting for input

Definition at line 110 of file IOWidget.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/qt/widgets/ceditor/IOWidget.h