docs/latex/wx/dataviewtreectrl.tex

   1 \section{\class{wxDataViewTreeCtrl}}\label{wxdataviewtreectrl}
   2
   3 This class is a \helpref{wxDataViewCtrl}{wxdataviewctrl} which internally
   4 uses a \helpref{wxDataViewTreeStore}{wxdataviewtreestore} and forwards
   5 most of its API to that class. Additionally, it uses a \helpref{wxImageList}{wximagelist}
   6 to store a list of icons. The main purpose of this class is to look
   7 like a \helpref{wxTreeCtrl}{wxtreectrl} to make a transition from it
   8 to the wxDataViewCtrl class simpler.
   9
  10 \wxheading{Derived from}
  11
  12 \helpref{wxDataViewCtrl}{wxdataviewctrl}
  13
  14 \wxheading{Include files}
  15
  16 <dataview.h>
  17
  18 \wxheading{Data structures}
  19
  20 \latexignore{\rtfignore{\wxheading{Members}}}
  21
  22
  23 \membersection{wxDataViewTreeCtrl::wxDataViewTreeCtrl}\label{wxdataviewtreectrlwxdataviewtreectrl}
  24
  25 \func{}{wxDataViewTreeCtrl}{\void}
  26
  27 Default constructor.
  28
  29 \func{}{wxDataViewTreeCtrl}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDV\_NO\_HEADER}, \param{const wxValidator\& }{validator = wxDefaultValidator}}
  30
  31 Constructor. Calls \helpref{Create}{wxdataviewtreectrlcreate}.
  32
  33 \membersection{wxDataViewTreeCtrl::\destruct{wxDataViewTreeCtrl}}\label{wxdataviewtreectrldtor}
  34
  35 \func{}{\destruct{wxDataViewTreeCtrl}}{\void}
  36
  37 Destructor. Deletes the image list if any.
  38
  39 \membersection{wxDataViewTreeCtrl::AppendContainer}\label{wxdataviewtreectrlappendcontainer}
  40
  41 \func{wxDataViewItem}{AppendContainer}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{int }{icon = -1}, \param{int }{expanded = -1}, \param{wxClientData* }{data = NULL}}
  42
  43
  44 \membersection{wxDataViewTreeCtrl::AppendItem}\label{wxdataviewtreectrlappenditem}
  45
  46 \func{wxDataViewItem}{AppendItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{int }{icon = -1}, \param{wxClientData* }{data = NULL}}
  47
  48
  49 \membersection{wxDataViewTreeCtrl::Create}\label{wxdataviewtreectrlcreate}
  50
  51 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDV\_NO\_HEADER}, \param{const wxValidator\& }{validator = wxDefaultValidator}}
  52
  53 Creates the control and a \helpref{wxDataViewTreeStore}{wxdataviewtreestore} as
  54 its internal model.
  55
  56 \membersection{wxDataViewTreeCtrl::DeleteAllItems}\label{wxdataviewtreectrldeleteallitems}
  57
  58 \func{void}{DeleteAllItems}{\void}
  59
  60 Calls the identical method from wxDataViewTreeStore.
  61
  62 \membersection{wxDataViewTreeCtrl::DeleteChildren}\label{wxdataviewtreectrldeletechildren}
  63
  64 \func{void}{DeleteChildren}{\param{const wxDataViewItem\& }{item}}
  65
  66 Calls the identical method from wxDataViewTreeStore.
  67
  68 \membersection{wxDataViewTreeCtrl::DeleteItem}\label{wxdataviewtreectrldeleteitem}
  69
  70 \func{void}{DeleteItem}{\param{const wxDataViewItem\& }{item}}
  71
  72 Calls the identical method from wxDataViewTreeStore.
  73
  74 \membersection{wxDataViewTreeCtrl::GetChildCount}\label{wxdataviewtreectrlgetchildcount}
  75
  76 \constfunc{int}{GetChildCount}{\param{const wxDataViewItem\& }{parent}}
  77
  78 Calls the identical method from wxDataViewTreeStore.
  79
  80 \membersection{wxDataViewTreeCtrl::GetImageList}\label{wxdataviewtreectrlgetimagelist}
  81
  82 \func{wxImageList*}{GetImageList}{\void}
  83
  84 Returns the image list.
  85
  86 \membersection{wxDataViewTreeCtrl::GetItemData}\label{wxdataviewtreectrlgetitemdata}
  87
  88 \constfunc{wxClientData*}{GetItemData}{\param{const wxDataViewItem\& }{item}}
  89
  90 Calls the identical method from wxDataViewTreeStore.
  91
  92 \membersection{wxDataViewTreeCtrl::GetItemExpandedIcon}\label{wxdataviewtreectrlgetitemexpandedicon}
  93
  94 \constfunc{const wxIcon\&}{GetItemExpandedIcon}{\param{const wxDataViewItem\& }{item}}
  95
  96 Calls the identical method from wxDataViewTreeStore.
  97
  98 \membersection{wxDataViewTreeCtrl::GetItemIcon}\label{wxdataviewtreectrlgetitemicon}
  99
 100 \constfunc{const wxIcon\&}{GetItemIcon}{\param{const wxDataViewItem\& }{item}}
 101
 102 Calls the identical method from wxDataViewTreeStore.
 103
 104 \membersection{wxDataViewTreeCtrl::GetItemText}\label{wxdataviewtreectrlgetitemtext}
 105
 106 \constfunc{wxString}{GetItemText}{\param{const wxDataViewItem\& }{item}}
 107
 108 Calls the identical method from wxDataViewTreeStore.
 109
 110 \membersection{wxDataViewTreeCtrl::GetNthChild}\label{wxdataviewtreectrlgetnthchild}
 111
 112 \constfunc{wxDataViewItem}{GetNthChild}{\param{const wxDataViewItem\& }{parent}, \param{unsigned int }{pos}}
 113
 114 Calls the identical method from wxDataViewTreeStore.
 115
 116 \membersection{wxDataViewTreeCtrl::GetStore}\label{wxdataviewtreectrlgetstore}
 117
 118 \func{wxDataViewTreeStore*}{GetStore}{\void}
 119
 120 \constfunc{const wxDataViewTreeStore*}{GetStore}{\void}
 121
 122 Returns the store.
 123
 124 \membersection{wxDataViewTreeCtrl::InsertContainer}\label{wxdataviewtreectrlinsertcontainer}
 125
 126 \func{wxDataViewItem}{InsertContainer}{\param{const wxDataViewItem\& }{parent}, \param{const wxDataViewItem\& }{previous}, \param{const wxString\& }{text}, \param{int }{icon = -1}, \param{int }{expanded = -1}, \param{wxClientData* }{data = NULL}}
 127
 128 Calls the same method from wxDataViewTreeStore but uess
 129 and index position in the image list instead of a wxIcon.
 130
 131 \membersection{wxDataViewTreeCtrl::InsertItem}\label{wxdataviewtreectrlinsertitem}
 132
 133 \func{wxDataViewItem}{InsertItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxDataViewItem\& }{previous}, \param{const wxString\& }{text}, \param{int }{icon = -1}, \param{wxClientData* }{data = NULL}}
 134
 135 Calls the same method from wxDataViewTreeStore but uess
 136 and index position in the image list instead of a wxIcon.
 137
 138 \membersection{wxDataViewTreeCtrl::PrependContainer}\label{wxdataviewtreectrlprependcontainer}
 139
 140 \func{wxDataViewItem}{PrependContainer}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{int }{icon = -1}, \param{int }{expanded = -1}, \param{wxClientData* }{data = NULL}}
 141
 142 Calls the same method from wxDataViewTreeStore but uess
 143 and index position in the image list instead of a wxIcon.
 144
 145 \membersection{wxDataViewTreeCtrl::PrependItem}\label{wxdataviewtreectrlprependitem}
 146
 147 \func{wxDataViewItem}{PrependItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{int }{icon = -1}, \param{wxClientData* }{data = NULL}}
 148
 149 Calls the same method from wxDataViewTreeStore but uess
 150 and index position in the image list instead of a wxIcon.
 151
 152 \membersection{wxDataViewTreeCtrl::SetImageList}\label{wxdataviewtreectrlsetimagelist}
 153
 154 \func{void}{SetImageList}{\param{wxImageList* }{imagelist}}
 155
 156 Sets the image list.
 157
 158 \membersection{wxDataViewTreeCtrl::SetItemData}\label{wxdataviewtreectrlsetitemdata}
 159
 160 \func{void}{SetItemData}{\param{const wxDataViewItem\& }{item}, \param{wxClientData* }{data}}
 161
 162 Calls the identical method from wxDataViewTreeStore.
 163
 164
 165 \membersection{wxDataViewTreeCtrl::SetItemExpandedIcon}\label{wxdataviewtreectrlsetitemexpandedicon}
 166
 167 \func{void}{SetItemExpandedIcon}{\param{const wxDataViewItem\& }{item}, \param{const wxIcon\& }{icon}}
 168
 169 Calls the identical method from wxDataViewTreeStore.
 170
 171
 172 \membersection{wxDataViewTreeCtrl::SetItemIcon}\label{wxdataviewtreectrlsetitemicon}
 173
 174 \func{void}{SetItemIcon}{\param{const wxDataViewItem\& }{item}, \param{const wxIcon\& }{icon}}
 175
 176 Calls the identical method from wxDataViewTreeStore.
 177
 178
 179 \membersection{wxDataViewTreeCtrl::SetItemText}\label{wxdataviewtreectrlsetitemtext}
 180
 181 \func{void}{SetItemText}{\param{const wxDataViewItem\& }{item}, \param{const wxString\& }{text}}
 182
 183 Calls the identical method from wxDataViewTreeStore.