X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/68d7c6427b600fef5c91555c74d4c634fa03416d..63779a3de18f273c04247d74cee65f2bc6baa8ba:/docs/latex/wx/dataviewmodel.tex diff --git a/docs/latex/wx/dataviewmodel.tex b/docs/latex/wx/dataviewmodel.tex index 677d850ea7..7279f240e8 100644 --- a/docs/latex/wx/dataviewmodel.tex +++ b/docs/latex/wx/dataviewmodel.tex @@ -3,247 +3,309 @@ wxDataViewModel is the base class for all data model to be displayed by a \helpref{wxDataViewCtrl}{wxdataviewctrl}. -Currently, this class has no functionality at all and the -only existing implementation of it is the -\helpref{wxDataViewListModel}{wxdataviewlistmodel}. The -plan is to move all functionality of wxDataViewListModel -and a to-be-written wxDataViewTreeModel into wxDataViewModel -and make wxDataViewListModel and wxDataViewTreeModel subsets -of the abstract wxDataViewModel. +All other models derive from it and must implement its +pure virtual functions in order to define a complete +data model. In detail, you need to override +\helpref{IsContainer}{wxdataviewmodeliscontainer}, +\helpref{GetParent}{wxdataviewmodelgetparent}, +\helpref{GetChildren}{wxdataviewmodelgetchildren}, +\helpref{GetColumnCount}{wxdataviewmodelgetcolumncount}, +\helpref{GetColumnType}{wxdataviewmodelgetcolumntype} and +\helpref{GetValue}{wxdataviewmodelgetvalue} in order to +define the data model which acts as an interface between +your actual data and the wxDataViewCtrl. Since you will +usually also allow the wxDataViewCtrl to change your data +through its graphical interface, you will also have to override +\helpref{SetValue}{wxdataviewmodelsetvalue} which the +wxDataViewCtrl will call when a change to some data has been +commited. + +wxDataViewModel (as indeed the entire wxDataViewCtrl +code) is using \helpref{wxVariant}{wxvariant} to store data and +its type in a generic way. wxVariant can be extended to contain +almost any data without changes to the original class. + +The data that is presented through this data model is expected +to change at run-time. You need to inform the data model when +a change happened. Depending on what happened you need to call +one of the following methods: +\helpref{ValueChanged}{wxdataviewmodelvaluechanged}, +\helpref{ItemAdded}{wxdataviewmodelitemadded}, +\helpref{ItemDeleted}{wxdataviewmodelitemdeleted}, +\helpref{ItemChanged}{wxdataviewmodelitemchanged}, +\helpref{Cleared}{wxdataviewmodelcleared}. There are +plural forms for notification of addition, change +or removal of several item at once. See +\helpref{ItemsAdded}{wxdataviewmodelitemsadded}, +\helpref{ItemsDeleted}{wxdataviewmodelitemsdeleted}, +\helpref{ItemsChanged}{wxdataviewmodelitemschanged}. + +Note that wxDataViewModel does not define the position or +index of any item in the control because different controls +might display the same data differently. wxDataViewModel does +provide a \helpref{Compare}{wxdataviewmodelcompare} method +which the wxDataViewCtrl may use to sort the data either +in conjunction with a column header or without (see +\helpref{HasDefaultCompare}{wxdataviewmodelhasdefaultcompare}). + +This class maintains a list of +\helpref{wxDataViewModelNotifier}{wxdataviewmodelnotifier} +which link this class to the specific implementations on the +supported platforms so that e.g. calling +\helpref{ValueChanged}{wxdataviewmodelvaluechanged} +on this model will just call +\helpref{wxDataViewModelNotifier::ValueChanged}{wxdataviewmodelnotifiervaluechanged} +for each notifier that has been added. You can also add +your own notifier in order to get informed about any changes +to the data in the list model. + +Currently wxWidgets provides the following models apart +from the base model: +\helpref{wxDataViewIndexListModel}{wxdataviewindexlistmodel}, +\helpref{wxDataViewTreeStore}{wxdataviewtreestore}. + +Note that wxDataViewModel is reference counted, derives from +\helpref{wxObjectRefData}{wxobjectrefdata} and cannot be deleted +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: + +{\small% +\begin{verbatim} + wxDataViewCtrl *musicCtrl = new wxDataViewCtrl( this, ID_MUSIC_CTRL ); + wxDataViewModel *musicModel = new MyMusicModel; + m_musicCtrl->AssociateModel( musicModel ); + musicModel->DecRef(); // avoid memory leak !! + // add columns now +\end{verbatim} +}% \wxheading{Derived from} -\helpref{wxObject}{wxobject} +\helpref{wxObjectRefData}{wxobjectrefdata} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxAdv}{librarieslist} + + + +\latexignore{\rtfignore{\wxheading{Members}}} + + \membersection{wxDataViewModel::wxDataViewModel}\label{wxdataviewmodelwxdataviewmodel} \func{}{wxDataViewModel}{\void} Constructor. + \membersection{wxDataViewModel::\destruct{wxDataViewModel}}\label{wxdataviewmodeldtor} \func{}{\destruct{wxDataViewModel}}{\void} -Destructor. - -\section{\class{wxDataViewListModel}}\label{wxdataviewlistmodel} +Destructor. This should not be called directly. Use DecRef() instead. -wxDataViewListModel is currently the only existing variant -of a \helpref{wxDataViewModel}{wxdataviewmodel}. It allows -to define a table like data model to be displayed by a -\helpref{wxDataViewCtrl}{wxdataviewctrl}. You need to derive -from this class to define your own data model. -This class maintains a list of -\helpref{wxDataListViewListModelNotifier}{wxdataviewlistmodelnotifier} -which link this class to the specific implementations on the -supported platforms so that e.g. calling {\it ValueChanged()} -on this model will just call -\helpref{wxDataListViewListModelNotifier::ValueChanged}{wxdataviewlistmodelnotifiervaluechanged} -for each notifier that has been added. This is used both for -informing the native controls to redraw themselves and for informing -e.g. the \helpref{wxDataViewSortedListModel}{wxdataviewsortedlistmodel} -to resort itself. You can also add your own notifier in order -to get informed about any changes to the data in the list model. - -Additionally, this class maintains a list of all -\helpref{wxDataViewColumns}{wxdataviewcolumn} which -display a certain column of this list model. This is -mostly used internally. -\wxheading{Derived from} +\membersection{wxDataViewModel::AddNotifier}\label{wxdataviewmodeladdnotifier} -\helpref{wxDataViewModel}{wxdataviewmodel} +\func{void}{AddNotifier}{\param{wxDataViewModelNotifier* }{notifier}} -\wxheading{Include files} +Adds a \helpref{wxDataViewModelNotifier}{wxdataviewmodelnotifier} +to the model. - +\membersection{wxDataViewModel::Cleared}\label{wxdataviewmodelcleared} -\membersection{wxDataViewListModel::wxDataViewListModel}\label{wxdataviewlistmodelwxdataviewlistmodel} +\func{virtual bool}{Cleared}{\void} -\func{}{wxDataViewListModel}{\void} +Called to inform the model that all data has been deleted. -Constructor. -\membersection{wxDataViewListModel::\destruct{wxDataViewListModel}}\label{wxdataviewlistmodeldtor} +\membersection{wxDataViewModel::Compare}\label{wxdataviewmodelcompare} -\func{}{\destruct{wxDataViewListModel}}{\void} +\func{virtual int}{Compare}{\param{const wxDataViewItem\& }{item1}, \param{const wxDataViewItem\& }{item2}, \param{unsigned int }{column}, \param{bool }{ascending}} -Destructor. +The compare function to be used by control. The default compare function +sorts by container and other items separately and in ascending order. +Override this for a different sorting behaviour. -\membersection{wxDataViewListModel::AddNotifier}\label{wxdataviewlistmodeladdnotifier} +See also \helpref{HasDefaultCompare}{wxdataviewmodelhasdefaultcompare}. -\func{void}{AddNotifier}{\param{wxDataViewListModelNotifier* }{notifier}} -Adds {\it notifier} to the internal list of notifers. +\membersection{wxDataViewModel::GetAttr}\label{wxdataviewmodelgetattr} -See also \helpref{RemoveNotifier}{wxdataviewlistmodelremovenotifier}. +\func{bool}{GetAttr}{\param{const wxDataViewItem\& }{item}, \param{unsigned int }{col}, \param{wxDataViewItemAttr\& }{attr}} -\membersection{wxDataViewListModel::AddViewingColumn}\label{wxdataviewlistmodeladdviewingcolumn} +Oberride this to indicate that the item has special font attributes. +This only affects the +\helpref{wxDataViewTextRendererText}{wxdataviewtextrendererattr} renderer. -\func{void}{AddViewingColumn}{\param{wxDataViewColumn* }{view\_column}, \param{unsigned int }{model\_column}} +See also \helpref{wxDataViewItemAttr}{wxdataviewitemattr}. -Used internally. Used for maintaining a list of -\helpref{wxDataViewColumn}{wxdataviewcolumn} that -display a certain column of this model. +\membersection{wxDataViewModel::GetColumnCount}\label{wxdataviewmodelgetcolumncount} -\membersection{wxDataViewListModel::Cleared}\label{wxdataviewlistmodelcleared} +\constfunc{virtual unsigned int}{GetColumnCount}{\void} -\func{bool}{virtual Cleared}{\void} +Override this to indicate the number of columns in the model. -Call this if all data in your model has been cleared. -\membersection{wxDataViewListModel::GetColType}\label{wxdataviewlistmodelgetcoltype} +\membersection{wxDataViewModel::GetColumnType}\label{wxdataviewmodelgetcolumntype} -\func{virtual wxString}{GetColType}{\param{unsigned int }{col}} +\constfunc{virtual wxString}{GetColumnType}{\param{unsigned int }{col}} 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{wxDataViewListModel::GetNumberOfCols}\label{wxdataviewlistmodelgetnumberofcols} -\func{virtual unsigned int}{GetNumberOfCols}{\void} +\membersection{wxDataViewModel::GetChildren}\label{wxdataviewmodelgetchildren} -Override this to indicate, how many columns the list -model has. +\constfunc{virtual unsigned int}{GetChildren}{\param{const wxDataViewItem\& }{item}, \param{wxDataViewItemArray\& }{children} } -\membersection{wxDataViewListModel::GetNumberOfRows}\label{wxdataviewlistmodelgetnumberofrows} +Override this so the control can query the child items of +an item. Returns the number of items. -\func{virtual unsigned int}{GetNumberOfRows}{\void} -Override this to indicate, how many rows the list -model has. +\membersection{wxDataViewModel::GetParent}\label{wxdataviewmodelgetparent} -\membersection{wxDataViewListModel::GetValue}\label{wxdataviewlistmodelgetvalue} +\constfunc{virtual wxDataViewItem}{GetParent}{\param{const wxDataViewItem\& }{item}} -\func{virtual void}{GetValue}{\param{wxVariant\& }{variant}, \param{unsigned int }{col}, \param{unsigned int }{row}} +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. -Override this to indicate the value of a given value -in the list model. A \helpref{wxVariant}{wxvariant} -is used to store the data. -\membersection{wxDataViewListModel::RemoveNotifier}\label{wxdataviewlistmodelremovenotifier} +\membersection{wxDataViewModel::GetValue}\label{wxdataviewmodelgetvalue} -\func{void}{RemoveNotifier}{\param{wxDataViewListModelNotifier* }{notifier}} +\constfunc{virtual void}{GetValue}{\param{wxVariant\& }{variant}, \param{const wxDataViewItem\& }{item}, \param{unsigned int }{col}} -Removes the notifier from the list of notifiers. +Override this to indicate the value of {\it item} +A \helpref{wxVariant}{wxvariant} is used to store the data. -See also \helpref{AddNotifier}{wxdataviewlistmodeladdnotifier}. -\membersection{wxDataViewListModel::RemoveViewingColumn}\label{wxdataviewlistmodelremoveviewingcolumn} -\func{void}{RemoveViewingColumn}{\param{wxDataViewColumn* }{column}} +\membersection{wxDataViewModel::HasContainerColumns}\label{wxdataviewmodelhascontainercolumns} -Used internally. Used for maintaining a list of -\helpref{wxDataViewColumn}{wxdataviewcolumn} that -display a certain column of this model. +\constfunc{virtual bool}{HasContainerColumns}{\param{const wxDataViewItem\& }{item}} -\membersection{wxDataViewListModel::RowAppended}\label{wxdataviewlistmodelrowappended} +Override this method to indicate if a container item merely +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}. -\func{virtual bool}{RowAppended}{\void} -Call this if a row has been appended to the list model. +\membersection{wxDataViewModel::HasDefaultCompare}\label{wxdataviewmodelhasdefaultcompare} -\membersection{wxDataViewListModel::RowChanged}\label{wxdataviewlistmodelrowchanged} +\constfunc{virtual bool}{HasDefaultCompare}{\void} -\func{virtual bool}{RowChanged}{\param{unsigned int }{row}} +Override this to indicate that the model provides a default compare +function that the control should use if no wxDataViewColumn has been +chosen for sorting. Usually, the user clicks on a column header for +sorting, the data will be sorted alphanumerically. If any other +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. -Call this if the values of this row have been changed. -\membersection{wxDataViewListModel::RowDeleted}\label{wxdataviewlistmodelrowdeleted} +\membersection{wxDataViewModel::IsContainer}\label{wxdataviewmodeliscontainer} -\func{virtual bool}{RowDeleted}{\param{unsigned int }{row}} +\constfunc{virtual bool}{IsContainer}{\param{const wxDataViewItem\& }{item}} -Call this if this row has been deleted. +Override this to indicate of {\it item} is a container, i.e. if +it can have child items. -\membersection{wxDataViewListModel::RowInserted}\label{wxdataviewlistmodelrowinserted} -\func{virtual bool}{RowInserted}{\param{unsigned int }{before}} +\membersection{wxDataViewModel::ItemAdded}\label{wxdataviewmodelitemadded} -Call this if a row has been inserted. +\func{virtual bool}{ItemAdded}{\param{const wxDataViewItem\& }{parent}, \param{const wxDataViewItem\& }{item}} -\membersection{wxDataViewListModel::RowPrepended}\label{wxdataviewlistmodelrowprepended} +Call this to inform the model that an item has been added +to the data. -\func{virtual bool}{RowPrepended}{\void} -Call this if a row has been prepended. +\membersection{wxDataViewModel::ItemChanged}\label{wxdataviewmodelitemchanged} -\membersection{wxDataViewListModel::RowsReordered}\label{wxdataviewlistmodelrowsreordered} +\func{virtual bool}{ItemChanged}{\param{const wxDataViewItem\& }{item}} -\func{virtual bool}{RowsReordered}{\param{unsigned int* }{new\_order}} +Call this to inform the model that an item has changed. -Call this if the rows have been reorderd. +This will eventually emit a wxEVT\_DATAVIEW\_ITEM\_VALUE\_CHANGED +event (in which the column fields will not be set) to the user. -\membersection{wxDataViewListModel::SetValue}\label{wxdataviewlistmodelsetvalue} -\func{virtual bool}{SetValue}{\param{wxVariant\& }{variant}, \param{unsigned int }{col}, \param{unsigned int }{row}} +\membersection{wxDataViewModel::ItemDeleted}\label{wxdataviewmodelitemdeleted} -This method gets called by e.g. the wxDataViewCtrl class if a -value has been changed through its graphical interface. You -need to override this method in order to update the data in -the underlying data structur. Afterwards, -\helpref{ValueChanged}{wxdataviewlistmodelvaluechanged} is called. +\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{wxDataViewListModel::ValueChanged}\label{wxdataviewlistmodelvaluechanged} -\func{virtual bool}{ValueChanged}{\param{unsigned int }{col}, \param{unsigned int }{row}} +\membersection{wxDataViewModel::ItemsAdded}\label{wxdataviewmodelitemsadded} -Call this if a value in the model has been changed. +\func{virtual bool}{ItemsAdded}{\param{const wxDataViewItem\& }{parent}, \param{const wxDataViewItemArray\& }{items}} +Call this to inform the model that several items have been added +to the data. -\section{\class{wxDataViewSortedListModel}}\label{wxdataviewsortedlistmodel} -This class is used for sorting data. It does not contain any -data itself. Rather, it provides a sorted interface for -another list model. +\membersection{wxDataViewModel::ItemsChanged}\label{wxdataviewmodelitemschanged} -Currently, the sorting algorithm isn't thread safe. This needs -to be fixed. +\func{virtual bool}{ItemsChanged}{\param{const wxDataViewItemArray\& }{items}} -\wxheading{Derived from} +Call this to inform the model that several items have changed. -\helpref{wxDataViewListModel}{wxdataviewlistmodel} +This will eventually emit wxEVT\_DATAVIEW\_ITEM\_VALUE\_CHANGED +events (in which the column fields will not be set) to the user. -\wxheading{Include files} - +\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} -\membersection{wxDataViewSortedListModel::wxDataViewSortedListModel}\label{wxdataviewsortedlistmodelwxdataviewsortedlistmodel} +\func{void}{RemoveNotifier}{\param{wxDataViewModelNotifier* }{notifier}} -\func{}{wxDataViewSortedListModel}{\param{wxDataViewListModel* }{child}} +Remove the {\it notifier} from the list of notifiers. -Constructor. {\it child} is the child data model the data of -which this model is supposed to present in a sorted way. -\membersection{wxDataViewSortedListModel::\destruct{wxDataViewSortedListModel}}\label{wxdataviewsortedlistmodeldtor} +\membersection{wxDataViewModel::Resort}\label{wxdataviewmodelresort} -\func{}{\destruct{wxDataViewSortedListModel}}{\void} +\func{virtual void}{Resort}{\void} -Destructor. +Call this to initiate a resort after the sort function has +been changed. -\membersection{wxDataViewSortedListModel::GetAscending}\label{wxdataviewsortedlistmodelgetascending} -\func{bool}{GetAscending}{\void} +\membersection{wxDataViewModel::SetValue}\label{wxdataviewmodelsetvalue} -Returns true if the data is sorted in ascending order. +\func{virtual bool}{SetValue}{\param{const wxVariant\& }{variant}, \param{const wxDataViewItem\& }{item}, \param{unsigned int }{col}} -\membersection{wxDataViewSortedListModel::Resort}\label{wxdataviewsortedlistmodelresort} +This gets called in order to set a value in the data model. +The most common scenario is that the wxDataViewCtrl calls +this method after the user changed some data in the view. +Afterwards \helpref{ValueChanged}{wxdataviewmodelvaluechanged} +has to be called! -\func{void}{Resort}{\void} -Tell the model to resort its data. +\membersection{wxDataViewModel::ValueChanged}\label{wxdataviewmodelvaluechanged} -\membersection{wxDataViewSortedListModel::SetAscending}\label{wxdataviewsortedlistmodelsetascending} +\func{virtual bool}{ValueChanged}{\param{const wxDataViewItem\& }{item}, \param{unsigned int }{col}} -\func{void}{SetAscending}{\param{bool }{ascending}} +Call this to inform this model that a value in the model has +been changed. This is also called from wxDataViewCtrl's +internal editing code, e.g. when editing a text field +in the control. -Set the sort order of the data. +This will eventually emit a wxEVT\_DATAVIEW\_ITEM\_VALUE\_CHANGED +event to the user.