View Source wxAuiNotebookEvent (wx v2.4.3)
This class is used by the events generated by wxAuiNotebook.
See:
This class is derived, and can use functions, from:
wxWidgets docs: wxAuiNotebookEvent
Events
Use wxEvtHandler:connect/3 with wxAuiNotebookEventType to subscribe to events of this type.
Summary
Functions
Returns the page that was selected before the change, wxNOT\_FOUND if none was
selected.
Returns the currently selected page, or wxNOT\_FOUND if none was selected.
Sets the id of the page selected before the change.
Sets the selection member variable.
Types
-type wxAuiNotebook() :: #wxAuiNotebook{type :: wxAuiNotebookEvent:wxAuiNotebookEventType(), old_selection :: integer(), selection :: integer(), drag_source :: wxAuiNotebook:wxAuiNotebook()}.
-type wxAuiNotebookEvent() :: wx:wx_object().
-type wxAuiNotebookEventType() ::
command_auinotebook_page_close | command_auinotebook_page_changed |
command_auinotebook_page_changing | command_auinotebook_button |
command_auinotebook_begin_drag | command_auinotebook_end_drag |
command_auinotebook_drag_motion | command_auinotebook_allow_dnd |
command_auinotebook_tab_middle_down | command_auinotebook_tab_middle_up |
command_auinotebook_tab_right_down | command_auinotebook_tab_right_up |
command_auinotebook_page_closed | command_auinotebook_drag_done |
command_auinotebook_bg_dclick.
Functions
-spec getDragSource(This) -> wxAuiNotebook:wxAuiNotebook() when This :: wxAuiNotebookEvent().
-spec getOldSelection(This) -> integer() when This :: wxAuiNotebookEvent().
Returns the page that was selected before the change, wxNOT\_FOUND if none was
selected.
-spec getSelection(This) -> integer() when This :: wxAuiNotebookEvent().
Returns the currently selected page, or wxNOT\_FOUND if none was selected.
Note: under Windows, getSelection/1 will return the same value as getOldSelection/1 when called from the EVT_BOOKCTRL_PAGE_CHANGING
handler and not the page which is going to be selected.
-spec setDragSource(This, S) -> ok when This :: wxAuiNotebookEvent(), S :: wxAuiNotebook:wxAuiNotebook().
-spec setOldSelection(This, Page) -> ok when This :: wxAuiNotebookEvent(), Page :: integer().
Sets the id of the page selected before the change.
-spec setSelection(This, Page) -> ok when This :: wxAuiNotebookEvent(), Page :: integer().
Sets the selection member variable.