Console::Console Class Reference

Inheritance diagram for Console::Console:

List of all members.

Public Member Functions
def	__getitem__
def	__init__
def	__setitem__
def	autoindent
def	cb_back
def	cb_backspace
def	cb_cleanup
def	cb_complete
def	cb_ctrlhome
def	cb_forward
def	cb_help
def	cb_home
def	cb_nothing
def	cb_paste
def	cb_position
def	cb_return
def	cb_select
def	cb_space
def	compile
def	config
def	cursor
def	getline
def	postmenus
def	precontext
def	recall
def	run
def	runline
def	trim
def	unpostmenus
def	write
Public Attributes
	compfinish
	compindex
	compmenus
	continuation
	current
	dict
	dicts
	error
	history
	historyindex
	intraceback
	options
	pasted
	prefixes
	scroll
	startup
	stderr
	stdout
	text

---

Member Function Documentation

def Console::Console::__getitem__	(		self,
			key
	)

def Console::Console::__init__	(		self,
			parent = None,
			dict = {},
			options
	)

Construct from a parent widget, an optional dictionary to use
as the namespace for execution, and any configuration options.

def Console::Console::__setitem__	(		self,
			key,
			value
	)

def Console::Console::autoindent	(		self,
			command
	)

def Console::Console::cb_back	(		self,
			event
	)

Step back in the history.

def Console::Console::cb_backspace	(		self,
			event
	)

def Console::Console::cb_cleanup	(		self,
			event = None
	)

def Console::Console::cb_complete	(		self,
			event
	)

Attempt to complete the identifier currently being typed.

def Console::Console::cb_ctrlhome	(		self,
			event
	)

Go to the beginning of the line just after the prompt.

def Console::Console::cb_forward	(		self,
			event
	)

Step forward in the history.

def Console::Console::cb_help	(		self,
			event
	)

def Console::Console::cb_home	(		self,
			event
	)

Go to the first non-whitespace character in the line.

def Console::Console::cb_nothing	(		self,
			event
	)

def Console::Console::cb_paste	(		self,
			event
	)

Handle a paste event (middle-click) in the text box.  Pasted
text has any leading Python prompts stripped (at last!!).

def Console::Console::cb_position	(		self,
			event
	)

Avoid moving into the prompt area.

def Console::Console::cb_return	(		self,
			event,
			doindent = 1
	)

Handle a <Return> keystroke by running from the current line
and generating a new prompt.

def Console::Console::cb_select	(		self,
			event
	)

Handle a menu selection event.  We have to check and invoke the
completion menus manually because we are grabbing events to give the
text box keyboard focus.

def Console::Console::cb_space	(		self,
			event
	)

def Console::Console::compile	(		self,
			source
	)

Try to compile a piece of source code, returning a status code
and the compiled result.  If the status code is "okay" the code is
complete and compiled successfully; if it is "more" then the code
can be compiled, but an interactive session should wait for more
input; if it is "bad" then there is a syntax error in the code and
the second returned value is the error message.

def Console::Console::config	(		self,
			args,
			dict
	)

Get or set configuration options in a Tkinter-like style.

def Console::Console::cursor

(

self

)

Get the current line and position of the cursor.

def Console::Console::getline	(		self,
			line = None,
			trim = 0
	)

Return the command on the current line.

def Console::Console::postmenus	(		self,
			keys,
			skip,
			cut,
			object
	)

Post a series of menus listing all the given keys, given the
length of the existing part so we can position the menus under the
cursor, and the index at which to insert the completion.

def Console::Console::precontext

(

self

)

def Console::Console::recall	(		self,
			command = None
	)

Show a command from the history on the current line.

def Console::Console::run	(		self,
			code
	)

Run a code object within the sandbox for this console.  The
sandbox redirects stdout and stderr to the console, and executes
within the namespace associated with the console.

def Console::Console::runline	(		self,
			line
	)

Run some source code given the number of the last line in the
text box.  Scan backwards to get the entire piece of code to run
if the line is a continuation of previous lines.  Tag the compiled
code so that it can be highlighted according to whether it is
complete, incomplete, or illegal.

def Console::Console::trim	(		self,
			command
	)

Trim any matching prefix from the given command line, returning
the amount trimmed and the trimmed result.

def Console::Console::unpostmenus

(

self

)

Unpost the completion menus.

def Console::Console::write	(		self,
			data,
			tag = None
	)

Show output from stdout or stderr in the console.

---

Member Data Documentation

Console::Console::compfinish

Console::Console::compindex

Console::Console::compmenus

Console::Console::continuation

Console::Console::current

Console::Console::dict

Console::Console::dicts

Console::Console::error

Console::Console::history

Console::Console::historyindex

Console::Console::intraceback

Console::Console::options

Console::Console::pasted

Console::Console::prefixes

Console::Console::scroll

Console::Console::startup

Console::Console::stderr

Console::Console::stdout

Console::Console::text

---

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

• Base/GUI/Python/Console.py