[wxWidgets.git] / docs / latex / wx / dataviewtreestore.tex


\section{\class{wxDataViewTreeStore}}\label{wxdataviewtreestore}

wxDataViewTreeStore is a specialised \helpref{wxDataViewModel}{wxdataviewmodel}
for displaying simple trees very much like \helpref{wxTreeCtrl}{wxtreectrl}
does and it offers a similar API. This class actually stores the entire
tree (therefore its name) and implements all virtual from the base class
so it can be used directly without having to derive any class from it.
This comes at the price of much reduced flexibility.

\wxheading{Derived from}

\helpref{wxDataViewModel}{wxdataviewmodel}

\wxheading{Include files}

<dataview.h>

\membersection{wxDataViewTreeStore::wxDataViewTreeStore}\label{wxdataviewtreestorewxdataviewtreestore}

\func{}{wxDataViewTreeStore}{\void}

Constructor. Creates the invisible root node internally.

\membersection{wxDataViewTreeStore::\destruct{wxDataViewTreeStore}}\label{wxdataviewtreestoredtor}

\func{}{\destruct{wxDataViewTreeStore}}{\void}

Destructor.

\membersection{wxDataViewTreeStore::AppendContainer}\label{wxdataviewtreestoreappendcontainer}

\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}}

Append a container.

\membersection{wxDataViewTreeStore::AppendItem}\label{wxdataviewtreestoreappenditem}

\func{wxDataViewItem}{AppendItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{const wxIcon\& }{icon = wxNullIcon}, \param{wxClientData* }{data = NULL}}

Append an item.

\membersection{wxDataViewTreeStore::DeleteAllItems}\label{wxdataviewtreestoredeleteallitems}

\func{void}{DeleteAllItems}{\void}

Delete all item in the model.

\membersection{wxDataViewTreeStore::DeleteChildren}\label{wxdataviewtreestoredeletechildren}

\func{void}{DeleteChildren}{\param{const wxDataViewItem\& }{item}}

Delete all children of the item, but not the item itself.

\membersection{wxDataViewTreeStore::DeleteItem}\label{wxdataviewtreestoredeleteitem}

\func{void}{DeleteItem}{\param{const wxDataViewItem\& }{item}}

Delete this item.

\membersection{wxDataViewTreeStore::GetChildCount}\label{wxdataviewtreestoregetchildcount}

\constfunc{int}{GetChildCount}{\param{const wxDataViewItem\& }{parent}}

Return the number of children of item.

\membersection{wxDataViewTreeStore::GetItemData}\label{wxdataviewtreestoregetitemdata}

\constfunc{wxClientData*}{GetItemData}{\param{const wxDataViewItem\& }{item}}

Returns the client data asoociated with the item.

\membersection{wxDataViewTreeStore::GetItemExpandedIcon}\label{wxdataviewtreestoregetitemexpandedicon}

\constfunc{const wxIcon\&}{GetItemExpandedIcon}{\param{const wxDataViewItem\& }{item}}

Returns the icon to display in expanded containers.

\membersection{wxDataViewTreeStore::GetItemIcon}\label{wxdataviewtreestoregetitemicon}

\constfunc{const wxIcon\&}{GetItemIcon}{\param{const wxDataViewItem\& }{item}}

Returns the icon of the item.

\membersection{wxDataViewTreeStore::GetItemText}\label{wxdataviewtreestoregetitemtext}

\constfunc{wxString}{GetItemText}{\param{const wxDataViewItem\& }{item}}

Returns the text of the item.

\membersection{wxDataViewTreeStore::GetNthChild}\label{wxdataviewtreestoregetnthchild}

\constfunc{wxDataViewItem}{GetNthChild}{\param{const wxDataViewItem\& }{parent}, \param{unsigned int }{pos}}

Returns the nth child item of item.

\membersection{wxDataViewTreeStore::InsertContainer}\label{wxdataviewtreestoreinsertcontainer}

\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}}

Inserts a container after {\it previous}.

\membersection{wxDataViewTreeStore::InsertItem}\label{wxdataviewtreestoreinsertitem}

\func{wxDataViewItem}{InsertItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxDataViewItem\& }{previous}, \param{const wxString\& }{text}, \param{const wxIcon\& }{icon = wxNullIcon}, \param{wxClientData* }{data = NULL}}

Inserts an item after {\it previous}.

\membersection{wxDataViewTreeStore::PrependContainer}\label{wxdataviewtreestoreprependcontainer}

\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}}

Inserts a container before the first child item or {\it parent}.

\membersection{wxDataViewTreeStore::PrependItem}\label{wxdataviewtreestoreprependitem}

\func{wxDataViewItem}{PrependItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{const wxIcon\& }{icon = wxNullIcon}, \param{wxClientData* }{data = NULL}}

Inserts an item before the first child item or {\it parent}.

\membersection{wxDataViewTreeStore::SetItemData}\label{wxdataviewtreestoresetitemdata}

\func{void}{SetItemData}{\param{const wxDataViewItem\& }{item}, \param{wxClientData* }{data}}

Sets the client data associated with the item.

\membersection{wxDataViewTreeStore::SetItemExpandedIcon}\label{wxdataviewtreestoresetitemexpandedicon}

\func{void}{SetItemExpandedIcon}{\param{const wxDataViewItem\& }{item}, \param{const wxIcon\& }{icon}}

Sets the expanded icon for the item.

\membersection{wxDataViewTreeStore::SetItemIcon}\label{wxdataviewtreestoresetitemicon}

\func{void}{SetItemIcon}{\param{const wxDataViewItem\& }{item}, \param{const wxIcon\& }{icon}}

Sets the icon for the item.

\membersection{wxDataViewTreeStore::SetItemText}\label{wxdataviewtreestoresetitemtext}

\func{void}{SetItemText}{\param{const wxDataViewItem\& }{item}, \param{const wxString\& }{text}}

Sets the text of the item.
Commit	Line	Data
716a15b7 RR	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 from the base class
	8	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	\membersection{wxDataViewTreeStore::wxDataViewTreeStore}\label{wxdataviewtreestorewxdataviewtreestore}
	20
	21	\func{}{wxDataViewTreeStore}{\void}
	22
	23	Constructor. Creates the invisible root node internally.
	24
	25	\membersection{wxDataViewTreeStore::\destruct{wxDataViewTreeStore}}\label{wxdataviewtreestoredtor}
	26
	27	\func{}{\destruct{wxDataViewTreeStore}}{\void}
	28
	29	Destructor.
	30
	31	\membersection{wxDataViewTreeStore::AppendContainer}\label{wxdataviewtreestoreappendcontainer}
	32
	33	\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}}
	34
	35	Append a container.
	36
	37	\membersection{wxDataViewTreeStore::AppendItem}\label{wxdataviewtreestoreappenditem}
	38
	39	\func{wxDataViewItem}{AppendItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{const wxIcon\& }{icon = wxNullIcon}, \param{wxClientData* }{data = NULL}}
	40
	41	Append an item.
	42
	43	\membersection{wxDataViewTreeStore::DeleteAllItems}\label{wxdataviewtreestoredeleteallitems}
	44
	45	\func{void}{DeleteAllItems}{\void}
	46
	47	Delete all item in the model.
	48
	49	\membersection{wxDataViewTreeStore::DeleteChildren}\label{wxdataviewtreestoredeletechildren}
	50
	51	\func{void}{DeleteChildren}{\param{const wxDataViewItem\& }{item}}
	52
	53	Delete all children of the item, but not the item itself.
	54
	55	\membersection{wxDataViewTreeStore::DeleteItem}\label{wxdataviewtreestoredeleteitem}
	56
	57	\func{void}{DeleteItem}{\param{const wxDataViewItem\& }{item}}
	58
	59	Delete this item.
	60
	61	\membersection{wxDataViewTreeStore::GetChildCount}\label{wxdataviewtreestoregetchildcount}
	62
	63	\constfunc{int}{GetChildCount}{\param{const wxDataViewItem\& }{parent}}
	64
65	Return the number of children of item.
66
67	\membersection{wxDataViewTreeStore::GetItemData}\label{wxdataviewtreestoregetitemdata}
68
69	\constfunc{wxClientData*}{GetItemData}{\param{const wxDataViewItem\& }{item}}
70
71	Returns the client data asoociated with the item.
72
73	\membersection{wxDataViewTreeStore::GetItemExpandedIcon}\label{wxdataviewtreestoregetitemexpandedicon}
74
75	\constfunc{const wxIcon\&}{GetItemExpandedIcon}{\param{const wxDataViewItem\& }{item}}
76
77	Returns the icon to display in expanded containers.
78
79	\membersection{wxDataViewTreeStore::GetItemIcon}\label{wxdataviewtreestoregetitemicon}
80
81	\constfunc{const wxIcon\&}{GetItemIcon}{\param{const wxDataViewItem\& }{item}}
82
83	Returns the icon of the item.
84
85	\membersection{wxDataViewTreeStore::GetItemText}\label{wxdataviewtreestoregetitemtext}
86
87	\constfunc{wxString}{GetItemText}{\param{const wxDataViewItem\& }{item}}
88
89	Returns the text of the item.
90
91	\membersection{wxDataViewTreeStore::GetNthChild}\label{wxdataviewtreestoregetnthchild}
92
93	\constfunc{wxDataViewItem}{GetNthChild}{\param{const wxDataViewItem\& }{parent}, \param{unsigned int }{pos}}
94
95	Returns the nth child item of item.
96
97	\membersection{wxDataViewTreeStore::InsertContainer}\label{wxdataviewtreestoreinsertcontainer}
98
99	\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}}
100
101	Inserts a container after {\it previous}.
102
103	\membersection{wxDataViewTreeStore::InsertItem}\label{wxdataviewtreestoreinsertitem}
104
105	\func{wxDataViewItem}{InsertItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxDataViewItem\& }{previous}, \param{const wxString\& }{text}, \param{const wxIcon\& }{icon = wxNullIcon}, \param{wxClientData* }{data = NULL}}
106
107	Inserts an item after {\it previous}.
108
109	\membersection{wxDataViewTreeStore::PrependContainer}\label{wxdataviewtreestoreprependcontainer}
110
111	\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}}
112
113	Inserts a container before the first child item or {\it parent}.
114
115	\membersection{wxDataViewTreeStore::PrependItem}\label{wxdataviewtreestoreprependitem}
116
117	\func{wxDataViewItem}{PrependItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{const wxIcon\& }{icon = wxNullIcon}, \param{wxClientData* }{data = NULL}}
118
119	Inserts an item before the first child item or {\it parent}.
120
121	\membersection{wxDataViewTreeStore::SetItemData}\label{wxdataviewtreestoresetitemdata}
122
123	\func{void}{SetItemData}{\param{const wxDataViewItem\& }{item}, \param{wxClientData* }{data}}
124
125	Sets the client data associated with the item.
126
127	\membersection{wxDataViewTreeStore::SetItemExpandedIcon}\label{wxdataviewtreestoresetitemexpandedicon}
128
129	\func{void}{SetItemExpandedIcon}{\param{const wxDataViewItem\& }{item}, \param{const wxIcon\& }{icon}}
130
131	Sets the expanded icon for the item.
132
133	\membersection{wxDataViewTreeStore::SetItemIcon}\label{wxdataviewtreestoresetitemicon}
134
135	\func{void}{SetItemIcon}{\param{const wxDataViewItem\& }{item}, \param{const wxIcon\& }{icon}}
136
137	Sets the icon for the item.
138
139	\membersection{wxDataViewTreeStore::SetItemText}\label{wxdataviewtreestoresetitemtext}
140
141	\func{void}{SetItemText}{\param{const wxDataViewItem\& }{item}, \param{const wxString\& }{text}}
142
143	Sets the text of the item.