AGW Logo

agw_title CommandNotebookEvent

A specialized command event class for events sent by AuiNotebook .

hierarchy Inheritance Diagram

Inheritance diagram for: CommandNotebookEvent

Inheritance diagram of CommandNotebookEvent


method_summary Methods Summary

__init__Default class constructor.
GetDispatchedReturns whether the event was dispatched (used for automatic AuiNotebook ).
GetDragSourceReturns the drag and drop source.
GetLabelReturns the label-itemtext (for EVT_AUINOTEBOOK_BEGIN | END_LABEL_EDIT only).
GetOldSelectionReturns the page that was selected before the change, or -1 if none was
GetSelectionReturns the currently selected page, or -1 if none was selected.
IsEditCancelledReturns the edit cancel flag (for EVT_AUINOTEBOOK_BEGIN | END_LABEL_EDIT only).
SetDispatchedSets the event as dispatched (used for automatic AuiNotebook ).
SetDragSourceSets the drag and drop source.
SetEditCanceledSets the edit cancel flag (for EVT_AUINOTEBOOK_BEGIN | END_LABEL_EDIT only).
SetLabelSets the label.
SetOldSelectionSets the id of the page selected before the change.
SetSelectionSets the selection member variable.

API Class API

class CommandNotebookEvent(wx.PyCommandEvent)[source]

A specialized command event class for events sent by AuiNotebook .



__init__(command_type=None, win_id=0)[source]

Default class constructor.

Parameters:
  • command_type – the event kind or an instance of wx.PyCommandEvent.
  • win_id – the window identification number.


GetDispatched()[source]

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



GetDragSource()[source]

Returns the drag and drop source.



GetLabel()[source]

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



GetOldSelection()[source]

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



GetSelection()[source]

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



IsEditCancelled()[source]

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



Page


Selection


SetDispatched(b)[source]

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

Parameters:b – whether the event was dispatched or not.


SetDragSource(s)[source]

Sets the drag and drop source.

Parameters:s – the drag source.


SetEditCanceled(editCancelled)[source]

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

Parameters:editCancelled – whether the editing action has been cancelled or not.


SetLabel(label)[source]

Sets the label. Useful only for EVT_AUINOTEBOOK_END_LABEL_EDIT.

Parameters:label – the new label.


SetOldSelection(s)[source]

Sets the id of the page selected before the change.

Parameters:s – the old selection.


SetSelection(s)[source]

Sets the selection member variable.

Parameters:s – the new selection.
Tree

Table Of Contents

Previous topic

AuiTabCtrl

Next topic

TabFrame