Package matplotlib :: Package backends :: Module backend_wx :: Class FigureCanvasWx
[show private | hide private]
[frames | no frames]

Class FigureCanvasWx

           FigureCanvasBase --+
                              |
wxObjectPtr --+               |
              |               |
wxEvtHandlerPtr --+           |
                  |           |
        wxWindowPtr --+       |
                      |       |
             wxPanelPtr --+   |
                          |   |
                    wxPanel --+
                              |
                             FigureCanvasWx

Known Subclasses:
FigureCanvasWxAgg

The FigureCanvas contains the figure and does event handling.

In the wxPython backend, it is derived from wxPanel, and (usually) lives inside a frame instantiated by a FigureManagerWx. The parent window probably implements a wx.Sizer to control the displayed control size - but we give a hint as to our preferred minimum size.
Method Summary
  __init__(self, parent, id, figure)
Initialise a FigureWx instance.
  _get_imagesave_wildcards(self)
return the wildcard string for the filesave dialog
  _get_key(self, evt)
  _onKeyDown(self, evt)
Capture key press.
  _onKeyUp(self, evt)
Release key.
  _onLeftButtonDown(self, evt)
Start measuring on an axis.
  _onLeftButtonUp(self, evt)
End measuring on an axis.
  _onMotion(self, evt)
Start measuring on an axis.
  _onMouseWheel(self, evt)
  _onPaint(self, evt)
Called when wxPaintEvt is generated
  _onRightButtonDown(self, evt)
Start measuring on an axis.
  _onRightButtonUp(self, evt)
End measuring on an axis.
  _onSize(self, evt)
Called when wxEventSize is generated.
  Copy_to_Clipboard(self, event)
copy bitmap of canvas to system clipboard
  Destroy(self, *args, **kwargs)
  draw(self)
Render the figure using RendererWx instance renderer, or using a previously defined renderer if none is specified.
  gui_repaint(self)
Performs update of the displayed image on the GUI canvas
  print_figure(self, filename, dpi, facecolor, edgecolor, orientation)
Render the figure to hardcopy
  Printer_Init(self)
initialize printer settings using wx methods
  Printer_Preview(self, event)
generate Print Preview with wx Print mechanism
  Printer_Print(self, event)
Print figure using wx Print mechanism
  Printer_Setup(self, event)
set up figure for printing.
  Printer_Setup2(self, event)
set up figure for printing.
  realize(self)
This method will be called when the system is ready to draw, eg when a GUI window is realized
    Inherited from FigureCanvasBase
  blit(self, bbox)
blit the canvas in bbox (default entire canvas)
  button_press_event(self, x, y, button, guiEvent)
Backend derived classes should call this function on any mouse button press.
  button_release_event(self, x, y, button, guiEvent)
Backend derived classes should call this function on any mouse button release.
  draw_cursor(self, event)
Draw a cursor in the event.axes if inaxes is not None.
  draw_event(self, renderer)
  draw_idle(self, *args, **kwargs)
draw only if idle; defaults to draw but backends can overrride
  get_width_height(self)
return the figure width and height in points or pixels (depending on the backend), truncated to integers
  key_press_event(self, key, guiEvent)
  key_release_event(self, key, guiEvent)
  motion_notify_event(self, x, y, guiEvent)
Backend derived classes should call this function on any motion-notify-event.
  mpl_connect(self, s, func)
Connect event with string s to func.
  mpl_disconnect(self, cid)
Connect s to func.
  switch_backends(self, FigureCanvasClass)
instantiate an instance of FigureCanvasClass
    Inherited from wxPanelPtr
  __repr__(self)
  Create(self, *_args, **_kwargs)
  InitDialog(self, *_args, **_kwargs)
    Inherited from wxWindowPtr
  AcceptsFocus(self, *_args, **_kwargs)
  AddChild(self, *_args, **_kwargs)
  CaptureMouse(self, *_args, **_kwargs)
  Center(self, *_args, **_kwargs)
  CenterOnParent(self, *_args, **_kwargs)
  CenterOnScreen(self, *_args, **_kwargs)
  Centre(self, *_args, **_kwargs)
  CentreOnParent(self, *_args, **_kwargs)
  CentreOnScreen(self, *_args, **_kwargs)
  Clear(self, *_args, **_kwargs)
  ClientToScreen(self, *_args, **_kwargs)
  ClientToScreenXY(self, *_args, **_kwargs)
  Close(self, *_args, **_kwargs)
  ConvertDialogPointToPixels(self, *_args, **_kwargs)
  ConvertDialogSizeToPixels(self, *_args, **_kwargs)
  ConvertPixelPointToDialog(self, *_args, **_kwargs)
  ConvertPixelSizeToDialog(self, *_args, **_kwargs)
  DestroyChildren(self, *_args, **_kwargs)
  Disable(self, *_args, **_kwargs)
  DLG_PNT(self, *_args, **_kwargs)
  DLG_SZE(self, *_args, **_kwargs)
  Enable(self, *_args, **_kwargs)
  FindWindowById(self, *_args, **_kwargs)
  FindWindowByName(self, *_args, **_kwargs)
  Fit(self, *_args, **_kwargs)
  FitInside(self, *_args, **_kwargs)
  Freeze(self, *_args, **_kwargs)
  GetAcceleratorTable(self, *_args, **_kwargs)
  GetAdjustedBestSize(self, *_args, **_kwargs)
  GetAutoLayout(self, *_args, **_kwargs)
  GetBackgroundColour(self, *_args, **_kwargs)
  GetBestSize(self, *_args, **_kwargs)
  GetBestVirtualSize(self, *_args, **_kwargs)
  GetBorder(self, *_args, **_kwargs)
  GetCaret(self, *_args, **_kwargs)
  GetCharHeight(self, *_args, **_kwargs)
  GetCharWidth(self, *_args, **_kwargs)
  GetChildren(self, *_args, **_kwargs)
  GetClientAreaOrigin(self, *_args, **_kwargs)
  GetClientRect(self, *_args, **_kwargs)
  GetClientSize(self, *_args, **_kwargs)
  GetClientSizeTuple(self, *_args, **_kwargs)
  GetConstraints(self, *_args, **_kwargs)
  GetContainingSizer(self, *_args, **_kwargs)
  GetCursor(self, *_args, **_kwargs)
  GetDefaultItem(self, *_args, **_kwargs)
  GetDropTarget(self, *_args, **_kwargs)
  GetEventHandler(self, *_args, **_kwargs)
  GetFont(self, *_args, **_kwargs)
  GetForegroundColour(self, *_args, **_kwargs)
  GetFullTextExtent(self, *_args, **_kwargs)
  GetGrandParent(self, *_args, **_kwargs)
  GetHandle(self, *_args, **_kwargs)
  GetHelpText(self, *_args, **_kwargs)
  GetId(self, *_args, **_kwargs)
  GetLabel(self, *_args, **_kwargs)
  GetMaxSize(self, *_args, **_kwargs)
  GetName(self, *_args, **_kwargs)
  GetParent(self, *_args, **_kwargs)
  GetPosition(self, *_args, **_kwargs)
  GetPositionTuple(self, *_args, **_kwargs)
  GetRect(self, *_args, **_kwargs)
  GetScrollPos(self, *_args, **_kwargs)
  GetScrollRange(self, *_args, **_kwargs)
  GetScrollThumb(self, *_args, **_kwargs)
  GetSize(self, *_args, **_kwargs)
  GetSizer(self, *_args, **_kwargs)
  GetSizeTuple(self, *_args, **_kwargs)
  GetTextExtent(self, *_args, **_kwargs)
  GetThemeEnabled(self, *_args, **_kwargs)
  GetTitle(self, *_args, **_kwargs)
  GetToolTip(self, *_args, **_kwargs)
  GetUpdateRegion(self, *_args, **_kwargs)
  GetValidator(self, *_args, **_kwargs)
  GetVirtualSize(self, *_args, **_kwargs)
  GetVirtualSizeTuple(self, *_args, **_kwargs)
  GetWindowStyleFlag(self, *_args, **_kwargs)
  HasCapture(self, *_args, **_kwargs)
  HasScrollbar(self, *_args, **_kwargs)
  Hide(self, *_args, **_kwargs)
  HitTest(self, *_args, **_kwargs)
  IsBeingDeleted(self, *_args, **_kwargs)
  IsEnabled(self, *_args, **_kwargs)
  IsExposed(self, *_args, **_kwargs)
  IsExposedPoint(self, *_args, **_kwargs)
  IsExposedRect(self, *_args, **_kwargs)
  IsRetained(self, *_args, **_kwargs)
  IsShown(self, *_args, **_kwargs)
  IsTopLevel(self, *_args, **_kwargs)
  Layout(self, *_args, **_kwargs)
  LineDown(self, *_args, **_kwargs)
  LineUp(self, *_args, **_kwargs)
  Lower(self, *_args, **_kwargs)
  MakeModal(self, *_args, **_kwargs)
  Move(self, *_args, **_kwargs)
  MoveXY(self, *_args, **_kwargs)
  PageDown(self, *_args, **_kwargs)
  PageUp(self, *_args, **_kwargs)
  PopEventHandler(self, *_args, **_kwargs)
  PopupMenu(self, *_args, **_kwargs)
  PopupMenuXY(self, *_args, **_kwargs)
  PushEventHandler(self, *_args, **_kwargs)
  Raise(self, *_args, **_kwargs)
  Refresh(self, *_args, **_kwargs)
  RefreshRect(self, *_args, **_kwargs)
  ReleaseMouse(self, *_args, **_kwargs)
  RemoveChild(self, *_args, **_kwargs)
  RemoveEventHandler(self, *_args, **_kwargs)
  Reparent(self, *_args, **_kwargs)
  ScreenToClient(self, *_args, **_kwargs)
  ScreenToClientXY(self, *_args, **_kwargs)
  ScrollLines(self, *_args, **_kwargs)
  ScrollPages(self, *_args, **_kwargs)
  ScrollWindow(self, *_args, **_kwargs)
  SetAcceleratorTable(self, *_args, **_kwargs)
  SetAutoLayout(self, *_args, **_kwargs)
  SetBackgroundColour(self, *_args, **_kwargs)
  SetCaret(self, *_args, **_kwargs)
  SetClientSize(self, *_args, **_kwargs)
  SetClientSizeWH(self, *_args, **_kwargs)
  SetConstraints(self, *_args, **_kwargs)
  SetContainingSizer(self, *_args, **_kwargs)
  SetCursor(self, *_args, **_kwargs)
  SetDefaultItem(self, *_args, **_kwargs)
  SetDimensions(self, *_args, **_kwargs)
  SetDropTarget(self, *_args, **_kwargs)
  SetEventHandler(self, *_args, **_kwargs)
  SetExtraStyle(self, *_args, **_kwargs)
  SetFocus(self, *_args, **_kwargs)
  SetFocusFromKbd(self, *_args, **_kwargs)
  SetFont(self, *_args, **_kwargs)
  SetForegroundColour(self, *_args, **_kwargs)
  SetHelpText(self, *_args, **_kwargs)
  SetHelpTextForId(self, *_args, **_kwargs)
  SetId(self, *_args, **_kwargs)
  SetLabel(self, *_args, **_kwargs)
  SetName(self, *_args, **_kwargs)
  SetPosition(self, *_args, **_kwargs)
  SetRect(self, *_args, **_kwargs)
  SetScrollbar(self, *_args, **_kwargs)
  SetScrollPos(self, *_args, **_kwargs)
  SetSize(self, *_args, **_kwargs)
  SetSizeHints(self, *_args, **_kwargs)
  SetSizer(self, *_args, **_kwargs)
  SetSizerAndFit(self, *_args, **_kwargs)
  SetThemeEnabled(self, *_args, **_kwargs)
  SetTitle(self, *_args, **_kwargs)
  SetTmpDefaultItem(self, *_args, **_kwargs)
  SetToolTip(self, *_args, **_kwargs)
  SetToolTipString(self, *_args, **_kwargs)
  SetValidator(self, *_args, **_kwargs)
  SetVirtualSize(self, *_args, **_kwargs)
  SetVirtualSizeHints(self, *_args, **_kwargs)
  SetVirtualSizeWH(self, *_args, **_kwargs)
  SetWindowStyle(self, *_args, **_kwargs)
  SetWindowStyleFlag(self, *_args, **_kwargs)
  Show(self, *_args, **_kwargs)
  Thaw(self, *_args, **_kwargs)
  TransferDataFromWindow(self, *_args, **_kwargs)
  TransferDataToWindow(self, *_args, **_kwargs)
  UnsetConstraints(self, *_args, **_kwargs)
  Update(self, *_args, **_kwargs)
  UpdateWindowUI(self, *_args, **_kwargs)
  Validate(self, *_args, **_kwargs)
  WarpPointer(self, *_args, **_kwargs)
    Inherited from wxEvtHandlerPtr
  AddPendingEvent(self, *_args, **_kwargs)
  Connect(self, *_args, **_kwargs)
  Disconnect(self, *_args, **_kwargs)
  GetEvtHandlerEnabled(self, *_args, **_kwargs)
  GetNextHandler(self, *_args, **_kwargs)
  GetPreviousHandler(self, *_args, **_kwargs)
  ProcessEvent(self, *_args, **_kwargs)
  SetEvtHandlerEnabled(self, *_args, **_kwargs)
  SetNextHandler(self, *_args, **_kwargs)
  SetPreviousHandler(self, *_args, **_kwargs)
  _setOORInfo(self, *_args, **_kwargs)
    Inherited from wxObjectPtr
  GetClassName(self, *_args, **_kwargs)

Class Variable Summary
dict keyvald = {306: 'shift', 307: 'alt', 308: 'control', 316...
    Inherited from FigureCanvasBase
tuple events = ('key_press_event', 'key_release_event', 'butto...

Method Details

__init__(self, parent, id, figure)
(Constructor)

Initialise a FigureWx instance.

- Initialise the FigureCanvasBase and wxPanel parents.
- Set event handlers for:
  EVT_SIZE  (Resize event)
  EVT_PAINT (Paint event)
Overrides:
matplotlib.backend_bases.FigureCanvasBase.__init__

_get_imagesave_wildcards(self)

return the wildcard string for the filesave dialog

_onKeyDown(self, evt)

Capture key press.

_onKeyUp(self, evt)

Release key.

_onLeftButtonDown(self, evt)

Start measuring on an axis.

_onLeftButtonUp(self, evt)

End measuring on an axis.

_onMotion(self, evt)

Start measuring on an axis.

_onPaint(self, evt)

Called when wxPaintEvt is generated

_onRightButtonDown(self, evt)

Start measuring on an axis.

_onRightButtonUp(self, evt)

End measuring on an axis.

_onSize(self, evt)

Called when wxEventSize is generated.

In this application we attempt to resize to fit the window, so it is better to take the performance hit and redraw the whole window.

Copy_to_Clipboard(self, event=None)

copy bitmap of canvas to system clipboard

draw(self)

Render the figure using RendererWx instance renderer, or using a previously defined renderer if none is specified.
Overrides:
matplotlib.backend_bases.FigureCanvasBase.draw

gui_repaint(self)

Performs update of the displayed image on the GUI canvas

MUST NOT be called during a Paint event

print_figure(self, filename, dpi=150, facecolor='w', edgecolor='w', orientation='portrait')

Render the figure to hardcopy
Overrides:
matplotlib.backend_bases.FigureCanvasBase.print_figure

Printer_Init(self)

initialize printer settings using wx methods

Printer_Preview(self, event=None)

generate Print Preview with wx Print mechanism

Printer_Print(self, event=None)

Print figure using wx Print mechanism

Printer_Setup(self, event=None)

set up figure for printing. The standard wx Printer Setup Dialog seems to die easily. Therefore, this setup simply asks for image width and margin for printing.

Printer_Setup2(self, event=None)

set up figure for printing. Using the standard wx Printer Setup Dialog.

realize(self)

This method will be called when the system is ready to draw, eg when a GUI window is realized

Class Variable Details

keyvald

Type:
dict
Value:
{306: 'shift',
 307: 'alt',
 308: 'control',
 316: 'left',
 317: 'up',
 318: 'right',
 319: 'down'}                                                          

Generated by Epydoc 2.1 on Mon Aug 28 13:47:49 2006 http://epydoc.sf.net