A Discrete-Event Network Simulator
API
visualizer.ipython_view.ConsoleView Class Reference

ConsoleView class. More...

+ Inheritance diagram for visualizer.ipython_view.ConsoleView:
+ Collaboration diagram for visualizer.ipython_view.ConsoleView:

Public Member Functions

def __init__ (self)
 
def changeLine (self, text)
 Replace currently entered command line with given text. More...
 
def getCurrentLine (self)
 Get text in current command line. More...
 
def onKeyPress (self, widget, event)
 Key press callback used for correcting behavior for console-like interfaces. More...
 
def onKeyPressExtend (self, event)
 For some reason we can't extend onKeyPress directly (bug #500900). More...
 
def showPrompt (self, prompt)
 Prints prompt at start of line. More...
 
def showReturned (self, text)
 Show returned text from last command and print new prompt. More...
 
def write (self, text, editable=False)
 Write given text to buffer. More...
 

Public Attributes

 color_pat
 color pattern More...
 
 line_start
 line start More...
 
 mark
 scroll mark More...
 
 text_buffer
 text buffer More...
 

Static Public Attributes

dictionary ANSI_COLORS
 color list More...
 

Private Member Functions

def _changeLine (self, text)
 Replace currently entered command line with given text. More...
 
def _showPrompt (self, prompt)
 Prints prompt at start of line. More...
 
def _showReturned (self, text)
 Show returned text from last command and print new prompt. More...
 
def _write (self, text, editable=False)
 Write given text to buffer. More...
 

Detailed Description

ConsoleView class.

Definition at line 333 of file ipython_view.py.

Constructor & Destructor Documentation

◆ __init__()

def visualizer.ipython_view.ConsoleView.__init__ (   self)
Initialize console view.

Reimplemented in visualizer.ipython_view.IPythonView.

Definition at line 368 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView.text_buffer.

Member Function Documentation

◆ _changeLine()

def visualizer.ipython_view.ConsoleView._changeLine (   self,
  text 
)
private

Replace currently entered command line with given text.

Parameters
textText to use as replacement.
Returns
none

Definition at line 459 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._write(), delete, visualizer.ipython_view.ConsoleView.line_start, and visualizer.ipython_view.ConsoleView.text_buffer.

Referenced by visualizer.ipython_view.ConsoleView.changeLine().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _showPrompt()

def visualizer.ipython_view.ConsoleView._showPrompt (   self,
  prompt 
)
private

Prints prompt at start of line.

Parameters
promptPrompt to print.
Returns
none

Definition at line 439 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._write(), visualizer.ipython_view.ConsoleView.line_start, and visualizer.ipython_view.ConsoleView.text_buffer.

Referenced by visualizer.ipython_view.ConsoleView._showReturned(), and visualizer.ipython_view.ConsoleView.showPrompt().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _showReturned()

def visualizer.ipython_view.ConsoleView._showReturned (   self,
  text 
)
private

Show returned text from last command and print new prompt.

Parameters
textText to show.
Returns
none

Definition at line 491 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._showPrompt(), visualizer.ipython_view.ConsoleView._write(), visualizer.ipython_view.IterableIPShell.IP, visualizer.ipython_view.ConsoleView.line_start, visualizer.ipython_view.IterableIPShell.prompt, visualizer.ipython_view.IPythonView.prompt, and visualizer.ipython_view.ConsoleView.text_buffer.

Referenced by visualizer.ipython_view.ConsoleView.showReturned().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ _write()

def visualizer.ipython_view.ConsoleView._write (   self,
  text,
  editable = False 
)
private

◆ changeLine()

def visualizer.ipython_view.ConsoleView.changeLine (   self,
  text 
)

Replace currently entered command line with given text.

Parameters
textText to use as replacement.
Returns
none

Definition at line 450 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._changeLine().

Referenced by visualizer.ipython_view.IPythonView.onKeyPressExtend().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getCurrentLine()

def visualizer.ipython_view.ConsoleView.getCurrentLine (   self)

Get text in current command line.

Returns
Text of current command line.

Definition at line 471 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView.line_start, and visualizer.ipython_view.ConsoleView.text_buffer.

Referenced by visualizer.ipython_view.IPythonView.onKeyPressExtend(), and visualizer.ipython_view.IPythonView.raw_input().

+ Here is the caller graph for this function:

◆ onKeyPress()

def visualizer.ipython_view.ConsoleView.onKeyPress (   self,
  widget,
  event 
)

Key press callback used for correcting behavior for console-like interfaces.

For example 'home' should go to prompt, not to beginning of line.

Parameters
widgetWidget that key press accored in.
eventEvent object
Returns
Return True if event should not trickle.

Definition at line 515 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView.line_start, visualizer.ipython_view.ConsoleView.onKeyPressExtend(), visualizer.ipython_view.IPythonView.onKeyPressExtend(), and visualizer.ipython_view.ConsoleView.text_buffer.

+ Here is the call graph for this function:

◆ onKeyPressExtend()

def visualizer.ipython_view.ConsoleView.onKeyPressExtend (   self,
  event 
)

For some reason we can't extend onKeyPress directly (bug #500900).

Parameters
eventkey press
Returns
none

Reimplemented in visualizer.ipython_view.IPythonView.

Definition at line 558 of file ipython_view.py.

Referenced by visualizer.ipython_view.ConsoleView.onKeyPress().

+ Here is the caller graph for this function:

◆ showPrompt()

def visualizer.ipython_view.ConsoleView.showPrompt (   self,
  prompt 
)

Prints prompt at start of line.

Parameters
promptPrompt to print.
Returns
none

Definition at line 430 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._showPrompt().

Referenced by visualizer.ipython_view.IPythonView.onKeyPressExtend().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ showReturned()

def visualizer.ipython_view.ConsoleView.showReturned (   self,
  text 
)

Show returned text from last command and print new prompt.

Parameters
textText to show.
Returns
none

Definition at line 482 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._showReturned().

+ Here is the call graph for this function:

◆ write()

def visualizer.ipython_view.ConsoleView.write (   self,
  text,
  editable = False 
)

Write given text to buffer.

Parameters
textText to append.
editableIf true, added text is editable.
Returns
none

Definition at line 391 of file ipython_view.py.

References visualizer.ipython_view.ConsoleView._write().

Referenced by visualizer.ipython_view.IPythonView.onKeyPressExtend().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ ANSI_COLORS

visualizer.ipython_view.ConsoleView.ANSI_COLORS
static
Initial value:
= {'0;30': 'Black', '0;31': 'Red',
'0;32': 'Green', '0;33': 'Brown',
'0;34': 'Blue', '0;35': 'Purple',
'0;36': 'Cyan', '0;37': 'LightGray',
'1;30': 'DarkGray', '1;31': 'DarkRed',
'1;32': 'SeaGreen', '1;33': 'Yellow',
'1;34': 'LightBlue', '1;35': 'MediumPurple',
'1;36': 'LightCyan', '1;37': 'White'}

color list

Definition at line 359 of file ipython_view.py.

◆ color_pat

visualizer.ipython_view.ConsoleView.color_pat

color pattern

Definition at line 385 of file ipython_view.py.

Referenced by visualizer.ipython_view.ConsoleView._write().

◆ line_start

◆ mark

visualizer.ipython_view.ConsoleView.mark

scroll mark

Definition at line 376 of file ipython_view.py.

Referenced by visualizer.ipython_view.ConsoleView._write().

◆ text_buffer


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