Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxAuiNotebookEvent (3erl)

Name

wxAuiNotebookEvent - Functions for wxAuiNotebookEvent class

Synopsis

Please see following description for synopsis

Description

wxAuiNotebookEvent(3)      Erlang Module Definition      wxAuiNotebookEvent(3)



NAME
       wxAuiNotebookEvent - Functions for wxAuiNotebookEvent class

DESCRIPTION
       This class is used by the events generated by wxAuiNotebook.

       See: wxAuiNotebook, wxBookCtrlEvent

       This  class  is  derived  (and can use functions) from: wxBookCtrlEvent
       wxNotifyEvent wxCommandEvent wxEvent

       wxWidgets docs: wxAuiNotebookEvent

EVENTS
       Use wxEvtHandler:connect/3 with wxAuiNotebookEventType to subscribe  to
       events of this type.

DATA TYPES
       wxAuiNotebookEvent() = wx:wx_object()

       wxAuiNotebook() =
           #wxAuiNotebook{type =
                              wxAuiNotebookEvent:wxAuiNotebookEventType(),
                          old_selection = integer(),
                          selection = integer(),
                          drag_source = wxAuiNotebook:wxAuiNotebook()}

       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

EXPORTS
       setSelection(This, Page) -> ok

              Types:

                 This = wxAuiNotebookEvent()
                 Page = integer()

              Sets the selection member variable.

       getSelection(This) -> integer()

              Types:

                 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_BOOKC-
              TRL_PAGE_CHANGING handler and not the page which is going to  be
              selected.

       setOldSelection(This, Page) -> ok

              Types:

                 This = wxAuiNotebookEvent()
                 Page = integer()

              Sets the id of the page selected before the change.

       getOldSelection(This) -> integer()

              Types:

                 This = wxAuiNotebookEvent()

              Returns   the   page   that  was  selected  before  the  change,
              wxNOT_FOUND if none was selected.

       setDragSource(This, S) -> ok

              Types:

                 This = wxAuiNotebookEvent()
                 S = wxAuiNotebook:wxAuiNotebook()

       getDragSource(This) -> wxAuiNotebook:wxAuiNotebook()

              Types:

                 This = wxAuiNotebookEvent()



wxWidgets team.                    wx 2.1.1              wxAuiNotebookEvent(3)