docs/latex/wx/auinotebook.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % auibook.h at 11/Nov/06 22:56:01
   4 %
   5
   6 \section{\class{wxAuiNotebook}}\label{wxauinotebook}
   7
   8 wxAuiNotebook is a notebook control which implements many features common in applications with dockable panes.
   9 Specifically, wxAuiNotebook implements functionality which allows the user to rearrange tab order via drag-and-drop,
  10 split the tab window into many different splitter configurations, and toggle through different themes to customize
  11 the control's look and feel.
  12
  13 An effort has been made to try to maintain an API as similar to that of wxNotebook.
  14
  15 The default theme that is used is wxAuiDefaultTabArt, which provides a modern, glossy look and feel.
  16 The theme can be changed by calling \helpref{wxAuiNotebook::SetArtProvider}{wxauinotebooksetartprovider}.
  17
  18 \wxheading{Derived from}
  19
  20 \helpref{wxControl}{wxcontrol}
  21
  22 \wxheading{Include files}
  23
  24 <wx/aui/auibook.h>
  25
  26 \wxheading{Data structures}
  27
  28 \latexignore{\rtfignore{\wxheading{Members}}}
  29
  30 \membersection{wxAuiNotebook::wxAuiNotebook}\label{wxauinotebookwxauinotebook}
  31
  32 \func{}{wxAuiNotebook}{\void}
  33
  34 \func{}{wxAuiNotebook}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxAUI\_NB\_DEFAULT\_STYLE}}
  35
  36 Constructor. Creates a wxAuiNotebok control.
  37
  38 \membersection{wxAuiNotebook::AddPage}\label{wxauinotebookaddpage}
  39
  40 \func{bool}{AddPage}{\param{wxWindow* }{page}, \param{const wxString\& }{caption}, \param{bool }{select = false}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}}
  41
  42 Adds a page.
  43
  44 \membersection{wxAuiNotebook::Create}\label{wxauinotebookcreate}
  45
  46 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}}
  47
  48 Creates the notebook window.
  49
  50 \membersection{wxAuiNotebook::DeletePage}\label{wxauinotebookdeletepage}
  51
  52 \func{bool}{DeletePage}{\param{size\_t }{page}}
  53
  54 Deletes a page at the given index.
  55
  56 \membersection{wxAuiNotebook::FindTab}\label{wxauinotebookfindtab}
  57
  58 \func{bool}{FindTab}{\param{wxWindow* }{page}, \param{wxAuiTabCtrl** }{ctrl}, \param{int* }{idx}}
  59
  60 Finds a tab.
  61
  62 \membersection{wxAuiNotebook::GetActiveTabCtrl}\label{wxauinotebookgetactivetabctrl}
  63
  64 \func{wxAuiTabCtrl*}{GetActiveTabCtrl}{\void}
  65
  66 Returns the active tab.
  67
  68 \membersection{wxAuiNotebook::GetArtProvider}\label{wxauinotebookgetartprovider}
  69
  70 \constfunc{wxAuiTabArt*}{GetArtProvider}{\void}
  71
  72 Returns the associated art provider.
  73
  74 \membersection{wxAuiNotebook::GetPage}\label{wxauinotebookgetpage}
  75
  76 \constfunc{wxWindow*}{GetPage}{\param{size\_t }{page\_idx}}
  77
  78 Returns the page specified by the given index.
  79
  80 \membersection{wxAuiNotebook::GetPageCount}\label{wxauinotebookgetpagecount}
  81
  82 \constfunc{size\_t}{GetPageCount}{\void}
  83
  84 Returns the number of pages.
  85
  86 \membersection{wxAuiNotebook::GetPageIndex}\label{wxauinotebookgetpageindex}
  87
  88 \constfunc{int}{GetPageIndex}{\param{wxWindow* }{page\_wnd}}
  89
  90 Reurns the page index for the given window.
  91
  92 \membersection{wxAuiNotebook::GetSelection}\label{wxauinotebookgetselection}
  93
  94 \constfunc{int}{GetSelection}{\void}
  95
  96 Returns the currently selected page.
  97
  98 \membersection{wxAuiNotebook::InsertPage}\label{wxauinotebookinsertpage}
  99
 100 \func{bool}{InsertPage}{\param{size\_t }{page\_idx}, \param{wxWindow* }{page}, \param{const wxString\& }{caption}, \param{bool }{select = false}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}}
 101
 102 Inserts a page.
 103
 104 \membersection{wxAuiNotebook::RemovePage}\label{wxauinotebookremovepage}
 105
 106 \func{bool}{RemovePage}{\param{size\_t }{page}}
 107
 108 Removes a page.
 109
 110 \membersection{wxAuiNotebook::SetArtProvider}\label{wxauinotebooksetartprovider}
 111
 112 \func{void}{SetArtProvider}{\param{wxAuiTabArt* }{art}}
 113
 114 Sets the art provider to be used by the notebook.
 115
 116 \membersection{wxAuiNotebook::SetPageBitmap}\label{wxauinotebooksetpagebitmap}
 117
 118 \func{bool}{SetPageBitmap}{\param{size\_t }{page}, \param{const wxBitmap\& }{bitmap}}
 119
 120 Sets the bitmap for the page.
 121
 122 \membersection{wxAuiNotebook::SetPageText}\label{wxauinotebooksetpagetext}
 123
 124 \func{bool}{SetPageText}{\param{size\_t }{page}, \param{const wxString\& }{text}}
 125
 126 Sets the ab label for the page.
 127
 128 \membersection{wxAuiNotebook::SetSelection}\label{wxauinotebooksetselection}
 129
 130 \func{size\_t}{SetSelection}{\param{size\_t }{new\_page}}
 131
 132 Sets the page selection.
 133
 134 \membersection{wxAuiNotebook::SetTabCtrlHeight}\label{wxauinotebooksettabctrlheight}
 135
 136 \func{void}{SetTabCtrlHeight}{\param{int }{height}}
 137
 138 Sets the tab height.
 139