projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| b6b9d556 RR |
1 | |
| 2 | \section{\class{wxDataViewColumn}}\label{wxdataviewcolumn} | |
| 3 | ||
| 4 | ||
| 5 | This class represents a column in a \helpref{wxDataViewCtrl}{wxdataviewctrl}. | |
| 6 | One wxDataViewColumn is bound to one column in the data model, | |
| 7 | to which the wxDataViewCtrl has been associated. | |
| 8 | ||
| 9 | An instance of \helpref{wxDataViewRenderer}{wxdataviewrenderer} is used by | |
| 10 | this class to render its data. | |
| 11 | ||
| 12 | \wxheading{Constants} | |
| 13 | ||
| 14 | These flags define behavi | |
| 15 | ||
| 16 | {\small | |
| 17 | \begin{verbatim} | |
| 18 | enum wxDataViewColumnFlags | |
| 19 | { | |
| 20 | wxDATAVIEW_COL_RESIZABLE = 1, // the user can resize the column | |
| 21 | wxDATAVIEW_COL_SORTABLE = 2, // same as SetSortable() | |
| 22 | wxDATAVIEW_COL_HIDDEN = 4 // column is hidden | |
| 23 | }; | |
| 24 | \end{verbatim} | |
| 25 | } | |
| 26 | ||
| 27 | \wxheading{Derived from} | |
| 28 | ||
| 29 | \helpref{wxObject}{wxobject} | |
| 30 | ||
| 31 | \wxheading{Include files} | |
| 32 | ||
| 33 | <wx/dataview.h> | |
| 34 | ||
| 35 | ||
| 36 | \membersection{wxDataViewColumn::wxDataViewColumn}\label{wxdataviewcolumnwxdataviewcolumn} | |
| 37 | ||
| 38 | \func{}{wxDataViewColumn}{\param{const wxString\& }{title}, \param{wxDataViewRenderer* }{renderer}, \param{unsigned int }{model\_column}, \param{int }{width = 80}, \param{int }{flags = wxDATAVIEW\_COL\_RESIZABLE}} | |
| 39 | ||
| 40 | ||
| 41 | \func{}{wxDataViewColumn}{\param{const wxBitmap\& }{bitmap}, \param{wxDataViewRenderer* }{renderer}, \param{unsigned int }{model\_column}, \param{int }{width = 80}, \param{int }{flags = wxDATAVIEW\_COL\_RESIZABLE}} | |
| 42 | ||
| 43 | Constructors. | |
| 44 | ||
| 45 | ||
| 46 | \membersection{wxDataViewColumn::\destruct{wxDataViewColumn}}\label{wxdataviewcolumndtor} | |
| 47 | ||
| 48 | \func{}{\destruct{wxDataViewColumn}}{\void} | |
| 49 | ||
| 50 | Destructor. | |
| 51 | ||
| 52 | \membersection{wxDataViewColumn::GetBitmap}\label{wxdataviewcolumngetbitmap} | |
| 53 | ||
| 54 | \func{const wxBitmap\&}{GetBitmap}{\void} | |
| 55 | ||
| 56 | Returns the bitmap in the header of the column, if any. | |
| 57 | ||
| 58 | \membersection{wxDataViewColumn::GetModelColumn}\label{wxdataviewcolumngetmodelcolumn} | |
| 59 | ||
| 60 | \func{unsigned int}{GetModelColumn}{\void} | |
| 61 | ||
| 62 | Returns the index of the column of the model, which this | |
| 63 | wxDataViewColumn is displaying. | |
| 64 | ||
| 65 | \membersection{wxDataViewColumn::GetOwner}\label{wxdataviewcolumngetowner} | |
| 66 | ||
| 67 | \func{wxDataViewCtrl*}{GetOwner}{\void} | |
| 68 | ||
| 69 | Returns the owning \helpref{wxDataViewCtrl}{wxdataviewctrl}. | |
| 70 | ||
| 71 | \membersection{wxDataViewColumn::GetRenderer}\label{wxdataviewcolumngetrenderer} | |
| 72 | ||
| 73 | \func{wxDataViewRenderer*}{GetRenderer}{\void} | |
| 74 | ||
| 75 | Returns the renderer of this wxDataViewColumn. | |
| 76 | ||
| 77 | See also \helpref{wxDataViewRenderer}{wxdataviewrenderer}. | |
| 78 | ||
| 79 | \membersection{wxDataViewColumn::GetSortable}\label{wxdataviewcolumngetsortable} | |
| 80 | ||
| 81 | \func{bool}{GetSortable}{\void} | |
| 82 | ||
| 83 | Returns true if the column is sortable. | |
| 84 | ||
| 85 | See \helpref{SetSortable}{wxdataviewcolumnsetsortable} | |
| 86 | ||
| 87 | \membersection{wxDataViewColumn::GetWidth}\label{wxdataviewcolumngetwidth} | |
| 88 | ||
| 89 | \func{int}{GetWidth}{\void} | |
| 90 | ||
| 91 | Returns the width of the column. | |
| 92 | ||
| 93 | \membersection{wxDataViewColumn::IsSortOrderAscending}\label{wxdataviewcolumnissortorderascending} | |
| 94 | ||
| 95 | \func{bool}{IsSortOrderAscending}{\void} | |
| 96 | ||
| 97 | Returns true, if the sort order is ascending. | |
| 98 | ||
| 99 | See also \helpref{SetSortOrder}{wxdataviewcolumnsetsortorder} | |
| 100 | ||
| 101 | \membersection{wxDataViewColumn::SetAlignment}\label{wxdataviewcolumnsetalignment} | |
| 102 | ||
| 103 | \func{void}{SetAlignment}{\param{wxAlignment }{align}} | |
| 104 | ||
| 105 | Set the alignment of the column header. | |
| 106 | ||
| 107 | \membersection{wxDataViewColumn::SetBitmap}\label{wxdataviewcolumnsetbitmap} | |
| 108 | ||
| 109 | \func{void}{SetBitmap}{\param{const wxBitmap\& }{bitmap}} | |
| 110 | ||
| 111 | Set the bitmap of the column header. | |
| 112 | ||
| 113 | \membersection{wxDataViewColumn::SetSortOrder}\label{wxdataviewcolumnsetsortorder} | |
| 114 | ||
| 115 | \func{void}{SetSortOrder}{\param{bool }{ascending}} | |
| 116 | ||
| 117 | Indicate the sort order if the implementation of the | |
| 118 | wxDataViewCtrl supports it, most commonly by showing | |
| 119 | a little arrow. Use this in conjunction with | |
| 120 | \helpref{wxDataViewSortedListModel::SetAscending}{wxdataviewsortedlistmodelsetascending} | |
| 121 | to sort the actual data. | |
| 122 | ||
| 123 | \membersection{wxDataViewColumn::SetSortable}\label{wxdataviewcolumnsetsortable} | |
| 124 | ||
| 125 | \func{void}{SetSortable}{\param{bool }{sortable}} | |
| 126 | ||
| 127 | Indicate that the column is sortable. This is only to provide a | |
| 128 | visual hint in the column (such as a sort order indicator). It | |
| 129 | will not actually sort the data. Use a | |
| 130 | \helpref{wxDataViewSortedListModel}{wxdataviewsortedlistmodel} | |
| 131 | to so the sorting. | |
| 132 | ||
| 133 | \membersection{wxDataViewColumn::SetTitle}\label{wxdataviewcolumnsettitle} | |
| 134 | ||
| 135 | \func{void}{SetTitle}{\param{const wxString\& }{title}} | |
| 136 | ||
| 137 | Set the title of the column header to {\it title}. | |
| 138 |