docs/latex/wx/dataviewtreestore.tex

   1
   2 \section{\class{wxDataViewTreeStore}}\label{wxdataviewtreestore}
   3
   4 wxDataViewTreeStore is a specialised \helpref{wxDataViewModel}{wxdataviewmodel}
   5 for displaying simple trees very much like \helpref{wxTreeCtrl}{wxtreectrl}
   6 does and it offers a similar API. This class actually stores the entire
   7 tree (therefore its name) and implements all virtual methods from the base
   8 class so it can be used directly without having to derive any class from it.
   9 This comes at the price of much reduced flexibility.
  10
  11 \wxheading{Derived from}
  12
  13 \helpref{wxDataViewModel}{wxdataviewmodel}
  14
  15 \wxheading{Include files}
  16
  17 <dataview.h>
  18
  19 \wxheading{Library}
  20
  21 \helpref{wxAdv}{librarieslist}
  22
  23
  24 \latexignore{\rtfignore{\wxheading{Members}}}
  25
  26 \membersection{wxDataViewTreeStore::wxDataViewTreeStore}\label{wxdataviewtreestorewxdataviewtreestore}
  27
  28 \func{}{wxDataViewTreeStore}{\void}
  29
  30 Constructor. Creates the invisible root node internally.
  31
  32 \membersection{wxDataViewTreeStore::\destruct{wxDataViewTreeStore}}\label{wxdataviewtreestoredtor}
  33
  34 \func{}{\destruct{wxDataViewTreeStore}}{\void}
  35
  36 Destructor.
  37
  38 \membersection{wxDataViewTreeStore::AppendContainer}\label{wxdataviewtreestoreappendcontainer}
  39
  40 \func{wxDataViewItem}{AppendContainer}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{const wxIcon\& }{icon = wxNullIcon}, \param{const wxIcon\& }{expanded = wxNullIcon}, \param{wxClientData* }{data = NULL}}
  41
  42 Append a container.
  43
  44 \membersection{wxDataViewTreeStore::AppendItem}\label{wxdataviewtreestoreappenditem}
  45
  46 \func{wxDataViewItem}{AppendItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{const wxIcon\& }{icon = wxNullIcon}, \param{wxClientData* }{data = NULL}}
  47
  48 Append an item.
  49
  50 \membersection{wxDataViewTreeStore::DeleteAllItems}\label{wxdataviewtreestoredeleteallitems}
  51
  52 \func{void}{DeleteAllItems}{\void}
  53
  54 Delete all item in the model.
  55
  56 \membersection{wxDataViewTreeStore::DeleteChildren}\label{wxdataviewtreestoredeletechildren}
  57
  58 \func{void}{DeleteChildren}{\param{const wxDataViewItem\& }{item}}
  59
  60 Delete all children of the item, but not the item itself.
  61
  62 \membersection{wxDataViewTreeStore::DeleteItem}\label{wxdataviewtreestoredeleteitem}
  63
  64 \func{void}{DeleteItem}{\param{const wxDataViewItem\& }{item}}
  65
  66 Delete this item.
  67
  68 \membersection{wxDataViewTreeStore::GetChildCount}\label{wxdataviewtreestoregetchildcount}
  69
  70 \constfunc{int}{GetChildCount}{\param{const wxDataViewItem\& }{parent}}
  71
  72 Return the number of children of item.
  73
  74 \membersection{wxDataViewTreeStore::GetItemData}\label{wxdataviewtreestoregetitemdata}
  75
  76 \constfunc{wxClientData*}{GetItemData}{\param{const wxDataViewItem\& }{item}}
  77
  78 Returns the client data asoociated with the item.
  79
  80 \membersection{wxDataViewTreeStore::GetItemExpandedIcon}\label{wxdataviewtreestoregetitemexpandedicon}
  81
  82 \constfunc{const wxIcon\&}{GetItemExpandedIcon}{\param{const wxDataViewItem\& }{item}}
  83
  84 Returns the icon to display in expanded containers.
  85
  86 \membersection{wxDataViewTreeStore::GetItemIcon}\label{wxdataviewtreestoregetitemicon}
  87
  88 \constfunc{const wxIcon\&}{GetItemIcon}{\param{const wxDataViewItem\& }{item}}
  89
  90 Returns the icon of the item.
  91
  92 \membersection{wxDataViewTreeStore::GetItemText}\label{wxdataviewtreestoregetitemtext}
  93
  94 \constfunc{wxString}{GetItemText}{\param{const wxDataViewItem\& }{item}}
  95
  96 Returns the text of the item.
  97
  98 \membersection{wxDataViewTreeStore::GetNthChild}\label{wxdataviewtreestoregetnthchild}
  99
 100 \constfunc{wxDataViewItem}{GetNthChild}{\param{const wxDataViewItem\& }{parent}, \param{unsigned int }{pos}}
 101
 102 Returns the nth child item of item.
 103
 104 \membersection{wxDataViewTreeStore::InsertContainer}\label{wxdataviewtreestoreinsertcontainer}
 105
 106 \func{wxDataViewItem}{InsertContainer}{\param{const wxDataViewItem\& }{parent}, \param{const wxDataViewItem\& }{previous}, \param{const wxString\& }{text}, \param{const wxIcon\& }{icon = wxNullIcon}, \param{const wxIcon\& }{expanded = wxNullIcon}, \param{wxClientData* }{data = NULL}}
 107
 108 Inserts a container after {\it previous}.
 109
 110 \membersection{wxDataViewTreeStore::InsertItem}\label{wxdataviewtreestoreinsertitem}
 111
 112 \func{wxDataViewItem}{InsertItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxDataViewItem\& }{previous}, \param{const wxString\& }{text}, \param{const wxIcon\& }{icon = wxNullIcon}, \param{wxClientData* }{data = NULL}}
 113
 114 Inserts an item after {\it previous}.
 115
 116 \membersection{wxDataViewTreeStore::PrependContainer}\label{wxdataviewtreestoreprependcontainer}
 117
 118 \func{wxDataViewItem}{PrependContainer}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{const wxIcon\& }{icon = wxNullIcon}, \param{const wxIcon\& }{expanded = wxNullIcon}, \param{wxClientData* }{data = NULL}}
 119
 120 Inserts a container before the first child item or {\it parent}.
 121
 122 \membersection{wxDataViewTreeStore::PrependItem}\label{wxdataviewtreestoreprependitem}
 123
 124 \func{wxDataViewItem}{PrependItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{const wxIcon\& }{icon = wxNullIcon}, \param{wxClientData* }{data = NULL}}
 125
 126 Inserts an item before the first child item or {\it parent}.
 127
 128 \membersection{wxDataViewTreeStore::SetItemData}\label{wxdataviewtreestoresetitemdata}
 129
 130 \func{void}{SetItemData}{\param{const wxDataViewItem\& }{item}, \param{wxClientData* }{data}}
 131
 132 Sets the client data associated with the item.
 133
 134 \membersection{wxDataViewTreeStore::SetItemExpandedIcon}\label{wxdataviewtreestoresetitemexpandedicon}
 135
 136 \func{void}{SetItemExpandedIcon}{\param{const wxDataViewItem\& }{item}, \param{const wxIcon\& }{icon}}
 137
 138 Sets the expanded icon for the item.
 139
 140 \membersection{wxDataViewTreeStore::SetItemIcon}\label{wxdataviewtreestoresetitemicon}
 141
 142 \func{void}{SetItemIcon}{\param{const wxDataViewItem\& }{item}, \param{const wxIcon\& }{icon}}
 143
 144 Sets the icon for the item.
 145
 146 \membersection{wxDataViewTreeStore::SetItemText}\label{wxdataviewtreestoresetitemtext}
 147
 148 \func{void}{SetItemText}{\param{const wxDataViewItem\& }{item}, \param{const wxString\& }{text}}
 149
 150 Sets the text of the item.