git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/dataviewindexlistmodel.tex

... / ...

Commit	Line	Data
	1
	2	\section{\class{wxDataViewIndexListModel}}\label{wxdataviewindexlistmodel}
	3
	4	wxDataViewIndexListModel is a specialized data model which lets
	5	you address an item by its position (row) rather than its
	6	wxDataViewItem (which you can obtain from this class).
	7	This model also provides its own
	8	\helpref{Compare}{wxdataviewindexlistmodelcompare} method
	9	which sorts the model's data by the index.
	10
	11
	12	\wxheading{Derived from}
	13
	14	\helpref{wxDataViewModel}{wxdataviewmodel}
	15
	16	\wxheading{Include files}
	17
	18	<dataview.h>
	19
	20	\latexignore{\rtfignore{\wxheading{Members}}}
	21
	22
	23	\membersection{wxDataViewIndexListModel::wxDataViewIndexListModel}\label{wxdataviewindexlistmodelwxdataviewindexlistmodel}
	24
	25	\func{}{wxDataViewIndexListModel}{\param{unsigned int }{initial\_size = 0}}
	26
	27	Constructor.
	28
	29	\membersection{wxDataViewIndexListModel::\destruct{wxDataViewIndexListModel}}\label{wxdataviewindexlistmodeldtor}
	30
	31	\func{}{\destruct{wxDataViewIndexListModel}}{\void}
	32
	33	Destructor.
	34
	35	\membersection{wxDataViewIndexListModel::Compare}\label{wxdataviewindexlistmodelcompare}
	36
	37	\func{int}{Compare}{\param{const wxDataViewItem\& }{item1}, \param{const wxDataViewItem\& }{item2}, \param{unsigned int }{column}, \param{bool }{ascending}}
	38
	39	Compare method that sorts the items by their index.
	40
	41	\membersection{wxDataViewIndexListModel::GetAttr}\label{wxdataviewindexlistmodelgetattr}
	42
	43	\func{bool}{GetAttr}{\param{unsigned int }{row}, \param{unsigned int }{col}, \param{wxDataViewItemAttr\& }{attr}}
	44
	45	Oberride this to indicate that the row has special font attributes.
	46	This only affects the
	47	\helpref{wxDataViewTextRendererText}{wxdataviewtextrendererattr} renderer.
	48
	49	See also \helpref{wxDataViewItemAttr}{wxdataviewitemattr}.
	50
	51	\membersection{wxDataViewIndexListModel::GetItem}\label{wxdataviewindexlistmodelgetitem}
	52
	53	\constfunc{wxDataViewItem}{GetItem}{\param{unsigned int }{row}}
	54
	55	Returns the wxDataViewItem at the given {\it row}.
	56
	57	\membersection{wxDataViewIndexListModel::GetRow}\label{wxdataviewindexlistmodelgetrow}
	58
	59	\constfunc{unsigned int}{GetRow}{\param{const wxDataViewItem\& }{item}}
	60
	61	Returns the position of given {\it item}.
	62
	63	\membersection{wxDataViewIndexListModel::GetValue}\label{wxdataviewindexlistmodelgetvalue}
	64
	65	\constfunc{void}{GetValue}{\param{wxVariant\& }{variant}, \param{unsigned int }{row}, \param{unsigned int }{col}}
	66
	67	Override this to allow getting values from the model.
	68
	69	\membersection{wxDataViewIndexListModel::RowAppended}\label{wxdataviewindexlistmodelrowappended}
	70
	71	\func{void}{RowAppended}{\void}
	72
	73	Call this after a row has been appended to the model.
	74
	75	\membersection{wxDataViewIndexListModel::RowChanged}\label{wxdataviewindexlistmodelrowchanged}
	76
	77	\func{void}{RowChanged}{\param{unsigned int }{row}}
	78
	79	Call this after a row has been changed.
	80
	81	\membersection{wxDataViewIndexListModel::RowDeleted}\label{wxdataviewindexlistmodelrowdeleted}
	82
	83	\func{void}{RowDeleted}{\param{unsigned int }{row}}
	84
	85	Call this after a row has been deleted.
	86
	87	\membersection{wxDataViewIndexListModel::RowInserted}\label{wxdataviewindexlistmodelrowinserted}
	88
	89	\func{void}{RowInserted}{\param{unsigned int }{before}}
	90
	91	Call this after a row has been inserted at the given position.
	92
	93	\membersection{wxDataViewIndexListModel::RowPrepended}\label{wxdataviewindexlistmodelrowprepended}
	94
	95	\func{void}{RowPrepended}{\void}
	96
	97	Call this after a row has been prepended to the model.
	98
	99	\membersection{wxDataViewIndexListModel::RowValueChanged}\label{wxdataviewindexlistmodelrowvaluechanged}
	100
	101	\func{void}{RowValueChanged}{\param{unsigned int }{row}, \param{unsigned int }{col}}
	102
	103	Call this after a value has been changed.
	104
	105	\membersection{wxDataViewIndexListModel::SetValue}\label{wxdataviewindexlistmodelsetvalue}
	106
	107	\func{bool}{SetValue}{\param{const wxVariant\& }{variant}, \param{unsigned int }{row}, \param{unsigned int }{col}}
	108
	109	Called in order to set a value in the model.