projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| a660d684 KB |
1 | \section{\class{wxTabCtrl}}\label{wxtabctrl} |
| 2 | ||
| 3 | This class represents a tab control, which manages multiple tabs. | |
| 4 | ||
| 5 | \wxheading{Derived from} | |
| 6 | ||
| 7 | \helpref{wxControl}{wxcontrol}\\ | |
| 8 | \helpref{wxWindow}{wxwindow}\\ | |
| 9 | \helpref{wxEvtHandler}{wxevthandler}\\ | |
| 10 | \helpref{wxObject}{wxobject} | |
| 11 | ||
| 12 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 13 | ||
| 14 | \membersection{wxTabCtrl::wxTabCtrl}\label{wxtabctrlconstr} | |
| 15 | ||
| 16 | \func{}{wxTabCtrl}{\void} | |
| 17 | ||
| 18 | Default constructor. | |
| 19 | ||
| 20 | \func{}{wxTabCtrl}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, | |
| 21 | \param{const wxSize\&}{ size}, \param{const long}{ style = 0}, \param{const wxString\& }{name = "tabCtrl"}} | |
| 22 | ||
| 23 | Constructs a tab control. | |
| 24 | ||
| 25 | \wxheading{Parameters} | |
| 26 | ||
| 27 | \docparam{parent}{The parent window. Must be non-NULL.} | |
| 28 | ||
| 29 | \docparam{id}{The window identifier.} | |
| 30 | ||
| 31 | \docparam{pos}{The window position.} | |
| 32 | ||
| 33 | \docparam{size}{The window size.} | |
| 34 | ||
| 35 | \docparam{style}{The window style. Its value is a bit list of zero or more of {\bf wxTC\_MULTILINE}, | |
| 36 | {\bf wxTC\_RIGHTJUSTIFY}, {\bf wxTC\_FIXEDWIDTH} and {\bf wxTC\_OWNERDRAW}.} | |
| 37 | ||
| 38 | \membersection{wxTabCtrl::\destruct{wxTabCtrl}} | |
| 39 | ||
| 40 | \func{}{\destruct{wxTabCtrl}}{\void} | |
| 41 | ||
| 42 | Destroys the wxTabCtrl object. | |
| 43 | ||
| 44 | \membersection{wxTabCtrl::Create}\label{wxtabctrlcreate} | |
| 45 | ||
| 46 | \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, | |
| 47 | \param{const wxSize\&}{ size}, \param{const long}{ style = 0}, \param{const wxString\& }{name = "tabCtrl"}} | |
| 48 | ||
| 49 | Creates a tab control. See \helpref{wxTabCtrl::wxTabCtrl}{wxtabctrlconstr} for a description | |
| 50 | of the parameters. | |
| 51 | ||
| 52 | \membersection{wxTabCtrl::GetImageList}\label{wxtabctrlgetimagelist} | |
| 53 | ||
| 54 | \constfunc{wxImageList*}{GetImageList}{\void} | |
| 55 | ||
| 56 | Returns the associated image list. | |
| 57 | ||
| 58 | \wxheading{See also} | |
| 59 | ||
| 60 | \helpref{wxImageList}{wximagelist}, \helpref{wxTabCtrl::SetImageList}{wxtabctrlsetimagelist} | |
| 61 | ||
| 62 | \membersection{wxTabCtrl::GetItemCount}\label{wxtabctrlgetitemcount} | |
| 63 | ||
| 64 | \constfunc{int}{GetItemCount}{\void} | |
| 65 | ||
| 66 | Returns the number of tabs in the tab control. | |
| 67 | ||
| 68 | \membersection{wxTabCtrl::GetItemRect}\label{wxtabctrlgetitemrect} | |
| 69 | ||
| 70 | \constfunc{bool}{GetItemRect}{\param{const int item}, \param{wxRect\&}{ rect}} | |
| 71 | ||
| 72 | Returns the rectangle bounding the given tab. | |
| 73 | ||
| 74 | \wxheading{See also} | |
| 75 | ||
| 76 | \helpref{wxRect}{wxrect} | |
| 77 | ||
| 78 | \membersection{wxTabCtrl::GetRowCount}\label{wxtabctrlgetrowcount} | |
| 79 | ||
| 80 | \constfunc{bool}{GetRowCount}{\void} | |
| 81 | ||
| 82 | Returns the number of rows in the tab control. | |
| 83 | ||
| 84 | \membersection{wxTabCtrl::GetSelection}\label{wxtabctrlgetselection} | |
| 85 | ||
| 86 | \constfunc{int}{GetSelection}{\void} | |
| 87 | ||
| 88 | Returns the index for the currently selected tab. | |
| 89 | ||
| 90 | \wxheading{See also} | |
| 91 | ||
| 92 | \helpref{wxTabCtrl::SetSelection}{wxtabctrlsetselection} | |
| 93 | ||
| 94 | ||
| 95 |