Quark
0.1
|
An abstract base class for table data models, i.e., models in which every row represents an instance of the same type of object, and each column represents a field of that object. More...
#include <AbstractTableModel.h++>
Public Types | |
enum | Option { None = 0, Sorted = 1 << 0, ReverseSorted = 1 << 2 } |
Model options. More... | |
Public Member Functions | |
virtual | ~AbstractTableModel () |
Destructor. More... | |
virtual int | columnCount (const QModelIndex &parent=QModelIndex()) const |
Specified by QAbstractItemModel. More... | |
virtual int | rowCount (const QModelIndex &parent=QModelIndex()) const |
Specified by QAbstractItemModel. More... | |
virtual QVariant | data (const QModelIndex &index, int role=Qt::DisplayRole) const |
Specified by QAbstractItemModel. More... | |
virtual bool | setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole) |
Specified by QAbstractItemModel. More... | |
virtual bool | removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) |
Specified by QAbstractItemModel. More... | |
virtual bool | hasChildren (const QModelIndex &parent=QModelIndex()) const |
Specified by QAbstractItemModel. More... | |
virtual QVariant | headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const |
Specified by QAbstractItemModel. More... | |
virtual QModelIndex | index (int row, int column, const QModelIndex &parent=QModelIndex()) const |
Specified by QAbstractItemModel. More... | |
virtual QModelIndex | parent (const QModelIndex &index) const |
Specified by QAbstractItemModel. More... | |
virtual Qt::ItemFlags | flags (const QModelIndex &index) const |
Specified by QAbstractItemModel. More... | |
virtual QStringList | mimeTypes () const |
Specified by QAbstractItemModel. More... | |
virtual QMimeData * | mimeData (const QModelIndexList &indexes) const |
Specified by QAbstractItemModel. More... | |
virtual bool | dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) |
Specified by QAbstractItemModel. More... | |
virtual int | itemCount () const =0 |
Returns the number of items in the model. More... | |
void | clear () |
Removes all items from the model. More... | |
bool | isEmpty () const |
Tests if the model is empty. More... | |
void | addItem (T *item) |
Adds an item to the model. More... | |
void | insertItemAt (T *item, int row) |
Inserts an item into the model at the given row position. More... | |
T * | getItemAt (int row) const |
Returns the item in the specified row. More... | |
T * | takeItemAt (int row) |
Removes and returns the item at the specified row. More... | |
void | removeItem (T *item) |
Removes and deletes the specified item from the model. More... | |
void | removeItemAt (int row) |
Removes and deletes the item at the specified row. More... | |
void | updateItem (T *item) |
Notifies the model that the specified item in the model has changed in some way. More... | |
void | updateItemAt (int row) |
Notifies the model that the item in the given row has changed in some way. More... | |
virtual int | indexOf (const T *item) const =0 |
Returns the row position of the given item in the model. More... | |
bool | moveItemDownAt (int row) |
Moves the given row down one position in the model. More... | |
bool | moveItemUpAt (int row) |
Moves the given row up one position in the model. More... | |
int | indexOfItemEqualTo (const T &item) const |
bool | containsItemEqualTo (const T &item) const |
virtual QString | getRowName (int row) const |
Returns the name of the given row. More... | |
virtual QVariant | getFieldValue (const T &item, int field) const =0 |
Returns the value of the given field of an object. More... | |
virtual QVariant | getFieldValueForRole (const T &item, int field, int role) const |
virtual QVariant | getFieldValueForRole (int field, int role) const |
virtual QVariant | getSortValue (const T &item, int field) const |
virtual bool | write (OS &stream) const |
virtual bool | read (IS &stream) |
Q_DECLARE_FLAGS (Options, Option) | |
void | setEditable (bool editable) |
Sets the editability of the model. More... | |
bool | isEditable () const |
Tests the editability of the model. More... | |
bool | isSorted () const |
Tests if the model is a sorted model. More... | |
int | fieldCount () const |
Returns the number of fields in the model. More... | |
const Field & | getField (int field) const |
Returns the specified field of the model. More... | |
QString | getFieldName (int field) const |
Returns the name of the specified field. More... | |
Static Public Attributes | |
static const int | DescriptionRole |
An item's description role. More... | |
static const int | SortRole |
An item's sort role. More... | |
Protected Member Functions | |
AbstractTableModel (Options options=0, QObject *parent=NULL) | |
Constructs an AbstractTableModel with the specified options. More... | |
virtual QIcon | getIcon (const T &item) const |
Returns the icon for a given item, if any. More... | |
virtual QSize | getSize (const T &item) const |
Returns the preferred display size of a given item, if any. More... | |
virtual Qt::AlignmentFlag | getRowHeaderAlignment () const |
Returns the preferred row (vertical) header label alignment. More... | |
virtual void | setFieldValue (T *item, int field, const QVariant &value) |
Sets the value of an edited field. More... | |
virtual void | setFieldChecked (T *item, int field, bool checked) |
Sets the checked state of a checkable field. More... | |
virtual bool | isFieldEditable (const T &item, int field) const |
Tests if a field of a given item is editable. More... | |
virtual bool | isFieldCheckable (const T &item, int field) const |
Tests if a field of a given item is checkable. More... | |
virtual bool | isFieldChecked (const T &item, int field) const |
Tests if a field of a given item is currently checked. More... | |
virtual bool | isDraggable (const T &item) const |
Tests if a given item can be dragged. More... | |
virtual bool | isDroppable (const T &item) const |
Tests if a given item can be dropped onto. More... | |
virtual bool | isRootDroppable () const |
Tests if new item(s) can be dropped onto a non-existent rows in the model. More... | |
virtual void | itemAdded (const T *item) |
Called when an item has been added to the model. More... | |
virtual void | itemUpdated (const T &item) |
Called when an item has been updated in the model. More... | |
virtual void | itemRemoved (const T &item) |
Called when an item is about to be removed from the model. More... | |
virtual T * | getAt (int row) const =0 |
Returns the item at the given row. More... | |
virtual T * | takeAt (int row)=0 |
Removes and returns the item at the given row. More... | |
virtual void | insertAt (T *item, int row)=0 |
Inserts an item at the given row, or at the end if the row is negative. More... | |
virtual void | removeAll ()=0 |
Removes all items from the model. More... | |
virtual int | getSortIndex (const T &item) const |
Calculates the row at which a new item should be inserted in a presumably sorted model. More... | |
virtual bool | dropOtherMimeData (const QMimeData *mimeData, Qt::DropAction action, int row, int column, const QModelIndex &parent) |
Handles the dropping of MIME data with a MIME-type that is supported by (but not native to) this model. More... | |
virtual QStringList | otherMimeTypes () const |
Returns a list of additional MIME-types that can be dropped onto the model. More... | |
virtual QString | itemMimeType () const |
Returns the model's native MIME-type. More... | |
virtual void | writeProlog (OS &stream) const |
Writes any necessary prolog (e.g., an XML open-tag) when serializing items to be dragged out of the model. More... | |
virtual void | writeItem (const T &item, OS &stream) const |
Serializes an item that is being dragged out of the model. More... | |
virtual void | writeEpilog (OS &stream) const |
Writes any necessary epilog (e.g., an XML close-tag) when serializing items to be dragged out of the model. More... | |
virtual bool | readProlog (IS &stream) |
Reads any necessary prolog (e.g., an XML open-tag) when deserializing items that are being dropped into the model. More... | |
virtual T * | readItem (IS &stream) |
Deserializes an item that is being dropped into the model. More... | |
virtual bool | readEpilog (IS &stream) |
Reads any necessary epilog (e.g., an XML close-tag) when deserializing items that are being dropped into the model. More... | |
Field & | addField (const QString &name) |
Adds a new field to the model. More... | |
An abstract base class for table data models, i.e., models in which every row represents an instance of the same type of object, and each column represents a field of that object.
Subclasses must implement getFieldValue() to map members of an object to fields in the table.
This class does not specify the data structure for storing the model's contents. Subclasses must implement itemCount(), indexOf(), getAt(), takeAt(), insertAt(), and removeAll() to provide a storage and retrieval mechanism for the items. See BasicTableModel for a default implementation that stores items in a QVector.
If the model supports drag and/or drop, data streams of the specified type will be instantiated to serialize/deserialize the dragged objects.
T | The type of the objects contained in this model. The class must implement the less-than operator. |
IS | A class for deserializing objects of type T. |
OS | A class for serializing objects of type T. |
|
inherited |
|
virtual |
Destructor.
|
protected |
Constructs an AbstractTableModel with the specified options.
options | Options for this model. |
parent | The parent object. |
|
protectedinherited |
Adds a new field to the model.
name | The name of the field. This will be used as the header label for the corresponding column. |
void addItem | ( | T * | item | ) |
Adds an item to the model.
If the model is sorted, the item is inserted at the appropriate sort position; otherwise, it is added at the end.
item | The item. The model takes ownership of the object. |
void clear | ( | ) |
Removes all items from the model.
All items in the model are automatically deleted.
|
virtual |
Specified by QAbstractItemModel.
bool containsItemEqualTo | ( | const T & | item | ) | const |
|
virtual |
Specified by QAbstractItemModel.
|
virtual |
Specified by QAbstractItemModel.
|
protectedvirtual |
Handles the dropping of MIME data with a MIME-type that is supported by (but not native to) this model.
The default implementation is a no-op that returns false
.
mimeData | The MIME data. |
action | The drop action. |
row | The row onto which the data is being dropped. |
column | The column onto which the data is being dropped. |
parent | The parent index. |
true
if the drop was handled successfully, false
otherwise.
|
inherited |
Returns the number of fields in the model.
|
virtual |
Specified by QAbstractItemModel.
|
protectedpure virtual |
Returns the item at the given row.
Implemented in BasicTableModel< T, IS, OS >, BasicTableModel< QString >, and BasicTableModel< RecentFile >.
|
inherited |
Returns the specified field of the model.
|
inherited |
Returns the name of the specified field.
|
pure virtual |
Returns the value of the given field of an object.
This is the display value for the corresponding column of the model.
item | The item. |
field | The field number. |
Implemented in RecentFileTableModel, SearchPathModel, and StringListModel.
|
virtual |
|
virtual |
|
protectedvirtual |
Returns the icon for a given item, if any.
Reimplemented in SearchPathModel.
T* getItemAt | ( | int | row | ) | const |
Returns the item in the specified row.
row | The row. |
NULL
if the row is invalid.
|
protectedvirtual |
Returns the preferred row (vertical) header label alignment.
|
virtual |
Returns the name of the given row.
This name will be used for the corresponding label in a view's vertical header.
row | The row. |
|
protectedvirtual |
Returns the preferred display size of a given item, if any.
|
protectedvirtual |
Calculates the row at which a new item should be inserted in a presumably sorted model.
The default implementation does a binary search to find the position.
|
virtual |
|
virtual |
Specified by QAbstractItemModel.
|
virtual |
Specified by QAbstractItemModel.
|
virtual |
Specified by QAbstractItemModel.
|
pure virtual |
Returns the row position of the given item in the model.
item | The item. |
Implemented in BasicTableModel< T, IS, OS >, BasicTableModel< QString >, and BasicTableModel< RecentFile >.
int indexOfItemEqualTo | ( | const T & | item | ) | const |
|
protectedpure virtual |
Inserts an item at the given row, or at the end if the row is negative.
Implemented in BasicTableModel< T, IS, OS >, BasicTableModel< QString >, and BasicTableModel< RecentFile >.
void insertItemAt | ( | T * | item, |
int | row | ||
) |
Inserts an item into the model at the given row position.
item | The item. The model takes ownership of the object. |
row | The row at which to insert the item. If negative, inserts the item after the last row. |
|
protectedvirtual |
Tests if a given item can be dragged.
|
protectedvirtual |
Tests if a given item can be dropped onto.
|
inlineinherited |
Tests the editability of the model.
bool isEmpty | ( | ) | const |
Tests if the model is empty.
|
protectedvirtual |
Tests if a field of a given item is checkable.
item | The item. |
field | The field number. |
true
if the field is checkable for this item, false
otherwise.
|
protectedvirtual |
Tests if a field of a given item is currently checked.
|
protectedvirtual |
Tests if a field of a given item is editable.
item | The item. |
field | The field number. |
true
if the field is editable for this item, false
otherwise.
|
protectedvirtual |
Tests if new item(s) can be dropped onto a non-existent rows in the model.
|
inherited |
Tests if the model is a sorted model.
|
protectedvirtual |
Called when an item has been added to the model.
The default implementation is a no-op.
|
pure virtual |
Returns the number of items in the model.
Implemented in BasicTableModel< T, IS, OS >, BasicTableModel< QString >, and BasicTableModel< RecentFile >.
|
protectedvirtual |
Returns the model's native MIME-type.
Reimplemented in RecentFileTableModel.
|
protectedvirtual |
Called when an item is about to be removed from the model.
The default implementation is a no-op.
|
protectedvirtual |
Called when an item has been updated in the model.
The default implementation is a no-op.
|
virtual |
Specified by QAbstractItemModel.
|
virtual |
Specified by QAbstractItemModel.
bool moveItemDownAt | ( | int | row | ) |
Moves the given row down one position in the model.
row | The row to move. If the row is the last row, the call will be a no-op. |
bool moveItemUpAt | ( | int | row | ) |
Moves the given row up one position in the model.
row | The row to move. If the row is the first row, the call will be a no-op. |
|
protectedvirtual |
Returns a list of additional MIME-types that can be dropped onto the model.
The default implementation returns an empty list.
|
virtual |
Specified by QAbstractItemModel.
|
inherited |
|
virtual |
|
protectedvirtual |
Reads any necessary epilog (e.g., an XML close-tag) when deserializing items that are being dropped into the model.
This method is called at the end of a drop operation. The default implementation is a no-op.
stream | The stream from which items are being deserialized. |
|
protectedvirtual |
Deserializes an item that is being dropped into the model.
This method is called once for each item that is being dropped during a drop operation. The default implementation is a no-op.
stream | The stream from which items are being deserialized. |
Reimplemented in RecentFileTableModel.
|
protectedvirtual |
Reads any necessary prolog (e.g., an XML open-tag) when deserializing items that are being dropped into the model.
This method is called at the beginning of a drop operation. The default implementation is a no-op.
stream | The stream from which items are being deserialized. |
|
protectedpure virtual |
Removes all items from the model.
All rows are removed.
Implemented in BasicTableModel< T, IS, OS >, BasicTableModel< QString >, and BasicTableModel< RecentFile >.
void removeItem | ( | T * | item | ) |
Removes and deletes the specified item from the model.
item | The item to remove. If this item is not actually in the model, the call will be a no-op. |
void removeItemAt | ( | int | row | ) |
Removes and deletes the item at the specified row.
row | The row. |
|
virtual |
Specified by QAbstractItemModel.
|
virtual |
Specified by QAbstractItemModel.
|
virtual |
Specified by QAbstractItemModel.
|
inlineinherited |
Sets the editability of the model.
|
protectedvirtual |
Sets the checked state of a checkable field.
|
protectedvirtual |
Sets the value of an edited field.
|
protectedpure virtual |
Removes and returns the item at the given row.
Implemented in BasicTableModel< T, IS, OS >, BasicTableModel< QString >, and BasicTableModel< RecentFile >.
T* takeItemAt | ( | int | row | ) |
Removes and returns the item at the specified row.
The model relinquishes ownership of the returned item, so it must eventually be deleted by the caller.
row | The row. |
NULL
if there is no item in that row. void updateItem | ( | T * | item | ) |
Notifies the model that the specified item in the model has changed in some way.
The model will invoke the appropriate signal(s) to notify any attached views that the corresponding cells need to be redrawn.
item | The item that changed. If this item is not actually in the model, the call will be a no-op. |
void updateItemAt | ( | int | row | ) |
Notifies the model that the item in the given row has changed in some way.
The model will invoke the appropriate signal(s) to notify any attached views that the corresponding cells need to be redrawn.
row | The row of the item that changed. |
|
virtual |
|
protectedvirtual |
Writes any necessary epilog (e.g., an XML close-tag) when serializing items to be dragged out of the model.
This method is called at the end of a drag operation. The default implementation is a no-op.
stream | The stream to which items are being serialized. |
|
protectedvirtual |
Serializes an item that is being dragged out of the model.
This method is called once for each item that is being dragged during a drag operation. The default implementation is a no-op.
item | The item to serialize. |
stream | The stream to which items are being serialized. |
|
protectedvirtual |
Writes any necessary prolog (e.g., an XML open-tag) when serializing items to be dragged out of the model.
This method is called at the beginning of a drag operation. The default implementation is a no-op.
stream | The stream to which items are being serialized. |
|
staticinherited |
An item's description role.
|
staticinherited |
An item's sort role.