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
   7 \section{\class{wxAuiNotebook}}\label{wxauinotebook}
   8
   9 \wxheading{Derived from}
  10
  11 \helpref{wxControl}{wxcontrol}
  12
  13 \wxheading{Include files}
  14
  15 <auibook.h>
  16
  17 \wxheading{Data structures}
  18
  19 \latexignore{\rtfignore{\wxheading{Members}}}
  20
  21
  22 \membersection{wxAuiNotebook::wxAuiNotebook}\label{wxauinotebookwxauinotebook}
  23
  24 \func{}{wxAuiNotebook}{\void}
  25
  26
  27 \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}}
  28
  29
  30 \membersection{wxAuiNotebook::\destruct{wxAuiNotebook}}\label{wxauinotebookdtor}
  31
  32 \func{}{\destruct{wxAuiNotebook}}{\void}
  33
  34
  35 \membersection{wxAuiNotebook::AddPage}\label{wxauinotebookaddpage}
  36
  37 \func{bool}{AddPage}{\param{wxWindow* }{page}, \param{const wxString\& }{caption}, \param{bool }{select = false}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}}
  38
  39
  40 \membersection{wxAuiNotebook::CalculateTabCtrlHeight}\label{wxauinotebookcalculatetabctrlheight}
  41
  42 \func{int}{CalculateTabCtrlHeight}{\void}
  43
  44
  45 \membersection{wxAuiNotebook::Create}\label{wxauinotebookcreate}
  46
  47 \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}}
  48
  49
  50 \membersection{wxAuiNotebook::DeletePage}\label{wxauinotebookdeletepage}
  51
  52 \func{bool}{DeletePage}{\param{size\_t }{page}}
  53
  54
  55 \membersection{wxAuiNotebook::DoSizing}\label{wxauinotebookdosizing}
  56
  57 \func{void}{DoSizing}{\void}
  58
  59
  60 \membersection{wxAuiNotebook::FindTab}\label{wxauinotebookfindtab}
  61
  62 \func{bool}{FindTab}{\param{wxWindow* }{page}, \param{wxAuiTabCtrl** }{ctrl}, \param{int* }{idx}}
  63
  64
  65 \membersection{wxAuiNotebook::GetActiveTabCtrl}\label{wxauinotebookgetactivetabctrl}
  66
  67 \func{wxAuiTabCtrl*}{GetActiveTabCtrl}{\void}
  68
  69
  70 \membersection{wxAuiNotebook::GetArtProvider}\label{wxauinotebookgetartprovider}
  71
  72 \constfunc{wxAuiTabArt*}{GetArtProvider}{\void}
  73
  74
  75 \membersection{wxAuiNotebook::GetPage}\label{wxauinotebookgetpage}
  76
  77 \constfunc{wxWindow*}{GetPage}{\param{size\_t }{page\_idx}}
  78
  79
  80 \membersection{wxAuiNotebook::GetPageCount}\label{wxauinotebookgetpagecount}
  81
  82 \constfunc{size\_t}{GetPageCount}{\void}
  83
  84
  85 \membersection{wxAuiNotebook::GetPageIndex}\label{wxauinotebookgetpageindex}
  86
  87 \constfunc{int}{GetPageIndex}{\param{wxWindow* }{page\_wnd}}
  88
  89
  90 \membersection{wxAuiNotebook::GetSelection}\label{wxauinotebookgetselection}
  91
  92 \constfunc{int}{GetSelection}{\void}
  93
  94
  95 \membersection{wxAuiNotebook::GetTabCtrlFromPoint}\label{wxauinotebookgettabctrlfrompoint}
  96
  97 \func{wxAuiTabCtrl*}{GetTabCtrlFromPoint}{\param{const wxPoint\& }{pt}}
  98
  99
 100 \membersection{wxAuiNotebook::GetTabFrameFromTabCtrl}\label{wxauinotebookgettabframefromtabctrl}
 101
 102 \func{wxWindow*}{GetTabFrameFromTabCtrl}{\param{wxWindow* }{tab\_ctrl}}
 103
 104
 105 \membersection{wxAuiNotebook::InitNotebook}\label{wxauinotebookinitnotebook}
 106
 107 \func{void}{InitNotebook}{\param{long }{style}}
 108
 109
 110 \membersection{wxAuiNotebook::InsertPage}\label{wxauinotebookinsertpage}
 111
 112 \func{bool}{InsertPage}{\param{size\_t }{page\_idx}, \param{wxWindow* }{page}, \param{const wxString\& }{caption}, \param{bool }{select = false}, \param{const wxBitmap\& }{bitmap = wxNullBitmap}}
 113
 114
 115 \membersection{wxAuiNotebook::OnChildFocus}\label{wxauinotebookonchildfocus}
 116
 117 \func{void}{OnChildFocus}{\param{wxChildFocusEvent\& }{evt}}
 118
 119
 120 \membersection{wxAuiNotebook::OnEraseBackground}\label{wxauinotebookonerasebackground}
 121
 122 \func{void}{OnEraseBackground}{\param{wxEraseEvent\& }{evt}}
 123
 124
 125 \membersection{wxAuiNotebook::OnRender}\label{wxauinotebookonrender}
 126
 127 \func{void}{OnRender}{\param{wxAuiManagerEvent\& }{evt}}
 128
 129
 130 \membersection{wxAuiNotebook::OnSize}\label{wxauinotebookonsize}
 131
 132 \func{void}{OnSize}{\param{wxSizeEvent\& }{evt}}
 133
 134
 135 \membersection{wxAuiNotebook::OnTabBeginDrag}\label{wxauinotebookontabbegindrag}
 136
 137 \func{void}{OnTabBeginDrag}{\param{wxCommandEvent\& }{evt}}
 138
 139
 140 \membersection{wxAuiNotebook::OnTabButton}\label{wxauinotebookontabbutton}
 141
 142 \func{void}{OnTabButton}{\param{wxCommandEvent\& }{evt}}
 143
 144
 145 \membersection{wxAuiNotebook::OnTabClicked}\label{wxauinotebookontabclicked}
 146
 147 \func{void}{OnTabClicked}{\param{wxCommandEvent\& }{evt}}
 148
 149
 150 \membersection{wxAuiNotebook::OnTabDragMotion}\label{wxauinotebookontabdragmotion}
 151
 152 \func{void}{OnTabDragMotion}{\param{wxCommandEvent\& }{evt}}
 153
 154
 155 \membersection{wxAuiNotebook::OnTabEndDrag}\label{wxauinotebookontabenddrag}
 156
 157 \func{void}{OnTabEndDrag}{\param{wxCommandEvent\& }{evt}}
 158
 159
 160 \membersection{wxAuiNotebook::RemoveEmptyTabFrames}\label{wxauinotebookremoveemptytabframes}
 161
 162 \func{void}{RemoveEmptyTabFrames}{\void}
 163
 164
 165 \membersection{wxAuiNotebook::RemovePage}\label{wxauinotebookremovepage}
 166
 167 \func{bool}{RemovePage}{\param{size\_t }{page}}
 168
 169
 170 \membersection{wxAuiNotebook::SetArtProvider}\label{wxauinotebooksetartprovider}
 171
 172 \func{void}{SetArtProvider}{\param{wxAuiTabArt* }{art}}
 173
 174
 175 \membersection{wxAuiNotebook::SetPageBitmap}\label{wxauinotebooksetpagebitmap}
 176
 177 \func{bool}{SetPageBitmap}{\param{size\_t }{page}, \param{const wxBitmap\& }{bitmap}}
 178
 179
 180 \membersection{wxAuiNotebook::SetPageText}\label{wxauinotebooksetpagetext}
 181
 182 \func{bool}{SetPageText}{\param{size\_t }{page}, \param{const wxString\& }{text}}
 183
 184
 185 \membersection{wxAuiNotebook::SetSelection}\label{wxauinotebooksetselection}
 186
 187 \func{size\_t}{SetSelection}{\param{size\_t }{new\_page}}
 188
 189
 190 \membersection{wxAuiNotebook::SetTabCtrlHeight}\label{wxauinotebooksettabctrlheight}
 191
 192 \func{void}{SetTabCtrlHeight}{\param{int }{height}}
 193
 194 these can be overridden
 195
 196
 197 \membersection{wxAuiNotebook::SetWindowStyleFlag}\label{wxauinotebooksetwindowstyleflag}
 198
 199 \func{void}{SetWindowStyleFlag}{\param{long }{style}}
 200