From 716a15b7005905c9dfc6f00ddfd6975b64e750fb Mon Sep 17 00:00:00 2001 From: Robert Roebling Date: Tue, 16 Oct 2007 11:54:46 +0000 Subject: [PATCH] Docs for wxDataViewTreeStore git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@49169 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/classes.tex | 1 + docs/latex/wx/dataviewmodel.tex | 5 +- docs/latex/wx/dataviewtreestore.tex | 143 ++++++++++++++++++++++++++++ 3 files changed, 146 insertions(+), 3 deletions(-) create mode 100644 docs/latex/wx/dataviewtreestore.tex diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 0aa7adb9d6..b334c5cce0 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -89,6 +89,7 @@ \input dataviewindexlistmodel.tex \input dataviewitem.tex \input dataviewrenderer.tex +\input dataviewtreestore.tex \input dobjcomp.tex \input dobjsmpl.tex \input datostrm.tex diff --git a/docs/latex/wx/dataviewmodel.tex b/docs/latex/wx/dataviewmodel.tex index 15fe449e41..51a73b87cb 100644 --- a/docs/latex/wx/dataviewmodel.tex +++ b/docs/latex/wx/dataviewmodel.tex @@ -56,9 +56,8 @@ to the data in the list model. Currently wxWidgets provides the following models apart from the base model: -\helpref{wxDataViewIndexListModel}{wxdataviewindexlistmodel}. -It is planned to add helper classes for simple tree -and list stores in the future. +\helpref{wxDataViewIndexListModel}{wxdataviewindexlistmodel}, +\helpref{wxDataViewTreeStore}{wxdataviewtreestore}. \wxheading{Derived from} diff --git a/docs/latex/wx/dataviewtreestore.tex b/docs/latex/wx/dataviewtreestore.tex new file mode 100644 index 0000000000..66505a5edc --- /dev/null +++ b/docs/latex/wx/dataviewtreestore.tex @@ -0,0 +1,143 @@ + +\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} + + + +\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. -- 2.45.2