frontend.wx.console_widget — IPython v0.10 documentation

### Navigation

- index
- modules |
- next |
- previous |
- IPython v0.10 documentation »
- The IPython API »

# frontend.wx.console_widget

## Module: `frontend.wx.console_widget`

Inheritance diagram for `IPython.frontend.wx.console_widget`:

A Wx widget to act as a console and input commands.

This widget deals with prompts and provides an edit buffer restricted to after the last prompt.

## `ConsoleWidget`

class `IPython.frontend.wx.console_widget.` `ConsoleWidget`(parent, id=-1, pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=262144)

  Bases: `wx.py.editwindow.EditWindow`

  Specialized styled text control view for console-like workflow.

  This widget is mainly interested in dealing with the prompt and keeping the cursor inside the editing line.

  `__init__`(parent, id=-1, pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=262144)
  `OnUpdateUI`(event)
    Override the OnUpdateUI of the EditWindow class, to prevent syntax highlighting both for faster redraw, and for more consistent look and feel.
  `configure_scintilla`()
    Set up all the styling option of the embedded scintilla widget.
  `continuation_prompt`()
    Returns the current continuation prompt. We need to implement this method here to deal with the ascii escape sequences cleaning up.
  `get_line_width`()
    Return the width of the line in characters.
  `input_buffer`
    Returns the text in current edit buffer.
  `new_prompt`(prompt)

    Prints a prompt at start of line, and move the start of the current block there.

    The prompt can be given with ascii escape sequences.

  `pop_completion`(possibilities, offset=0)
    Pops up an autocompletion menu. Offset is the offset in characters of the position at which the menu should appear, relativ to the cursor.
  `scroll_to_bottom`()
  `write`(text, refresh=True)
    Write given text to buffer, while translating the ansi escape sequences.

### Navigation

- index
- modules |
- next |
- previous |
- IPython v0.10 documentation »
- The IPython API »