wxWidgets/docs/latex/wx/dataviewindexlistmodel.tex
Robert Roebling 8cb475f139 doc syntax corrections
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@48422 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2007-08-28 09:04:04 +00:00

106 lines
3.5 KiB
TeX

\section{\class{wxDataViewIndexListModel}}\label{wxdataviewindexlistmodel}
wxDataViewIndexListModel is a specialized data model which lets
you address an item by its position (row) rather than its
wxDataViewItem (which you can obtain from this class).
This model also provides its own
\helpref{Compare}{wxdataviewindexlistmodelcompare} method
which sorts the model's data by the index.
\wxheading{Derived from}
\helpref{wxDataViewModel}{wxdataviewmodel}
\wxheading{Include files}
<dataview.h>
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxDataViewIndexListModel::wxDataViewIndexListModel}\label{wxdataviewindexlistmodelwxdataviewindexlistmodel}
\func{}{wxDataViewIndexListModel}{\param{unsigned int }{initial\_size = 0}}
Constructor.
\membersection{wxDataViewIndexListModel::\destruct{wxDataViewIndexListModel}}\label{wxdataviewindexlistmodeldtor}
\func{}{\destruct{wxDataViewIndexListModel}}{\void}
Destructor.
\membersection{wxDataViewIndexListModel::Compare}\label{wxdataviewindexlistmodelcompare}
\func{int}{Compare}{\param{const wxDataViewItem\& }{item1}, \param{const wxDataViewItem\& }{item2}, \param{unsigned int }{column}, \param{bool }{ascending}}
Compare method that sorts the items by their index.
\membersection{wxDataViewIndexListModel::GetItem}\label{wxdataviewindexlistmodelgetitem}
\constfunc{wxDataViewItem}{GetItem}{\param{unsigned int }{row}}
Returns the wxDataViewItem at the given {\it row}.
\membersection{wxDataViewIndexListModel::GetRow}\label{wxdataviewindexlistmodelgetrow}
\constfunc{unsigned int}{GetRow}{\param{const wxDataViewItem\& }{item}}
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::RowAppended}\label{wxdataviewindexlistmodelrowappended}
\func{void}{RowAppended}{\void}
Call this after a row has been appended to the model.
\membersection{wxDataViewIndexListModel::RowChanged}\label{wxdataviewindexlistmodelrowchanged}
\func{void}{RowChanged}{\param{unsigned int }{row}}
Call this after a row has been changed.
\membersection{wxDataViewIndexListModel::RowDeleted}\label{wxdataviewindexlistmodelrowdeleted}
\func{void}{RowDeleted}{\param{unsigned int }{row}}
Call this after a row has been deleted.
\membersection{wxDataViewIndexListModel::RowInserted}\label{wxdataviewindexlistmodelrowinserted}
\func{void}{RowInserted}{\param{unsigned int }{before}}
Call this after a row has been inserted at the given position.
\membersection{wxDataViewIndexListModel::RowPrepended}\label{wxdataviewindexlistmodelrowprepended}
\func{void}{RowPrepended}{\void}
Call this after a row has been prepended to the model.
\membersection{wxDataViewIndexListModel::RowValueChanged}\label{wxdataviewindexlistmodelrowvaluechanged}
\func{void}{RowValueChanged}{\param{unsigned int }{row}, \param{unsigned int }{col}}
Call this after a value has been changed.
\membersection{wxDataViewIndexListModel::SetValue}\label{wxdataviewindexlistmodelsetvalue}
\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.