Added wxRect::Intersect() documentation (patch 1868322 from Laurent Humbertclaude).

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

\section{\class{wxDataViewTreeCtrl}}\label{wxdataviewtreectrl}

This class is a \helpref{wxDataViewCtrl}{wxdataviewctrl} which internally
uses a \helpref{wxDataViewTreeStore}{wxdataviewtreestore} and forwards
most of its API to that class. Additionally, it uses a \helpref{wxImageList}{wximagelist}
to store a list of icons. The main purpose of this class is to look 
like a \helpref{wxTreeCtrl}{wxtreectrl} to make a transition from it
to the wxDataViewCtrl class simpler.

\wxheading{Derived from}

\helpref{wxDataViewCtrl}{wxdataviewctrl}

\wxheading{Include files}

<dataview.h>

\wxheading{Data structures}

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


\membersection{wxDataViewTreeCtrl::wxDataViewTreeCtrl}\label{wxdataviewtreectrlwxdataviewtreectrl}

\func{}{wxDataViewTreeCtrl}{\void}

Default constructor.

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

Constructor. Calls \helpref{Create}{wxdataviewtreectrlcreate}.

\membersection{wxDataViewTreeCtrl::\destruct{wxDataViewTreeCtrl}}\label{wxdataviewtreectrldtor}

\func{}{\destruct{wxDataViewTreeCtrl}}{\void}

Destructor. Deletes the image list if any.

\membersection{wxDataViewTreeCtrl::AppendContainer}\label{wxdataviewtreectrlappendcontainer}

\func{wxDataViewItem}{AppendContainer}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{int }{icon = -1}, \param{int }{expanded = -1}, \param{wxClientData* }{data = NULL}}


\membersection{wxDataViewTreeCtrl::AppendItem}\label{wxdataviewtreectrlappenditem}

\func{wxDataViewItem}{AppendItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{int }{icon = -1}, \param{wxClientData* }{data = NULL}}


\membersection{wxDataViewTreeCtrl::Create}\label{wxdataviewtreectrlcreate}

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

Creates the control and a \helpref{wxDataViewTreeStore}{wxdataviewtreestore} as
its internal model.

\membersection{wxDataViewTreeCtrl::DeleteAllItems}\label{wxdataviewtreectrldeleteallitems}

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

Calls the identical method from wxDataViewTreeStore.

\membersection{wxDataViewTreeCtrl::DeleteChildren}\label{wxdataviewtreectrldeletechildren}

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

Calls the identical method from wxDataViewTreeStore.

\membersection{wxDataViewTreeCtrl::DeleteItem}\label{wxdataviewtreectrldeleteitem}

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

Calls the identical method from wxDataViewTreeStore.

\membersection{wxDataViewTreeCtrl::GetChildCount}\label{wxdataviewtreectrlgetchildcount}

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

Calls the identical method from wxDataViewTreeStore.

\membersection{wxDataViewTreeCtrl::GetImageList}\label{wxdataviewtreectrlgetimagelist}

\func{wxImageList*}{GetImageList}{\void}

Returns the image list.

\membersection{wxDataViewTreeCtrl::GetItemData}\label{wxdataviewtreectrlgetitemdata}

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

Calls the identical method from wxDataViewTreeStore.

\membersection{wxDataViewTreeCtrl::GetItemExpandedIcon}\label{wxdataviewtreectrlgetitemexpandedicon}

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

Calls the identical method from wxDataViewTreeStore.

\membersection{wxDataViewTreeCtrl::GetItemIcon}\label{wxdataviewtreectrlgetitemicon}

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

Calls the identical method from wxDataViewTreeStore.

\membersection{wxDataViewTreeCtrl::GetItemText}\label{wxdataviewtreectrlgetitemtext}

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

Calls the identical method from wxDataViewTreeStore.

\membersection{wxDataViewTreeCtrl::GetNthChild}\label{wxdataviewtreectrlgetnthchild}

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

Calls the identical method from wxDataViewTreeStore.

\membersection{wxDataViewTreeCtrl::GetStore}\label{wxdataviewtreectrlgetstore}

\func{wxDataViewTreeStore*}{GetStore}{\void}

\constfunc{const wxDataViewTreeStore*}{GetStore}{\void}

Returns the store.

\membersection{wxDataViewTreeCtrl::InsertContainer}\label{wxdataviewtreectrlinsertcontainer}

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

Calls the same method from wxDataViewTreeStore but uess
and index position in the image list instead of a wxIcon.

\membersection{wxDataViewTreeCtrl::InsertItem}\label{wxdataviewtreectrlinsertitem}

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

Calls the same method from wxDataViewTreeStore but uess
and index position in the image list instead of a wxIcon.

\membersection{wxDataViewTreeCtrl::PrependContainer}\label{wxdataviewtreectrlprependcontainer}

\func{wxDataViewItem}{PrependContainer}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{int }{icon = -1}, \param{int }{expanded = -1}, \param{wxClientData* }{data = NULL}}

Calls the same method from wxDataViewTreeStore but uess
and index position in the image list instead of a wxIcon.

\membersection{wxDataViewTreeCtrl::PrependItem}\label{wxdataviewtreectrlprependitem}

\func{wxDataViewItem}{PrependItem}{\param{const wxDataViewItem\& }{parent}, \param{const wxString\& }{text}, \param{int }{icon = -1}, \param{wxClientData* }{data = NULL}}

Calls the same method from wxDataViewTreeStore but uess
and index position in the image list instead of a wxIcon.

\membersection{wxDataViewTreeCtrl::SetImageList}\label{wxdataviewtreectrlsetimagelist}

\func{void}{SetImageList}{\param{wxImageList* }{imagelist}}

Sets the image list.

\membersection{wxDataViewTreeCtrl::SetItemData}\label{wxdataviewtreectrlsetitemdata}

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

Calls the identical method from wxDataViewTreeStore.


\membersection{wxDataViewTreeCtrl::SetItemExpandedIcon}\label{wxdataviewtreectrlsetitemexpandedicon}

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

Calls the identical method from wxDataViewTreeStore.


\membersection{wxDataViewTreeCtrl::SetItemIcon}\label{wxdataviewtreectrlsetitemicon}

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

Calls the identical method from wxDataViewTreeStore.


\membersection{wxDataViewTreeCtrl::SetItemText}\label{wxdataviewtreectrlsetitemtext}

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

Calls the identical method from wxDataViewTreeStore.