auibook.CommandNotebookEvent

Inheritance diagram for CommandNotebookEvent:


digraph inheritance33b49f0126 {
rankdir=LR;
size="8.0, 12.0";
  "wx._core.Event" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
  "wx._core.Object" -> "wx._core.Event" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "wx._core.PyCommandEvent" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
  "wx._core.CommandEvent" -> "wx._core.PyCommandEvent" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "wx._core.Object" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
  "wx._core.CommandEvent" [shape=box,style="setlinewidth(0.5)",fontsize=10,fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25];
  "wx._core.Event" -> "wx._core.CommandEvent" [arrowsize=0.5,style="setlinewidth(0.5)"];
  "auibook.CommandNotebookEvent" [style="setlinewidth(0.5)",URL="#auibook.CommandNotebookEvent",fontname=Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans,height=0.25,shape=box,fontsize=10];
  "wx._core.PyCommandEvent" -> "auibook.CommandNotebookEvent" [arrowsize=0.5,style="setlinewidth(0.5)"];
}


Description

A specialized command event class for events sent by L{AuiNotebook}.

Class API

Methods

class CommandNotebookEvent(command_type=None, win_id=0)

Bases: wx._core.PyCommandEvent

A specialized command event class for events sent by L{AuiNotebook}.

__init__()

Default class constructor.

Parameters:
  • command_type – the event kind or an instance of L{wx.PyCommandEvent}.
  • win_id – the window identification number.
Clone()

Returns a copy of the event.

Any event that is posted to the wxPython event system for later action (via L{wx.EvtHandler.AddPendingEvent} or L{wx.PostEvent}) must implement this method. All wxPython events fully implement this method, but any derived events implemented by the user should also implement this method just in case they (or some event derived from them) are ever posted.

All wxPython events implement a copy constructor, so the easiest way of implementing the Clone function is to implement a copy constructor for a new event (call it MyEvent) and then define the Clone function like this:

def Clone(self):
    return MyEvent(self)
GetDispatched()
Returns whether the event was dispatched (used for automatic AuiNotebooks).
GetDragSource()
Returns the drag and drop source.
GetOldSelection()
Returns the page that was selected before the change, or -1 if none was selected.
GetSelection()
Returns the currently selected page, or -1 if none was selected.
SetDispatched(b)

Sets the event as dispatched (used for automatic AuiNotebooks).

Parameter:b – whether the event was dispatched or not.
SetDragSource(s)

Sets the drag and drop source.

Parameter:s – the drag source.
SetOldSelection(s)

Sets the id of the page selected before the change.

Parameter:s – the old selection.
SetSelection(s)

Sets the selection member variable.

Parameter:s – the new selection.

Table Of Contents

This Page