X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1ab4aff2738d8511da32e787796606646799f0ac..b3a029f0bbf8262cfe30914790802f88608ea618:/docs/latex/wx/dataviewindexlistmodel.tex diff --git a/docs/latex/wx/dataviewindexlistmodel.tex b/docs/latex/wx/dataviewindexlistmodel.tex index 74d35d2c52..a83d691c57 100644 --- a/docs/latex/wx/dataviewindexlistmodel.tex +++ b/docs/latex/wx/dataviewindexlistmodel.tex @@ -8,6 +8,13 @@ This model also provides its own \helpref{Compare}{wxdataviewindexlistmodelcompare} method which sorts the model's data by the index. +This model is special in the it is implemented differently under OS X +and other platforms. Under OS X a wxDataViewItem is always persistent +and this is also the case for this class. Under other platforms, the +meaning of a wxDataViewItem is changed to reflect a row number for +wxDataViewIndexListModel. The consequence of this is that +wxDataViewIndexListModel can be used as a virtual model with an +almost infinate number of items on platforms other than OS X. \wxheading{Derived from} @@ -38,6 +45,16 @@ Destructor. Compare method that sorts the items by their index. +\membersection{wxDataViewIndexListModel::GetAttr}\label{wxdataviewindexlistmodelgetattr} + +\func{bool}{GetAttr}{\param{unsigned int }{row}, \param{unsigned int }{col}, \param{wxDataViewItemAttr\& }{attr}} + +Oberride this to indicate that the row has special font attributes. +This only affects the +\helpref{wxDataViewTextRendererText}{wxdataviewtextrendererattr} renderer. + +See also \helpref{wxDataViewItemAttr}{wxdataviewitemattr}. + \membersection{wxDataViewIndexListModel::GetItem}\label{wxdataviewindexlistmodelgetitem} \constfunc{wxDataViewItem}{GetItem}{\param{unsigned int }{row}} @@ -50,18 +67,22 @@ Returns the wxDataViewItem at the given {\it row}. Returns the position of given {\it item}. -\membersection{wxDataViewIndexListModel::GetRowCount}\label{wxdataviewindexlistmodelgetrowcount} - -\func{unsigned int}{GetRowCount}{\void} - -Override this to indicate the number of rows. - \membersection{wxDataViewIndexListModel::GetValue}\label{wxdataviewindexlistmodelgetvalue} \constfunc{void}{GetValue}{\param{wxVariant\& }{variant}, \param{unsigned int }{row}, \param{unsigned int }{col}} Override this to allow getting values from the model. + +\membersection{wxDataViewIndexListModel::Reset}\label{wxdataviewindexlistmodelreset} + +\func{void}{Reset}{\param{unsigned int }{new\_size}} + +Call this after if the data has to be read again from +the model. This is useful after major changes when +calling the methods below (possibly thousands of times) +doesn't make sense. + \membersection{wxDataViewIndexListModel::RowAppended}\label{wxdataviewindexlistmodelrowappended} \func{void}{RowAppended}{\void} @@ -80,6 +101,14 @@ Call this after a row has been changed. Call this after a row has been deleted. +\membersection{wxDataViewIndexListModel::RowsDeleted}\label{wxdataviewindexlistmodelrowdeleted} + +\func{void}{RowsDeleted}{\param{const wxArrayInt &}{rows}} + +Call this after rows have been deleted. The array will internally +get copied and sorted in descending order so that the rows with +the highest position will be deleted first. + \membersection{wxDataViewIndexListModel::RowInserted}\label{wxdataviewindexlistmodelrowinserted} \func{void}{RowInserted}{\param{unsigned int }{before}} @@ -102,4 +131,4 @@ Call this after a value has been changed. \func{bool}{SetValue}{\param{const wxVariant\& }{variant}, \param{unsigned int }{row}, \param{unsigned int }{col}} -Called in order to set a value in the model. \ No newline at end of file +Called in order to set a value in the model.