wx.lib.agw.aui.auibook.CommandNotebookEvent

A specialized command event class for events sent by AuiNotebook .

Class Hierarchy

Inheritance diagram for class CommandNotebookEvent:

Known Subclasses

wx.lib.agw.aui.auibook.AuiNotebookEvent

Known Superclasses

wx.PyCommandEvent

Methods Summary

__init__	Default class constructor.
GetDispatched	Returns whether the event was dispatched (used for automatic AuiNotebook ).
GetDragSource	Returns the drag and drop source.
GetLabel	Returns the label-itemtext (for EVT_AUINOTEBOOK_BEGIN | END_LABEL_EDIT only).
GetOldSelection	Returns the page that was selected before the change, or -1 if none was
GetSelection	Returns the currently selected page, or -1 if none was selected.
IsEditCancelled	Returns the edit cancel flag (for EVT_AUINOTEBOOK_BEGIN | END_LABEL_EDIT only).
SetDispatched	Sets the event as dispatched (used for automatic AuiNotebook ).
SetDragSource	Sets the drag and drop source.
SetEditCanceled	Sets the edit cancel flag (for EVT_AUINOTEBOOK_BEGIN | END_LABEL_EDIT only).
SetLabel	Sets the label. Useful only for EVT_AUINOTEBOOK_END_LABEL_EDIT.
SetOldSelection	Sets the id of the page selected before the change.
SetSelection	Sets the selection member variable.

Properties Summary

Page
Selection	GetSelection() -> int

Class API

class CommandNotebookEvent(wx.PyCommandEvent)

A specialized command event class for events sent by AuiNotebook .

Methods

__init__(self, command_type=None, win_id=0)

Default class constructor.

Parameters:

• command_type – the event kind or an instance of PyCommandEvent.

• win_id (integer) – the window identification number.

---

GetDispatched(self)

Returns whether the event was dispatched (used for automatic AuiNotebook ).

---

GetDragSource(self)

Returns the drag and drop source.

---

GetLabel(self)

Returns the label-itemtext (for EVT_AUINOTEBOOK_BEGIN | END_LABEL_EDIT only).

---

GetOldSelection(self)

Returns the page that was selected before the change, or -1 if none was selected.

---

GetSelection(self)

Returns the currently selected page, or -1 if none was selected.

---

IsEditCancelled(self)

Returns the edit cancel flag (for EVT_AUINOTEBOOK_BEGIN | END_LABEL_EDIT only).

---

SetDispatched(self, b)

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

Parameters:

b – whether the event was dispatched or not.

---

SetDragSource(self, s)

Sets the drag and drop source.

Parameters:

s – the drag source.

---

SetEditCanceled(self, editCancelled)

Sets the edit cancel flag (for EVT_AUINOTEBOOK_BEGIN | END_LABEL_EDIT only).

Parameters:

editCancelled (bool) – whether the editing action has been cancelled or not.

---

SetLabel(self, label)

Sets the label. Useful only for EVT_AUINOTEBOOK_END_LABEL_EDIT.

Parameters:

label (string) – the new label.

---

SetOldSelection(self, s)

Sets the id of the page selected before the change.

Parameters:

s (integer) – the old selection.

---

SetSelection(self, s)

Sets the selection member variable.

Parameters:

s (integer) – the new selection.

Properties

Selection

GetSelection() -> int

Returns item index for a listbox or choice selection event (not valid for a deselection).