Version: 3.3.0
auibook.h File Reference

Classes

struct  wxAuiNotebookPosition
 Simple struct combining wxAuiTabCtrl with the position inside it. More...
 
class  wxAuiNotebook
 wxAuiNotebook is part of the wxAUI class framework, which represents a notebook control, managing multiple windows with associated tabs. More...
 
class  wxAuiNotebookPage
 Holds information about a page in wxAuiNotebook. More...
 
class  wxAuiNotebookPageArray
 A vector of AUI notebook pages. More...
 
class  wxAuiTabContainerButton
 A simple class which holds information about wxAuiNotebook tab buttons and their state. More...
 
class  wxAuiTabContainerButtonArray
 A vector of AUI tab buttons. More...
 
class  wxAuiTabContainer
 wxAuiTabContainer is a class which contains information about each tab. More...
 
struct  wxAuiTabContainer::HitTestResult
 
class  wxAuiTabArt
 Tab art provider defines all the drawing functions used by wxAuiNotebook. More...
 
class  wxAuiNotebookEvent
 This class is used by the events generated by wxAuiNotebook. More...
 
class  wxAuiFlatTabArt
 An art provider for wxAuiNotebook implementing "flat" look. More...
 
class  wxAuiGenericTabArt
 An art provider for wxAuiNotebook implementing "glossy" look. More...
 
class  wxAuiSimpleTabArt
 Another standard tab art provider for wxAuiNotebook. More...
 

Typedefs

using wxAuiNativeTabArt = wxAuiGenericTabArt
 wxAuiNativeTabArt is an alias for either the art provider providing native-like appearance or wxAuiGenericTabArt if not available. More...
 
using wxAuiDefaultTabArt = wxAuiFlatTabArt
 wxAuiDefaultTabArt is an alias for the tab art provider used by wxAuiNotebook by default. More...
 

Enumerations

enum  wxAuiNotebookOption {
  wxAUI_NB_TOP = 1 << 0 ,
  wxAUI_NB_LEFT = 1 << 1 ,
  wxAUI_NB_RIGHT = 1 << 2 ,
  wxAUI_NB_BOTTOM = 1 << 3 ,
  wxAUI_NB_TAB_SPLIT = 1 << 4 ,
  wxAUI_NB_TAB_MOVE = 1 << 5 ,
  wxAUI_NB_TAB_EXTERNAL_MOVE = 1 << 6 ,
  wxAUI_NB_TAB_FIXED_WIDTH = 1 << 7 ,
  wxAUI_NB_SCROLL_BUTTONS = 1 << 8 ,
  wxAUI_NB_WINDOWLIST_BUTTON = 1 << 9 ,
  wxAUI_NB_CLOSE_BUTTON = 1 << 10 ,
  wxAUI_NB_CLOSE_ON_ACTIVE_TAB = 1 << 11 ,
  wxAUI_NB_CLOSE_ON_ALL_TABS = 1 << 12 ,
  wxAUI_NB_MIDDLE_CLICK_CLOSE = 1 << 13 ,
  wxAUI_NB_MULTILINE = 1 << 14 ,
  wxAUI_NB_PIN_ON_ACTIVE_TAB = 1 << 15 ,
  wxAUI_NB_UNPIN_ON_ALL_PINNED = 1 << 16 ,
  wxAUI_NB_DEFAULT_STYLE
}
 
enum class  wxAuiTabKind {
  Normal ,
  Pinned ,
  Locked
}
 Tab kind for wxAuiNotebook pages. More...
 

Variables

wxEventType wxEVT_AUINOTEBOOK_PAGE_CLOSE
 
wxEventType wxEVT_AUINOTEBOOK_PAGE_CHANGED
 
wxEventType wxEVT_AUINOTEBOOK_PAGE_CHANGING
 
wxEventType wxEVT_AUINOTEBOOK_PAGE_CLOSED
 
wxEventType wxEVT_AUINOTEBOOK_BUTTON
 
wxEventType wxEVT_AUINOTEBOOK_BEGIN_DRAG
 
wxEventType wxEVT_AUINOTEBOOK_END_DRAG
 
wxEventType wxEVT_AUINOTEBOOK_DRAG_MOTION
 
wxEventType wxEVT_AUINOTEBOOK_ALLOW_DND
 
wxEventType wxEVT_AUINOTEBOOK_TAB_MIDDLE_DOWN
 
wxEventType wxEVT_AUINOTEBOOK_TAB_MIDDLE_UP
 
wxEventType wxEVT_AUINOTEBOOK_TAB_RIGHT_DOWN
 
wxEventType wxEVT_AUINOTEBOOK_TAB_RIGHT_UP
 
wxEventType wxEVT_AUINOTEBOOK_DRAG_DONE
 
wxEventType wxEVT_AUINOTEBOOK_BG_DCLICK
 

Typedef Documentation

◆ wxAuiDefaultTabArt

wxAuiDefaultTabArt is an alias for the tab art provider used by wxAuiNotebook by default.

Since wxWidgets 3.3.0, this is wxAuiFlatTabArt under all platforms. In the previous versions, this was wxAuiNativeTabArt.

Enumeration Type Documentation

◆ wxAuiNotebookOption

Enumerator
wxAUI_NB_TOP 
wxAUI_NB_LEFT 
wxAUI_NB_RIGHT 
wxAUI_NB_BOTTOM 
wxAUI_NB_TAB_SPLIT 
wxAUI_NB_TAB_MOVE 
wxAUI_NB_TAB_EXTERNAL_MOVE 
wxAUI_NB_TAB_FIXED_WIDTH 
wxAUI_NB_SCROLL_BUTTONS 
wxAUI_NB_WINDOWLIST_BUTTON 
wxAUI_NB_CLOSE_BUTTON 
wxAUI_NB_CLOSE_ON_ACTIVE_TAB 
wxAUI_NB_CLOSE_ON_ALL_TABS 
wxAUI_NB_MIDDLE_CLICK_CLOSE 
wxAUI_NB_MULTILINE 
Since
3.3.0
wxAUI_NB_PIN_ON_ACTIVE_TAB 

Allow the user to pin tabs by using the pin button.

With this style, the active page shows either a "pin" icon allowing to pin it if it it's currently not pinned or an "unpin" icon if it is already pinned. Note that "unpin" icon may be shown even if this style is not specified, but wxAUI_NB_UNPIN_ON_ALL_PINNED is.

Note that if this style is not specified, tabs can still be pinned programmatically using SetPageKind().

Since
3.3.0
wxAUI_NB_UNPIN_ON_ALL_PINNED 

Allow the user to unpin pinned tabs by using the unpin button.

Specifying this style shows "unpin" button on all currently pinned tabs, allowing the user to unpin them, i.e. make them normal again.

This style can be combined with wxAUI_NB_PIN_ON_ACTIVE_TAB or used on its own.

Since
3.3.0
wxAUI_NB_DEFAULT_STYLE 

◆ wxAuiTabKind

enum wxAuiTabKind
strong

Tab kind for wxAuiNotebook pages.

See wxAuiNotebook::SetTabKind().

Since
3.3.0
Enumerator
Normal 

Can be closed and dragged by user.

Pinned 

Can be closed and possibly unpinned by user.

Locked 

Can't be closed, dragged nor unlocked by user.

Variable Documentation

◆ wxEVT_AUINOTEBOOK_ALLOW_DND

wxEventType wxEVT_AUINOTEBOOK_ALLOW_DND

◆ wxEVT_AUINOTEBOOK_BEGIN_DRAG

wxEventType wxEVT_AUINOTEBOOK_BEGIN_DRAG

◆ wxEVT_AUINOTEBOOK_BG_DCLICK

wxEventType wxEVT_AUINOTEBOOK_BG_DCLICK

◆ wxEVT_AUINOTEBOOK_BUTTON

wxEventType wxEVT_AUINOTEBOOK_BUTTON

◆ wxEVT_AUINOTEBOOK_DRAG_DONE

wxEventType wxEVT_AUINOTEBOOK_DRAG_DONE

◆ wxEVT_AUINOTEBOOK_DRAG_MOTION

wxEventType wxEVT_AUINOTEBOOK_DRAG_MOTION

◆ wxEVT_AUINOTEBOOK_END_DRAG

wxEventType wxEVT_AUINOTEBOOK_END_DRAG

◆ wxEVT_AUINOTEBOOK_PAGE_CHANGED

wxEventType wxEVT_AUINOTEBOOK_PAGE_CHANGED

◆ wxEVT_AUINOTEBOOK_PAGE_CHANGING

wxEventType wxEVT_AUINOTEBOOK_PAGE_CHANGING

◆ wxEVT_AUINOTEBOOK_PAGE_CLOSE

wxEventType wxEVT_AUINOTEBOOK_PAGE_CLOSE

◆ wxEVT_AUINOTEBOOK_PAGE_CLOSED

wxEventType wxEVT_AUINOTEBOOK_PAGE_CLOSED

◆ wxEVT_AUINOTEBOOK_TAB_MIDDLE_DOWN

wxEventType wxEVT_AUINOTEBOOK_TAB_MIDDLE_DOWN

◆ wxEVT_AUINOTEBOOK_TAB_MIDDLE_UP

wxEventType wxEVT_AUINOTEBOOK_TAB_MIDDLE_UP

◆ wxEVT_AUINOTEBOOK_TAB_RIGHT_DOWN

wxEventType wxEVT_AUINOTEBOOK_TAB_RIGHT_DOWN

◆ wxEVT_AUINOTEBOOK_TAB_RIGHT_UP

wxEventType wxEVT_AUINOTEBOOK_TAB_RIGHT_UP