Python command line interpreter front-end GUI widget. More...

#include <PyConsole_Editor.h>

Inheritance diagram for PyConsole_Editor:

Public Slots
void	cut ()
	"Copy" operation.
void	paste ()
	"Paste" operation.
void	clear ()
	"Clear" operation.
void	handleReturn ()
	Process "Enter" key press event.
void	onPyInterpChanged (PyConsole_Interp *)
	Handle Python interpreter change.
void	dump ()
	"Dump commands" operation.
Public Member Functions
	PyConsole_Editor (PyConsole_Interp theInterp, QWidget theParent=0)
	Constructor.
	~PyConsole_Editor ()
	Destructor.
virtual void	addText (const QString &str, const bool newBlock=false)
	Put the string str to the python editor.
bool	isCommand (const QString &str) const
	Check if the string is command.
virtual void	exec (const QString &command)
	Convenient method for executing a Python command, as if the user typed it manually.
void	execAndWait (const QString &command)
	Execute command in the python interpreter and wait until it is finished.
bool	isSync () const
	Get synchronous mode flag value.
void	setIsSync (const bool)
	Set synchronous mode flag value.
bool	isSuppressOutput () const
	Get suppress output flag value.
void	setIsSuppressOutput (const bool)
	Set suppress output flag value.
bool	isShowBanner () const
	Get 'show banner' flag value.
void	setIsShowBanner (const bool)
	Set 'show banner' flag value.
virtual QSize	sizeHint () const
	Get size hint for the Python console window.
Protected Member Functions
virtual void	dropEvent (QDropEvent *event)
	Process drop event.
virtual void	mouseReleaseEvent (QMouseEvent *event)
	Process mouse button release event.
virtual void	keyPressEvent (QKeyEvent *event)
	Handle keyboard event.
virtual void	customEvent (QEvent *event)
	Handle notification event coming from Python dispatcher.
virtual PyInterp_Request *	createRequest (const QString &)
	Create request to the python dispatcher for the command execution.
Private Attributes
PyConsole_Interp *	myInterp
	python interpreter
QString	myCommandBuffer
	python command buffer
QString	myCurrentCommand
	currently being printed command
QString	myPrompt
	current command line prompt
int	myCmdInHistory
	current history command index
QStringList	myHistory
	commands history buffer
QEventLoop *	myEventLoop
	internal event loop
QString	myBanner
	current banner
bool	myShowBanner
	'show banner' flag
QStringList	myQueue
	python commands queue
bool	myIsSync
	synchronous mode flag
bool	myIsSuppressOutput
	suppress output flag

Detailed Description

This class provides simple GUI interface to the Python interpreter, including basic navigation operations, executing commands (both interactively and programmatically), copy-paste operations, history of the commands and so on.

Here below is the shortcut keyboard boundings used for navigation and other operations:

<Enter> : execute current command
<Ctrl><Break> : clear current command
<Escape> : clear current command
<Up> : previous command in the history
<Shift><Up> : move cursor one row up with selection
<Ctrl><Up> : move cursor one row up without selection
<Ctrl><Shift><Up> : move cursor one row up with selection
<Down> : next command in the history
<Shift><Down> : move cursor one row down with selection
<Ctrl><Down> : move cursor one row down without selection
<Ctrl><Shift><Down> : move cursor one row down with selection
<Left> : move one symbol left without selection
<Shift><Left> : move one symbol left with selection
<Ctrl><Left> : move one word left without selection
<Ctrl><Shift><Left> : move one word left with selection
<Right> : move one symbol right without selection
<Shift><Right> : move one symbol right with selection
<Ctrl><Right> : move one word right without selection
<Ctrl><Shift><Right> : move one word right with selection
<PgUp> : first command in the history
<Shift><PgUp> : move one page up with selection
<Ctrl><PgUp> : move one page up without selection
<Ctrl><Shift><PgUp> : scroll one page up
<PgDn> : last command in the history
<Shift><PgDn> : move one page down with selection
<Ctrl><PgDn> : move one page down without selection
<Ctrl><Shift><PgDn> : scroll one page down
<Home> : move to the beginning of the line without selection
<Shift><Home> : move to the beginning of the line with selection
<Ctrl><Home> : move to the very first symbol without selection
<Ctrl><Shift><Home> : move to the very first symbol with selection
<End> : move to the end of the line without selection
<Shift><End> : move to the end of the line with selection
<Ctrl><End> : move to the very last symbol without selection
<Ctrl><Shift><End> : move to the very last symbol with selection
<Backspace> : delete symbol before the cursor / remove selected text and put it to the clipboard (cut)
<Shift><Backspace> : delete previous word / remove selected text and put it to the clipboard (cut)
<Ctrl><Backspace> : delete text from the cursor to the beginning of the line / remove selected text and put it to the clipboard (cut)
<Delete> : delete symbol after the cursor / remove selected text and put it to the clipboard (cut)
<Shift><Delete> : delete next word / remove selected text and put it to the clipboard (cut)
<Ctrl><Delete> : delete text from the cursor to the end of the line / remove selected text and put it to the clipboard (cut)
<Ctrl><Insert> : copy
<Shift><Insert> : paste
<Ctrl><V> : paste
<Ctrl> : copy
<Ctrl><X> : cut
<Ctrl><V> : paste

TODO:



paste multiline text: process each line as separate command (including mouse middle-button click pasting)
the same for drag-n-drop of multiline text

Constructor & Destructor Documentation

PyConsole_Editor::PyConsole_Editor	(	PyConsole_Interp *	theInterp,
		QWidget *	theParent = `0`
	)

Creates python editor window.

Parameters:

theInterp	python interper
theParent	parent widget

References myPrompt, onPyInterpChanged(), READY_PROMPT, PyInterp_Interp.setverrcb(), PyInterp_Interp.setvoutcb(), staticCallback(), and SUIT_Tools.stringToFont().

PyConsole_Editor::~PyConsole_Editor ( )

Does nothing for the moment.

Member Function Documentation

void PyConsole_Editor::addText	(	const QString &	str,
		const bool	newBlock = `false`
	)		`[virtual]`

Parameters:

str	string to be put in the command line of the editor
newBlock	if True, then the string is printed on a new line

bool PyConsole_Editor::isCommand ( const QString & str ) const

Return True if the string str is likely to be the command (i.e. it is started from the '>>>' or '...').

Parameters:

str	string to be checked

References DOTS_PROMPT, and READY_PROMPT.

void PyConsole_Editor::exec ( const QString & command ) [virtual]

Parameters:

command python command to be executed

References addText(), TestSalomeApp.command, createRequest(), DOTS_PROMPT, PyInterp_Dispatcher.Exec(), PyInterp_Dispatcher.Get(), myCmdInHistory, myCommandBuffer, myHistory, myPrompt, myQueue, and READY_PROMPT.

void PyConsole_Editor::execAndWait ( const QString & command )

Parameters:

command python command to be executed

References exec(), and myEventLoop.

bool PyConsole_Editor::isSync ( ) const

See also:: setIsSync()

Returns:: True if python console works in synchronous mode

References myIsSync.

void PyConsole_Editor::setIsSync ( const bool on )

In synhronous mode the Python commands are executed in the GUI thread and the GUI is blocked until the command is finished. In the asynchronous mode each Python command is executed in the separate thread that does not block the main GUI loop.

Parameters: