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 wxAuiPaneInfo is part of the wxAUI class framework.
   9 See also \helpref{wxAUI overview}{wxauioverview}.
  10
  11 wxAuiNotebook is a notebook control which implements many features common in applications with dockable panes.
  12 Specifically, wxAuiNotebook implements functionality which allows the user to rearrange tab order via drag-and-drop,
  13 split the tab window into many different splitter configurations, and toggle through different themes to customize
  14 the control's look and feel.
  15
  16 An effort has been made to try to maintain an API as similar to that of wxNotebook.
  17
  18 The default theme that is used is wxAuiDefaultTabArt, which provides a modern, glossy look and feel.
  19 The theme can be changed by calling \helpref{wxAuiNotebook::SetArtProvider}{wxauinotebooksetartprovider}.
  20
  21 \wxheading{Derived from}
  22
  23 \helpref{wxControl}{wxcontrol}
  24
  25 \wxheading{Include files}
  26
  27 <wx/aui/auibook.h>
  28
  29 \wxheading{Data structures}
  30
  31 \latexignore{\rtfignore{\wxheading{Members}}}
  32
  33 \membersection{wxAuiNotebook::wxAuiNotebook}\label{wxauinotebookwxauinotebook}
  34
  35 \func{}{wxAuiNotebook}{\void}
  36
  37 \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}}
  38
  39 Constructor. Creates a wxAuiNotebok control.
  40
  41 \membersection{wxAuiNotebook::AddPage}\label{wxauinotebookaddpage}
  42
  43 \func{bool}{AddPage}{\param{wxWindow* }{page}, \param{const wxString\& }{caption}, \param{bool }{select = false}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}}
  44
  45 Adds a page.  If the {\it select} parameter is true, calling this will generate a page change event.
  46
  47 \membersection{wxAuiNotebook::Create}\label{wxauinotebookcreate}
  48
  49 \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}}
  50
  51 Creates the notebook window.
  52
  53 \membersection{wxAuiNotebook::DeletePage}\label{wxauinotebookdeletepage}
  54
  55 \func{bool}{DeletePage}{\param{size\_t }{page}}
  56
  57 Deletes a page at the given index.  Calling this method will generate a page change event.
  58
  59 \membersection{wxAuiNotebook::GetArtProvider}\label{wxauinotebookgetartprovider}
  60
  61 \constfunc{wxAuiTabArt*}{GetArtProvider}{\void}
  62
  63 Returns the associated art provider.
  64
  65 \membersection{wxAuiNotebook::GetPage}\label{wxauinotebookgetpage}
  66
  67 \constfunc{wxWindow*}{GetPage}{\param{size\_t }{page\_idx}}
  68
  69 Returns the page specified by the given index.
  70
  71 \membersection{wxAuiNotebook::GetPageCount}\label{wxauinotebookgetpagecount}
  72
  73 \constfunc{size\_t}{GetPageCount}{\void}
  74
  75 Returns the number of pages.
  76
  77 \membersection{wxAuiNotebook::GetPageIndex}\label{wxauinotebookgetpageindex}
  78
  79 \constfunc{int}{GetPageIndex}{\param{wxWindow* }{page\_wnd}}
  80
  81 Reurns the page index for the specified window.  If the window is not found in the notebook, wxNOT_FOUND is returned.
  82
  83 \membersection{wxAuiNotebook::GetSelection}\label{wxauinotebookgetselection}
  84
  85 \constfunc{int}{GetSelection}{\void}
  86
  87 Returns the currently selected page.
  88
  89 \membersection{wxAuiNotebook::InsertPage}\label{wxauinotebookinsertpage}
  90
  91 \func{bool}{InsertPage}{\param{size\_t }{page\_idx}, \param{wxWindow* }{page}, \param{const wxString\& }{caption}, \param{bool }{select = false}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}}
  92
  93 Inserts a page.
  94
  95 \membersection{wxAuiNotebook::RemovePage}\label{wxauinotebookremovepage}
  96
  97 \func{bool}{RemovePage}{\param{size\_t }{page}}
  98
  99 Removes a page, without deleting the window pointer.
 100
 101 \membersection{wxAuiNotebook::SetArtProvider}\label{wxauinotebooksetartprovider}
 102
 103 \func{void}{SetArtProvider}{\param{wxAuiTabArt* }{art}}
 104
 105 Sets the art provider to be used by the notebook.
 106
 107 \membersection{wxAuiNotebook::SetPageBitmap}\label{wxauinotebooksetpagebitmap}
 108
 109 \func{bool}{SetPageBitmap}{\param{size\_t }{page}, \param{const wxBitmap\& }{bitmap}}
 110
 111 Sets the bitmap for the page.
 112
 113 \membersection{wxAuiNotebook::SetPageText}\label{wxauinotebooksetpagetext}
 114
 115 \func{bool}{SetPageText}{\param{size\_t }{page}, \param{const wxString\& }{text}}
 116
 117 Sets the tab label for the page.
 118
 119 \membersection{wxAuiNotebook::SetSelection}\label{wxauinotebooksetselection}
 120
 121 \func{size\_t}{SetSelection}{\param{size\_t }{new\_page}}
 122
 123 Sets the page selection.  Calling this method will generate a page change event.
 124
 125 \membersection{wxAuiNotebook::SetTabCtrlHeight}\label{wxauinotebooksettabctrlheight}
 126
 127 \func{void}{SetTabCtrlHeight}{\param{int }{height}}
 128
 129 Sets the tab height.
 130