documentation for window ids allocation and wxIdManager (patch 1870570)

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

diff --git a/docs/latex/wx/dataviewmodel.tex b/docs/latex/wx/dataviewmodel.tex
index 003a46acc8fabbbbb82b71dd09727d0ea980663a..c14c20776c123a546a3f07bd4254e73eecc71e91 100644 (file)
--- a/docs/latex/wx/dataviewmodel.tex
+++ b/docs/latex/wx/dataviewmodel.tex
@@ -38,7 +38,7 @@ plural forms for notification of addition, change
 or removal of several item at once. See 
 \helpref{ItemsAdded}{wxdataviewmodelitemsadded},
 \helpref{ItemsDeleted}{wxdataviewmodelitemsdeleted},
-\helpref{ItemsChanged}{wxdataviewmodelitemschanged},
+\helpref{ItemsChanged}{wxdataviewmodelitemschanged}.
 
 Note that wxDataViewModel does not define the position or
 index of any item in the control because different controls
@@ -66,7 +66,7 @@ from the base model:
 
 Note that wxDataViewModel is reference counted, derives from 
 \helpref{wxObjectRefData}{wxobjectrefdata} and cannot be deleted
-directly as it can be shares by several wxDataViewCtrl. This
+directly as it can be shared by several wxDataViewCtrls. This
 implies that you need to decrease the reference count after
 associating the model with a control like this:
 
@@ -96,12 +96,14 @@ associating the model with a control like this:
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxDataViewModel::wxDataViewModel}\label{wxdataviewmodelwxdataviewmodel}
 
 \func{}{wxDataViewModel}{\void}
 
 Constructor.
 
+
 \membersection{wxDataViewModel::\destruct{wxDataViewModel}}\label{wxdataviewmodeldtor}
 
 \func{}{\destruct{wxDataViewModel}}{\void}
@@ -109,6 +111,7 @@ Constructor.
 Destructor. This should not be called directly. Use DecRef() instead.
 
 
+
 \membersection{wxDataViewModel::AddNotifier}\label{wxdataviewmodeladdnotifier}
 
 \func{void}{AddNotifier}{\param{wxDataViewModelNotifier* }{notifier}}
@@ -116,11 +119,14 @@ Destructor. This should not be called directly. Use DecRef() instead.
 Adds a \helpref{wxDataViewModelNotifier}{wxdataviewmodelnotifier}
 to the model.
 
+
 \membersection{wxDataViewModel::Cleared}\label{wxdataviewmodelcleared}
 
 \func{virtual bool}{Cleared}{\void}
 
-Called to inform the model that all data has been deleted.
+Called to inform the model that all data has been cleared. The
+control will reread the data from the model again.
+
 
 \membersection{wxDataViewModel::Compare}\label{wxdataviewmodelcompare}
 
@@ -132,12 +138,24 @@ Override this for a different sorting behaviour.
 
 See also \helpref{HasDefaultCompare}{wxdataviewmodelhasdefaultcompare}.
 
+
+\membersection{wxDataViewModel::GetAttr}\label{wxdataviewmodelgetattr}
+
+\func{bool}{GetAttr}{\param{const wxDataViewItem\& }{item}, \param{unsigned int }{col}, \param{wxDataViewItemAttr\& }{attr}}
+
+Oberride this to indicate that the item has special font attributes.
+This only affects the 
+\helpref{wxDataViewTextRendererText}{wxdataviewtextrendererattr} renderer.
+
+See also \helpref{wxDataViewItemAttr}{wxdataviewitemattr}.
+
 \membersection{wxDataViewModel::GetColumnCount}\label{wxdataviewmodelgetcolumncount}
 
 \constfunc{virtual unsigned int}{GetColumnCount}{\void}
 
 Override this to indicate the number of columns in the model.
 
+
 \membersection{wxDataViewModel::GetColumnType}\label{wxdataviewmodelgetcolumntype}
 
 \constfunc{virtual wxString}{GetColumnType}{\param{unsigned int }{col}}
@@ -146,6 +164,7 @@ Override this to indicate what type of data is stored in the
 column specified by {\it col}. This should return a string
 indicating the type of data as reported by \helpref{wxVariant}{wxvariant}.
 
+
 \membersection{wxDataViewModel::GetChildren}\label{wxdataviewmodelgetchildren}
 
 \constfunc{virtual unsigned int}{GetChildren}{\param{const wxDataViewItem\& }{item}, \param{wxDataViewItemArray\& }{children} }
@@ -153,6 +172,7 @@ indicating the type of data as reported by \helpref{wxVariant}{wxvariant}.
 Override this so the control can query the child items of
 an item. Returns the number of items.
 
+
 \membersection{wxDataViewModel::GetParent}\label{wxdataviewmodelgetparent}
 
 \constfunc{virtual wxDataViewItem}{GetParent}{\param{const wxDataViewItem\& }{item}}
@@ -161,6 +181,7 @@ Override this to indicate which wxDataViewItem representing the parent
 of {\it item} or an invalid wxDataViewItem if the the root item is
 the parent item.
 
+
 \membersection{wxDataViewModel::GetValue}\label{wxdataviewmodelgetvalue}
 
 \constfunc{virtual void}{GetValue}{\param{wxVariant\& }{variant}, \param{const wxDataViewItem\& }{item}, \param{unsigned int }{col}}
@@ -169,6 +190,7 @@ Override this to indicate the value of {\it item}
 A \helpref{wxVariant}{wxvariant} is used to store the data.
 
 
+
 \membersection{wxDataViewModel::HasContainerColumns}\label{wxdataviewmodelhascontainercolumns}
 
 \constfunc{virtual bool}{HasContainerColumns}{\param{const wxDataViewItem\& }{item}}
@@ -178,6 +200,7 @@ acts as a headline (or for categorisation) or if it also
 acts a normal item with entries for futher columns. By 
 default returns {\it false}.
 
+
 \membersection{wxDataViewModel::HasDefaultCompare}\label{wxdataviewmodelhasdefaultcompare}
 
 \constfunc{virtual bool}{HasDefaultCompare}{\void}
@@ -190,6 +213,7 @@ order (e.g. by index or order of appearance) is required, then this
 should be used. See also \helpref{wxDataViewIndexListModel}{wxdataviewindexlistmodel}
 for a model which makes use of this.
 
+
 \membersection{wxDataViewModel::IsContainer}\label{wxdataviewmodeliscontainer}
 
 \constfunc{virtual bool}{IsContainer}{\param{const wxDataViewItem\& }{item}}
@@ -197,6 +221,7 @@ for a model which makes use of this.
 Override this to indicate of {\it item} is a container, i.e. if
 it can have child items.
 
+
 \membersection{wxDataViewModel::ItemAdded}\label{wxdataviewmodelitemadded}
 
 \func{virtual bool}{ItemAdded}{\param{const wxDataViewItem\& }{parent}, \param{const wxDataViewItem\& }{item}}
@@ -204,6 +229,7 @@ it can have child items.
 Call this to inform the model that an item has been added
 to the data.
 
+
 \membersection{wxDataViewModel::ItemChanged}\label{wxdataviewmodelitemchanged}
 
 \func{virtual bool}{ItemChanged}{\param{const wxDataViewItem\& }{item}}
@@ -213,6 +239,14 @@ Call this to inform the model that an item has changed.
 This will eventually emit a wxEVT\_DATAVIEW\_ITEM\_VALUE\_CHANGED
 event (in which the column fields will not be set) to the user. 
 
+
+\membersection{wxDataViewModel::ItemDeleted}\label{wxdataviewmodelitemdeleted}
+
+\func{virtual bool}{ItemDeleted}{\param{const wxDataViewItem\& }{parent}, \param{const wxDataViewItem\& }{item}}
+
+Call this to inform the model that an item has been deleted from the data.
+
+
 \membersection{wxDataViewModel::ItemsAdded}\label{wxdataviewmodelitemsadded}
 
 \func{virtual bool}{ItemsAdded}{\param{const wxDataViewItem\& }{parent}, \param{const wxDataViewItemArray\& }{items}}
@@ -220,6 +254,7 @@ event (in which the column fields will not be set) to the user.
 Call this to inform the model that several items have been added
 to the data.
 
+
 \membersection{wxDataViewModel::ItemsChanged}\label{wxdataviewmodelitemschanged}
 
 \func{virtual bool}{ItemsChanged}{\param{const wxDataViewItemArray\& }{items}}
@@ -229,18 +264,21 @@ Call this to inform the model that several items have changed.
 This will eventually emit wxEVT\_DATAVIEW\_ITEM\_VALUE\_CHANGED
 events (in which the column fields will not be set) to the user. 
 
+
 \membersection{wxDataViewModel::ItemsDeleted}\label{wxdataviewmodelitemsdeleted}
 
 \func{virtual bool}{ItemsDeleted}{\param{const wxDataViewItem\& }{parent}, \param{const wxDataViewItemArray\& }{items}}
 
 Call this to inform the model that several items have been deleted.
 
+
 \membersection{wxDataViewModel::RemoveNotifier}\label{wxdataviewmodelremovenotifier}
 
 \func{void}{RemoveNotifier}{\param{wxDataViewModelNotifier* }{notifier}}
 
 Remove the {\it notifier} from the list of notifiers.
 
+
 \membersection{wxDataViewModel::Resort}\label{wxdataviewmodelresort}
 
 \func{virtual void}{Resort}{\void}
@@ -248,6 +286,7 @@ Remove the {\it notifier} from the list of notifiers.
 Call this to initiate a resort after the sort function has
 been changed.
 
+
 \membersection{wxDataViewModel::SetValue}\label{wxdataviewmodelsetvalue}
 
 \func{virtual bool}{SetValue}{\param{const wxVariant\& }{variant}, \param{const wxDataViewItem\& }{item}, \param{unsigned int }{col}}
@@ -258,6 +297,7 @@ this method after the user changed some data in the view.
 Afterwards \helpref{ValueChanged}{wxdataviewmodelvaluechanged}
 has to be called!
 
+
 \membersection{wxDataViewModel::ValueChanged}\label{wxdataviewmodelvaluechanged}
 
 \func{virtual bool}{ValueChanged}{\param{const wxDataViewItem\& }{item}, \param{unsigned int }{col}}