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

\section{\class{wxTreeItemData}}\label{wxtreeitemdata}

wxTreeItemData is some (arbitrary) user class associated with some item. The
main advantage of having this class is that wxTreeItemData objects are
destroyed automatically by the tree and, as this class has virtual destructor,
it means that the memory and any other resources associated with a tree item
will be automatically freed when it is deleted. Note that we don't use wxObject
as the base class for wxTreeItemData because the size of this class is
critical: in many applications, each tree leaf will have wxTreeItemData
associated with it and number of leaves may be quite big.

Also please note that because the objects of this class are deleted by the tree
using the operator {\tt delete}, they must always be allocated on the heap
using {\tt new}.

\wxheading{Derived from}

\helpref{wxClientData}{wxclientdata}

\wxheading{Include files}

<wx/treectrl.h>

\wxheading{See also}

\helpref{wxTreeCtrl}{wxtreectrl}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxTreeItemData::wxTreeItemData}\label{wxtreeitemdatactor}

\func{}{wxTreeItemData}{\void}

Default constructor.

\pythonnote{The wxPython version of this constructor optionally
accepts any Python object as a parameter.  This object is then
associated with the tree item using the wxTreeItemData as a
container.

In addition, the following methods are added in wxPython for accessing
the object:

\indented{2cm}{\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf GetData()}}{Returns a reference to the Python Object}
\twocolitem{{\bf SetData(obj)}}{Associates a new Python Object with the
wxTreeItemData}
\end{twocollist}}
}

\perlnote{In wxPerl the constructor accepts as parameter an optional scalar,
 and stores it as client data. You may retrieve this data by calling
 {\bf GetData()}, and set it by calling {\bf SetData( data ).}
}

\membersection{wxTreeItemData::\destruct{wxTreeItemData}}\label{wxtreeitemdatadtor}

\func{void}{\destruct{wxTreeItemData}}{\void}

Virtual destructor.

\membersection{wxTreeItemData::GetId}\label{wxtreeitemdatagetid}

\func{const wxTreeItemId\&}{GetId}{\void}

Returns the item associated with this node.

\membersection{wxTreeItemData::SetId}\label{wxtreeitemdatasetid}

\func{void}{SetId}{\param{const wxTreeItemId\&}{ id}}

Sets the item associated with this node.
Commit	Line	Data
f3845e88 VZ	1	\section{\class{wxTreeItemData}}\label{wxtreeitemdata}
	2
	3	wxTreeItemData is some (arbitrary) user class associated with some item. The
1e3996b1 VZ	4	main advantage of having this class is that wxTreeItemData objects are
	5	destroyed automatically by the tree and, as this class has virtual destructor,
	6	it means that the memory and any other resources associated with a tree item
	7	will be automatically freed when it is deleted. Note that we don't use wxObject
	8	as the base class for wxTreeItemData because the size of this class is
	9	critical: in many applications, each tree leaf will have wxTreeItemData
	10	associated with it and number of leaves may be quite big.
	11
	12	Also please note that because the objects of this class are deleted by the tree
	13	using the operator {\tt delete}, they must always be allocated on the heap
	14	using {\tt new}.
f3845e88 VZ	15
	16	\wxheading{Derived from}
	17
e3ba9f88	18	\helpref{wxClientData}{wxclientdata}
f3845e88 VZ	19
	20	\wxheading{Include files}
	21
	22	<wx/treectrl.h>
	23
	24	\wxheading{See also}
	25
	26	\helpref{wxTreeCtrl}{wxtreectrl}
	27
	28	\latexignore{\rtfignore{\wxheading{Members}}}
	29
15d83f72	30	\membersection{wxTreeItemData::wxTreeItemData}\label{wxtreeitemdatactor}
f3845e88 VZ	31
	32	\func{}{wxTreeItemData}{\void}
	33
	34	Default constructor.
	35
	36	\pythonnote{The wxPython version of this constructor optionally
	37	accepts any Python object as a parameter. This object is then
	38	associated with the tree item using the wxTreeItemData as a
	39	container.
	40
	41	In addition, the following methods are added in wxPython for accessing
	42	the object:
	43
	44	\indented{2cm}{\begin{twocollist}\itemsep=0pt
	45	\twocolitem{{\bf GetData()}}{Returns a reference to the Python Object}
	46	\twocolitem{{\bf SetData(obj)}}{Associates a new Python Object with the
	47	wxTreeItemData}
	48	\end{twocollist}}
	49	}
	50
	51	\perlnote{In wxPerl the constructor accepts as parameter an optional scalar,
	52	and stores it as client data. You may retrieve this data by calling
2edb0bde	53	{\bf GetData()}, and set it by calling {\bf SetData( data ).}
f3845e88 VZ	54	}
f3845e88 VZ	55
15d83f72	56	\membersection{wxTreeItemData::\destruct{wxTreeItemData}}\label{wxtreeitemdatadtor}
f3845e88 VZ	57
	58	\func{void}{\destruct{wxTreeItemData}}{\void}
	59
	60	Virtual destructor.
	61
	62	\membersection{wxTreeItemData::GetId}\label{wxtreeitemdatagetid}
	63
c6dee7f7	64	\func{const wxTreeItemId\&}{GetId}{\void}
f3845e88 VZ	65
	66	Returns the item associated with this node.
	67
	68	\membersection{wxTreeItemData::SetId}\label{wxtreeitemdatasetid}
	69
	70	\func{void}{SetId}{\param{const wxTreeItemId\&}{ id}}
	71
	72	Sets the item associated with this node.
	73
	74