Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QTreeModel Class Reference

#include <qtreewidget_p.h>

Inheritance diagram for QTreeModel:
Collaboration diagram for QTreeModel:

Classes

struct  SkipSorting

Public Member Functions

 QTreeModel (int columns=0, QTreeWidget *parent=nullptr)
 ~QTreeModel ()
QTreeWidgetview () const
void clear ()
void setColumnCount (int columns)
QTreeWidgetItemitem (const QModelIndex &index) const
void itemChanged (QTreeWidgetItem *item)
QModelIndex index (const QTreeWidgetItem *item, int column) const
QModelIndex index (int row, int column, const QModelIndex &parent) const override
QModelIndex parent (const QModelIndex &child) const override
int rowCount (const QModelIndex &parent) const override
int columnCount (const QModelIndex &parent=QModelIndex()) const override
bool hasChildren (const QModelIndex &parent) const override
 Returns {true} if parent has any children; otherwise returns {false}.
QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const override
bool setData (const QModelIndex &index, const QVariant &value, int role) override
bool clearItemData (const QModelIndex &index) override
QMap< int, QVariantitemData (const QModelIndex &index) const override
 Returns a map with values for all predefined roles in the model for the item at the given index.
QVariant headerData (int section, Qt::Orientation orientation, int role) const override
bool setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role) override
Qt::ItemFlags flags (const QModelIndex &index) const override
 \reimp
void sort (int column, Qt::SortOrder order) override
void ensureSorted (int column, Qt::SortOrder order, int start, int end, const QModelIndex &parent)
bool insertRows (int row, int count, const QModelIndex &) override
bool insertColumns (int column, int count, const QModelIndex &) override
bool removeRows (int row, int count, const QModelIndex &parent=QModelIndex()) override
QStringList mimeTypes () const override
 Returns the list of allowed MIME types.
QMimeDatamimeData (const QModelIndexList &indexes) const override
 Returns an object that contains serialized items of data corresponding to the list of indexes specified.
bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override
 Handles the data supplied by a drag and drop operation that ended with the given action.
Qt::DropActions supportedDropActions () const override
Qt::DropActions supportedDragActions () const override
 Returns the actions supported by the data in this model.
QMimeDatainternalMimeData () const
QModelIndex createIndexFromItem (int row, int col, QTreeWidgetItem *item) const
Public Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QObject *parent=nullptr)
 Constructs an abstract item model with the given parent.
virtual ~QAbstractItemModel ()
 Destroys the abstract item model.
Q_INVOKABLE bool hasIndex (int row, int column, const QModelIndex &parent=QModelIndex()) const
 Returns {true} if the model returns a valid QModelIndex for row and column with parent, otherwise returns {false}.
virtual Q_INVOKABLE QModelIndex sibling (int row, int column, const QModelIndex &idx) const
 Returns the sibling at row and column for the item at index, or an invalid QModelIndex if there is no sibling at that location.
virtual bool setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
 Sets the role data for the item at index to the associated value in roles, for every Qt::ItemDataRole.
virtual bool canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const
 Returns {true} if a model can accept a drop of the data.
Q_INVOKABLE Q_REVISION (6, 4) virtual bool insertRows(int row
Q_INVOKABLE Q_REVISION (6, 4) virtual bool insertColumns(int column
Q_INVOKABLE Q_REVISION (6, 4) virtual bool removeRows(int row
Q_INVOKABLE Q_REVISION (6, 4) virtual bool removeColumns(int column
Q_INVOKABLE Q_REVISION (6, 4) virtual bool moveRows(const QModelIndex &sourceParent
Q_INVOKABLE Q_REVISION (6, 4) virtual bool moveColumns(const QModelIndex &sourceParent
Q_INVOKABLE Q_REVISION (6, 4) inline bool insertRow(int row
Q_INVOKABLE Q_REVISION (6, 4) inline bool insertColumn(int column
Q_INVOKABLE Q_REVISION (6, 4) inline bool removeRow(int row
Q_INVOKABLE Q_REVISION (6, 4) inline bool removeColumn(int column
Q_INVOKABLE Q_REVISION (6, 4) inline bool moveRow(const QModelIndex &sourceParent
Q_INVOKABLE Q_REVISION (6, 4) inline bool moveColumn(const QModelIndex &sourceParent
virtual Q_INVOKABLE void fetchMore (const QModelIndex &parent)
 Fetches any available data for the items with the parent specified by the parent index.
virtual Q_INVOKABLE bool canFetchMore (const QModelIndex &parent) const
 Returns {true} if there is more data available for parent; otherwise returns {false}.
Q_INVOKABLE Q_REVISION (6, 4) virtual void sort(int column
virtual QModelIndex buddy (const QModelIndex &index) const
 Returns a model index for the buddy of the item represented by index.
virtual Q_INVOKABLE QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith|Qt::MatchWrap)) const
 Returns a list of indexes for the items in the column of the start index where data stored under the given role matches the specified value.
virtual QSize span (const QModelIndex &index) const
 Returns the row and column span of the item represented by index.
virtual QHash< int, QByteArrayroleNames () const
bool checkIndex (const QModelIndex &index, CheckIndexOptions options=CheckIndexOption::NoOption) const
virtual void multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const
QObjectparent () const
 Returns a pointer to the parent object.
Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
QString objectName () const
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
QBindable< QStringbindableObjectName ()
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
bool isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
QThreadthread () const
 Returns the thread in which the object lives.
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
void killTimer (int id)
 Kills the timer with timer identifier, id.
void killTimer (Qt::TimerId id)
template<typename T>
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
template<typename T>
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
template<typename T>
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<typename T>
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const QObjectListchildren () const
 Returns a list of child objects.
void setParent (QObject *parent)
 Makes the object a child of parent.
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
bool disconnect (const QObject *receiver, const char *member=nullptr) const
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
bool setProperty (const char *name, QVariant &&value)
QVariant property (const char *name) const
 Returns the value of the object's name property.
QList< QByteArraydynamicPropertyNames () const
QBindingStoragebindingStorage ()
const QBindingStoragebindingStorage () const
QObjectparent () const
 Returns a pointer to the parent object.
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.

Static Public Member Functions

static bool itemLessThan (const std::pair< QTreeWidgetItem *, int > &left, const std::pair< QTreeWidgetItem *, int > &right)
static bool itemGreaterThan (const std::pair< QTreeWidgetItem *, int > &left, const std::pair< QTreeWidgetItem *, int > &right)
static QList< QTreeWidgetItem * >::iterator sortedInsertionIterator (const QList< QTreeWidgetItem * >::iterator &begin, const QList< QTreeWidgetItem * >::iterator &end, Qt::SortOrder order, QTreeWidgetItem *item)
Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
template<typename Func1, typename Func2>
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
template<typename Func1, typename Func2>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
template<typename Func1>
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)

Protected Member Functions

 QTreeModel (QTreeModelPrivate &, QTreeWidget *parent=nullptr)
void emitDataChanged (QTreeWidgetItem *item, int column, const QList< int > &roles)
void beginInsertItems (QTreeWidgetItem *parent, int row, int count)
void endInsertItems ()
void beginRemoveItems (QTreeWidgetItem *parent, int row, int count)
void endRemoveItems ()
void sortItems (QList< QTreeWidgetItem * > *items, int column, Qt::SortOrder order)
void timerEvent (QTimerEvent *) override
 This event handler can be reimplemented in a subclass to receive timer events for the object.
Protected Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QAbstractItemModelPrivate &dd, QObject *parent=nullptr)
QModelIndex createIndex (int row, int column, const void *data=nullptr) const
 Creates a model index for the given row and column with the internal pointer ptr.
QModelIndex createIndex (int row, int column, quintptr id) const
 Creates a model index for the given row and column with the internal identifier, id.
void encodeData (const QModelIndexList &indexes, QDataStream &stream) const
bool decodeData (int row, int column, const QModelIndex &parent, QDataStream &stream)
void beginInsertRows (const QModelIndex &parent, int first, int last)
 Begins a row insertion operation.
void endInsertRows ()
 Ends a row insertion operation.
void beginRemoveRows (const QModelIndex &parent, int first, int last)
 Begins a row removal operation.
void endRemoveRows ()
 Ends a row removal operation.
bool beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationRow)
void endMoveRows ()
 Ends a row move operation.
void beginInsertColumns (const QModelIndex &parent, int first, int last)
 Begins a column insertion operation.
void endInsertColumns ()
 Ends a column insertion operation.
void beginRemoveColumns (const QModelIndex &parent, int first, int last)
 Begins a column removal operation.
void endRemoveColumns ()
 Ends a column removal operation.
bool beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationColumn)
 Begins a column move operation.
void endMoveColumns ()
 Ends a column move operation.
void beginResetModel ()
 Begins a model reset operation.
void endResetModel ()
 Completes a model reset operation.
void changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
 Changes the QPersistentModelIndex that is equal to the given from model index to the given to model index.
void changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
QModelIndexList persistentIndexList () const
Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
int senderSignalIndex () const
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
bool isSignalConnected (const QMetaMethod &signal) const
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
virtual void connectNotify (const QMetaMethod &signal)
virtual void disconnectNotify (const QMetaMethod &signal)
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Friends

class QTreeWidget
class QTreeWidgetPrivate
class QTreeWidgetItem
class QTreeWidgetItemPrivate
class QTreeWidgetItemIterator
class QTreeWidgetItemIteratorPrivate
struct SkipSorting

Additional Inherited Members

Public Types inherited from QAbstractItemModel
enum  LayoutChangeHint { NoLayoutChangeHint , VerticalSortHint , HorizontalSortHint }
 This enum describes the way the model changes layout. More...
enum class  CheckIndexOption { NoOption = 0x0000 , IndexIsValid = 0x0001 , DoNotUseParent = 0x0002 , ParentIsInvalid = 0x0004 }
Public Slots inherited from QAbstractItemModel
virtual bool submit ()
 Lets the model know that it should submit cached information to permanent storage.
virtual void revert ()
 Lets the model know that it should discard cached information.
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Signals inherited from QAbstractItemModel
void dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles=QList< int >())
 This signal is emitted whenever the data in an existing item changes.
void headerDataChanged (Qt::Orientation orientation, int first, int last)
 This signal is emitted whenever a header is changed.
void layoutChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)
void layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents=QList< QPersistentModelIndex >(), QAbstractItemModel::LayoutChangeHint hint=QAbstractItemModel::NoLayoutChangeHint)
void rowsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before rows are inserted into the model.
void rowsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after rows have been inserted into the model.
void rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before rows are removed from the model.
void rowsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after rows have been removed from the model.
void columnsAboutToBeInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before columns are inserted into the model.
void columnsInserted (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after columns have been inserted into the model.
void columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted just before columns are removed from the model.
void columnsRemoved (const QModelIndex &parent, int first, int last, QPrivateSignal)
 This signal is emitted after columns have been removed from the model.
void modelAboutToBeReset (QPrivateSignal)
void modelReset (QPrivateSignal)
void rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)
void rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow, QPrivateSignal)
void columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)
void columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn, QPrivateSignal)
Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
Public Attributes inherited from QAbstractItemModel
Q_INVOKABLE int count
Q_INVOKABLE int const QModelIndexparent = QModelIndex())
 Returns the parent of the model item with the given index.
Q_INVOKABLE int sourceRow
Q_INVOKABLE int int count
Q_INVOKABLE int int const QModelIndexdestinationParent
Q_INVOKABLE int int const QModelIndex int destinationChild
Q_INVOKABLE int sourceColumn
Q_INVOKABLE const QModelIndexparent = QModelIndex())
Q_INVOKABLE int const QModelIndexdestinationParent
Q_INVOKABLE int const QModelIndex int destinationChild
Q_INVOKABLE Qt::SortOrder order = Qt::AscendingOrder)
Protected Slots inherited from QAbstractItemModel
virtual void resetInternalData ()
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
Properties inherited from QObject
QString objectName
 the name of this object

Detailed Description

Definition at line 36 of file qtreewidget_p.h.

Constructor & Destructor Documentation

◆ QTreeModel() [1/2]

QTreeModel::QTreeModel ( int columns = 0,
QTreeWidget * parent = nullptr )
explicit

Constructs a tree model with a parent object and the given number of columns.

Definition at line 75 of file qtreewidget.cpp.

◆ ~QTreeModel()

QTreeModel::~QTreeModel ( )

Destroys this tree model.

Definition at line 105 of file qtreewidget.cpp.

◆ QTreeModel() [2/2]

QTreeModel::QTreeModel ( QTreeModelPrivate & dd,
QTreeWidget * parent = nullptr )
protected

Definition at line 91 of file qtreewidget.cpp.

Member Function Documentation

◆ beginInsertItems()

void QTreeModel::beginInsertItems ( QTreeWidgetItem * parent,
int row,
int count )
protected

Definition at line 798 of file qtreewidget.cpp.

◆ beginRemoveItems()

void QTreeModel::beginRemoveItems ( QTreeWidgetItem * parent,
int row,
int count )
protected

Definition at line 809 of file qtreewidget.cpp.

◆ clear()

void QTreeModel::clear ( )

Removes all items in the model.

Definition at line 120 of file qtreewidget.cpp.

◆ clearItemData()

bool QTreeModel::clearItemData ( const QModelIndex & index)
overridevirtual
Since
6.0 Removes the data stored in all the roles for the given index. Returns {true} if successful; otherwise returns {false}. The dataChanged() signal should be emitted if the data was successfully removed. The base class implementation returns {false}
See also
data(), itemData(), setData(), setItemData()

Reimplemented from QAbstractItemModel.

Definition at line 356 of file qtreewidget.cpp.

◆ columnCount()

int QTreeModel::columnCount ( const QModelIndex & index = QModelIndex()) const
overridevirtual

\reimp

Returns the number of columns in the item referred to by the given index.

Implements QAbstractItemModel.

Definition at line 289 of file qtreewidget.cpp.

◆ createIndexFromItem()

QModelIndex QTreeModel::createIndexFromItem ( int row,
int col,
QTreeWidgetItem * item ) const
inline

Definition at line 104 of file qtreewidget_p.h.

◆ data()

QVariant QTreeModel::data ( const QModelIndex & index,
int role = Qt::DisplayRole ) const
overridevirtual

\reimp

Returns the data corresponding to the given model index and role.

Implements QAbstractItemModel.

Definition at line 324 of file qtreewidget.cpp.

◆ dropMimeData()

bool QTreeModel::dropMimeData ( const QMimeData * data,
Qt::DropAction action,
int row,
int column,
const QModelIndex & parent )
overridevirtual

Handles the data supplied by a drag and drop operation that ended with the given action.

Returns {true} if the data and action were handled by the model; otherwise returns {false}.

The specified row, column and parent indicate the location of an item in the model where the operation ended. It is the responsibility of the model to complete the action at the correct location.

For instance, a drop action on an item in a QTreeView can result in new items either being inserted as children of the item specified by row, column, and parent, or as siblings of the item.

When row and column are -1 it means that the dropped data should be considered as dropped directly on parent. Usually this will mean appending the data as child items of parent. If row and column are greater than or equal zero, it means that the drop occurred just before the specified row and column in the specified parent.

The mimeTypes() member is called to get the list of acceptable MIME types. This default implementation assumes the default implementation of mimeTypes(), which returns a single default MIME type. If you reimplement mimeTypes() in your custom model to return multiple MIME types, you must reimplement this function to make use of them.

See also
supportedDropActions(), canDropMimeData(), {Using drag and drop with item views}

Reimplemented from QAbstractItemModel.

Definition at line 728 of file qtreewidget.cpp.

◆ emitDataChanged()

void QTreeModel::emitDataChanged ( QTreeWidgetItem * item,
int column,
const QList< int > & roles )
protected

Emits the dataChanged() signal for the given item. if column is -1 then all columns have changed

Definition at line 772 of file qtreewidget.cpp.

◆ endInsertItems()

void QTreeModel::endInsertItems ( )
protected

Definition at line 804 of file qtreewidget.cpp.

◆ endRemoveItems()

void QTreeModel::endRemoveItems ( )
protected

Definition at line 825 of file qtreewidget.cpp.

◆ ensureSorted()

void QTreeModel::ensureSorted ( int column,
Qt::SortOrder order,
int start,
int end,
const QModelIndex & parent )

Definition at line 563 of file qtreewidget.cpp.

◆ flags()

Qt::ItemFlags QTreeModel::flags ( const QModelIndex & index) const
overridevirtual

\reimp

Returns the flags for the item referred to the given index.

Reimplemented from QAbstractItemModel.

Definition at line 532 of file qtreewidget.cpp.

◆ hasChildren()

bool QTreeModel::hasChildren ( const QModelIndex & parent) const
overridevirtual

Returns {true} if parent has any children; otherwise returns {false}.

Use rowCount() on the parent to find out the number of children.

Note that it is undefined behavior to report that a particular index hasChildren with this method if the same index has the flag Qt::ItemNeverHasChildren set.

See also
parent(), index()

Reimplemented from QAbstractItemModel.

Definition at line 297 of file qtreewidget.cpp.

◆ headerData()

QVariant QTreeModel::headerData ( int section,
Qt::Orientation orientation,
int role ) const
overridevirtual

\reimp

Returns the header data corresponding to the given header section, orientation and data role.

Reimplemented from QAbstractItemModel.

Definition at line 493 of file qtreewidget.cpp.

◆ index() [1/2]

QModelIndex QTreeModel::index ( const QTreeWidgetItem * item,
int column ) const

Returns the model index that refers to the tree view item and column.

Definition at line 191 of file qtreewidget.cpp.

◆ index() [2/2]

QModelIndex QTreeModel::index ( int row,
int column,
const QModelIndex & parent ) const
overridevirtual

\reimp

Returns the model index with the given row, column and parent.

Implements QAbstractItemModel.

Definition at line 222 of file qtreewidget.cpp.

◆ insertColumns()

bool QTreeModel::insertColumns ( int column,
int count,
const QModelIndex & parent )
override

\reimp

Definition at line 430 of file qtreewidget.cpp.

◆ insertRows()

bool QTreeModel::insertRows ( int row,
int count,
const QModelIndex & parent )
override

\reimp

Definition at line 404 of file qtreewidget.cpp.

◆ internalMimeData()

QMimeData * QTreeModel::internalMimeData ( ) const

Definition at line 704 of file qtreewidget.cpp.

◆ item()

QTreeWidgetItem * QTreeModel::item ( const QModelIndex & index) const

Returns the tree view item corresponding to the index given.

See also
QModelIndex

Definition at line 177 of file qtreewidget.cpp.

◆ itemChanged()

void QTreeModel::itemChanged ( QTreeWidgetItem * item)

Definition at line 750 of file qtreewidget.cpp.

◆ itemData()

QMap< int, QVariant > QTreeModel::itemData ( const QModelIndex & index) const
overridevirtual

Returns a map with values for all predefined roles in the model for the item at the given index.

Reimplement this function if you want to extend the default behavior of this function to include custom roles in the map.

See also
Qt::ItemDataRole, data()

Reimplemented from QAbstractItemModel.

Definition at line 375 of file qtreewidget.cpp.

◆ itemGreaterThan()

bool QTreeModel::itemGreaterThan ( const std::pair< QTreeWidgetItem *, int > & left,
const std::pair< QTreeWidgetItem *, int > & right )
static

Returns true if the value of the left item is greater than the value of the right item.

Used by the sorting functions.

Definition at line 677 of file qtreewidget.cpp.

◆ itemLessThan()

bool QTreeModel::itemLessThan ( const std::pair< QTreeWidgetItem *, int > & left,
const std::pair< QTreeWidgetItem *, int > & right )
static

Returns true if the value of the left item is less than the value of the right item.

Used by the sorting functions.

Definition at line 662 of file qtreewidget.cpp.

◆ mimeData()

QMimeData * QTreeModel::mimeData ( const QModelIndexList & indexes) const
overridevirtual

Returns an object that contains serialized items of data corresponding to the list of indexes specified.

The format used to describe the encoded data is obtained from the mimeTypes() function. This default implementation uses the default MIME type returned by the default implementation of mimeTypes(). If you reimplement mimeTypes() in your custom model to return more MIME types, reimplement this function to make use of them.

If the list of indexes is empty, or there are no supported MIME types, \nullptr is returned rather than a serialized empty list.

See also
mimeTypes(), dropMimeData()

Reimplemented from QAbstractItemModel.

Definition at line 709 of file qtreewidget.cpp.

◆ mimeTypes()

QStringList QTreeModel::mimeTypes ( ) const
overridevirtual

Returns the list of allowed MIME types.

By default, the built-in models and views use an internal MIME type: {application/x-qabstractitemmodeldatalist}.

When implementing drag and drop support in a custom model, if you will return data in formats other than the default internal MIME type, reimplement this function to return your list of MIME types.

If you reimplement this function in your custom model, you must also reimplement the member functions that call it: mimeData() and dropMimeData().

See also
mimeData(), dropMimeData()

Reimplemented from QAbstractItemModel.

Definition at line 696 of file qtreewidget.cpp.

◆ parent()

QModelIndex QTreeModel::parent ( const QModelIndex & child) const
overridevirtual

\reimp

Returns the parent model index of the index given as the child.

Implements QAbstractItemModel.

Definition at line 249 of file qtreewidget.cpp.

◆ removeRows()

bool QTreeModel::removeRows ( int row,
int count,
const QModelIndex & parent = QModelIndex() )
override

\reimp

Definition at line 467 of file qtreewidget.cpp.

◆ rowCount()

int QTreeModel::rowCount ( const QModelIndex & parent) const
overridevirtual

\reimp

Returns the number of rows in the parent model index.

Implements QAbstractItemModel.

Definition at line 270 of file qtreewidget.cpp.

◆ setColumnCount()

void QTreeModel::setColumnCount ( int columns)

Sets the number of columns in the tree model.

Definition at line 141 of file qtreewidget.cpp.

◆ setData()

bool QTreeModel::setData ( const QModelIndex & index,
const QVariant & value,
int role )
overridevirtual

\reimp

Sets the data for the item specified by the index and role to that referred to by the value.

Returns true if successful; otherwise returns false.

Reimplemented from QAbstractItemModel.

Definition at line 344 of file qtreewidget.cpp.

◆ setHeaderData()

bool QTreeModel::setHeaderData ( int section,
Qt::Orientation orientation,
const QVariant & value,
int role )
overridevirtual

\reimp

Sets the header data for the item specified by the header section, orientation and data role to the given value.

Returns true if successful; otherwise returns false.

Reimplemented from QAbstractItemModel.

Definition at line 515 of file qtreewidget.cpp.

◆ sort()

void QTreeModel::sort ( int column,
Qt::SortOrder order )
override

Sorts the entire tree in the model in the given order, by the values in the given column.

Definition at line 548 of file qtreewidget.cpp.

◆ sortedInsertionIterator()

QList< QTreeWidgetItem * >::iterator QTreeModel::sortedInsertionIterator ( const QList< QTreeWidgetItem * >::iterator & begin,
const QList< QTreeWidgetItem * >::iterator & end,
Qt::SortOrder order,
QTreeWidgetItem * item )
static

Definition at line 686 of file qtreewidget.cpp.

◆ sortItems()

void QTreeModel::sortItems ( QList< QTreeWidgetItem * > * items,
int column,
Qt::SortOrder order )
protected

Definition at line 830 of file qtreewidget.cpp.

◆ supportedDragActions()

Qt::DropActions QTreeModel::supportedDragActions ( ) const
overridevirtual

Returns the actions supported by the data in this model.

The default implementation returns supportedDropActions(). Reimplement this function if you wish to support additional actions.

supportedDragActions() is used by QAbstractItemView::startDrag() as the default values when a drag occurs.

See also
Qt::DropActions, {Using drag and drop with item views}

Reimplemented from QAbstractItemModel.

Definition at line 741 of file qtreewidget.cpp.

◆ supportedDropActions()

Qt::DropActions QTreeModel::supportedDropActions ( ) const
overridevirtual
Since
4.2

Returns the drop actions supported by this model.

The default implementation returns Qt::CopyAction. Reimplement this function if you wish to support additional actions. You must also reimplement the dropMimeData() function to handle the additional operations.

See also
dropMimeData(), Qt::DropActions, {Using drag and drop with item views}

Reimplemented from QAbstractItemModel.

Definition at line 736 of file qtreewidget.cpp.

◆ timerEvent()

void QTreeModel::timerEvent ( QTimerEvent * event)
overrideprotectedvirtual

This event handler can be reimplemented in a subclass to receive timer events for the object.

QChronoTimer provides higher-level interfaces to the timer functionality, and also more general information about timers. The timer event is passed in the event parameter.

See also
startTimer(), killTimer(), event()

Reimplemented from QObject.

Definition at line 869 of file qtreewidget.cpp.

◆ view()

QTreeWidget * QTreeModel::view ( ) const
inline

Definition at line 50 of file qtreewidget_p.h.

◆ QTreeWidget

friend class QTreeWidget
friend

Definition at line 39 of file qtreewidget_p.h.

◆ QTreeWidgetItem

friend class QTreeWidgetItem
friend

Definition at line 41 of file qtreewidget_p.h.

◆ QTreeWidgetItemIterator

friend class QTreeWidgetItemIterator
friend

Definition at line 43 of file qtreewidget_p.h.

◆ QTreeWidgetItemIteratorPrivate

friend class QTreeWidgetItemIteratorPrivate
friend

Definition at line 44 of file qtreewidget_p.h.

◆ QTreeWidgetItemPrivate

friend class QTreeWidgetItemPrivate
friend

Definition at line 42 of file qtreewidget_p.h.

◆ QTreeWidgetPrivate

friend class QTreeWidgetPrivate
friend

Definition at line 40 of file qtreewidget_p.h.

◆ SkipSorting

friend struct SkipSorting
friend

Definition at line 141 of file qtreewidget_p.h.


The documentation for this class was generated from the following files: