<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qabstractitemmodel.cpp --> <title>QAbstractListModel Class | Qt Core 5.9</title> <link rel="stylesheet" type="text/css" href="style/offline-simple.css" /> <script type="text/javascript"> document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css"); // loading style sheet breaks anchors that were jumped to before // so force jumping to anchor again setTimeout(function() { var anchor = location.hash; // need to jump to different anchor first (e.g. none) location.hash = "#"; setTimeout(function() { location.hash = anchor; }, 0); }, 0); </script> </head> <body> <div class="header" id="qtdocheader"> <div class="main"> <div class="main-rounded"> <div class="navigationbar"> <table><tr> <td >Qt 5.9</td><td ><a href="qtcore-index.html">Qt Core</a></td><td ><a href="qtcore-module.html">C++ Classes</a></td><td >QAbstractListModel</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td> </tr></table> </div> </div> <div class="content"> <div class="line"> <div class="content mainContent"> <div class="sidebar"> <div class="toc"> <h3><a name="toc">Contents</a></h3> <ul> <li class="level1"><a href="#public-functions">Public Functions</a></li> <li class="level1"><a href="#reimplemented-public-functions">Reimplemented Public Functions</a></li> <li class="level1"><a href="#details">Detailed Description</a></li> <li class="level2"><a href="#subclassing">Subclassing</a></li> </ul> </div> <div class="sidebar-content" id="sidebar-content"></div></div> <h1 class="title">QAbstractListModel Class</h1> <!-- $$$QAbstractListModel-brief --> <p>The <a href="qabstractlistmodel.html">QAbstractListModel</a> class provides an abstract model that can be subclassed to create one-dimensional list models. <a href="#details">More...</a></p> <!-- @@@QAbstractListModel --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAbstractListModel></span> </td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += core</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qabstractitemmodel.html">QAbstractItemModel</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qstringlistmodel.html">QStringListModel</a></p> </td></tr></table></div><ul> <li><a href="qabstractlistmodel-members.html">List of all members, including inherited members</a></li> </ul> <a name="public-functions"></a> <h2 id="public-functions">Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qabstractlistmodel.html#QAbstractListModel">QAbstractListModel</a></b>(QObject *<i>parent</i> = Q_NULLPTR)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qabstractlistmodel.html#dtor.QAbstractListModel">~QAbstractListModel</a></b>()</td></tr> </table></div> <a name="reimplemented-public-functions"></a> <h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qabstractlistmodel.html#dropMimeData">dropMimeData</a></b>(const QMimeData *<i>data</i>, Qt::DropAction <i>action</i>, int <i>row</i>, int <i>column</i>, const QModelIndex &<i>parent</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual Qt::ItemFlags </td><td class="memItemRight bottomAlign"><b><a href="qabstractlistmodel.html#flags">flags</a></b>(const QModelIndex &<i>index</i>) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QModelIndex </td><td class="memItemRight bottomAlign"><b><a href="qabstractlistmodel.html#index">index</a></b>(int <i>row</i>, int <i>column</i> = 0, const QModelIndex &<i>parent</i> = QModelIndex()) const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual QModelIndex </td><td class="memItemRight bottomAlign"><b><a href="qabstractlistmodel.html#sibling">sibling</a></b>(int <i>row</i>, int <i>column</i>, const QModelIndex &<i>idx</i>) const</td></tr> </table></div> <ul> <li class="fn">39 public functions inherited from <a href="qabstractitemmodel.html#public-functions">QAbstractItemModel</a></li> <li class="fn">32 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li> <li class="fn">2 public slots inherited from <a href="qabstractitemmodel.html#public-slots">QAbstractItemModel</a></li> <li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li> <li class="fn">18 signals inherited from <a href="qabstractitemmodel.html#signals">QAbstractItemModel</a></li> <li class="fn">2 signals inherited from <a href="qobject.html#signals">QObject</a></li> <li class="fn">11 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li> <li class="fn">19 protected functions inherited from <a href="qabstractitemmodel.html#protected-functions">QAbstractItemModel</a></li> <li class="fn">9 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li> <li class="fn">1 protected slot inherited from <a href="qabstractitemmodel.html#protected-slots">QAbstractItemModel</a></li> </ul> <a name="details"></a> <!-- $$$QAbstractListModel-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>The <a href="qabstractlistmodel.html">QAbstractListModel</a> class provides an abstract model that can be subclassed to create one-dimensional list models.</p> <p><a href="qabstractlistmodel.html">QAbstractListModel</a> provides a standard interface for models that represent their data as a simple non-hierarchical sequence of items. It is not used directly, but must be subclassed.</p> <p>Since the model provides a more specialized interface than <a href="qabstractitemmodel.html">QAbstractItemModel</a>, it is not suitable for use with tree views; you will need to subclass <a href="qabstractitemmodel.html">QAbstractItemModel</a> if you want to provide a model for that purpose. If you need to use a number of list models to manage data, it may be more appropriate to subclass <a href="qabstracttablemodel.html">QAbstractTableModel</a> instead.</p> <p>Simple models can be created by subclassing this class and implementing the minimum number of required functions. For example, we could implement a simple read-only <a href="qstringlist.html">QStringList</a>-based model that provides a list of strings to a <a href="../qtwidgets/qlistview.html">QListView</a> widget. In such a case, we only need to implement the <a href="qabstractitemmodel.html#rowCount">rowCount</a>() function to return the number of items in the list, and the <a href="qabstractitemmodel.html#data">data</a>() function to retrieve items from the list.</p> <p>Since the model represents a one-dimensional structure, the <a href="qabstractitemmodel.html#rowCount">rowCount</a>() function returns the total number of items in the model. The <a href="qabstractitemmodel.html#columnCount">columnCount</a>() function is implemented for interoperability with all kinds of views, but by default informs views that the model contains only one column.</p> <a name="subclassing"></a> <h3 >Subclassing</h3> <p>When subclassing <a href="qabstractlistmodel.html">QAbstractListModel</a>, you must provide implementations of the <a href="qabstractitemmodel.html#rowCount">rowCount</a>() and <a href="qabstractitemmodel.html#data">data</a>() functions. Well behaved models also provide a <a href="qabstractitemmodel.html#headerData">headerData</a>() implementation.</p> <p>If your model is used within QML and requires roles other than the default ones provided by the <a href="qabstractitemmodel.html#roleNames">roleNames</a>() function, you must override it.</p> <p>For editable list models, you must also provide an implementation of <a href="qabstractitemmodel.html#setData">setData</a>(), and implement the <a href="qabstractlistmodel.html#flags">flags</a>() function so that it returns a value containing <a href="qt.html#ItemFlag-enum">Qt::ItemIsEditable</a>.</p> <p>Note that <a href="qabstractlistmodel.html">QAbstractListModel</a> provides a default implementation of <a href="qabstractitemmodel.html#columnCount">columnCount</a>() that informs views that there is only a single column of items in this model.</p> <p>Models that provide interfaces to resizable list-like data structures can provide implementations of <a href="qabstractitemmodel.html#insertRows">insertRows</a>() and <a href="qabstractitemmodel.html#removeRows">removeRows</a>(). When implementing these functions, it is important to call the appropriate functions so that all connected views are aware of any changes:</p> <ul> <li>An <a href="qabstractitemmodel.html#insertRows">insertRows</a>() implementation must call <a href="qabstractitemmodel.html#beginInsertRows">beginInsertRows</a>() <i>before</i> inserting new rows into the data structure, and it must call <a href="qabstractitemmodel.html#endInsertRows">endInsertRows</a>() <i>immediately afterwards</i>.</li> <li>A <a href="qabstractitemmodel.html#removeRows">removeRows</a>() implementation must call <a href="qabstractitemmodel.html#beginRemoveRows">beginRemoveRows</a>() <i>before</i> the rows are removed from the data structure, and it must call <a href="qabstractitemmodel.html#endRemoveRows">endRemoveRows</a>() <i>immediately afterwards</i>.</li> </ul> <p><b>Note: </b>Some general guidelines for subclassing models are available in the <a href="../qtwidgets/model-view-programming.html#model-subclassing-reference">Model Subclassing Reference</a>.</p></div> <p><b>See also </b><a href="../qtwidgets/model-view-programming.html#model-classes">Model Classes</a>, <a href="../qtwidgets/model-view-programming.html#model-subclassing-reference">Model Subclassing Reference</a>, <a href="../qtwidgets/qabstractitemview.html">QAbstractItemView</a>, <a href="qabstracttablemodel.html">QAbstractTableModel</a>, and <a href="../qtwidgets/qtwidgets-itemviews-puzzle-example.html">Item Views Puzzle Example</a>.</p> <!-- @@@QAbstractListModel --> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QAbstractListModel[overload1]$$$QAbstractListModelQObject* --> <h3 class="fn" id="QAbstractListModel"><a name="QAbstractListModel"></a>QAbstractListModel::<span class="name">QAbstractListModel</span>(<span class="type"><a href="qobject.html#QObject">QObject</a></span> *<i>parent</i> = Q_NULLPTR)</h3> <p>Constructs an abstract list model with the given <i>parent</i>.</p> <!-- @@@QAbstractListModel --> <!-- $$$~QAbstractListModel[overload1]$$$~QAbstractListModel --> <h3 class="fn" id="dtor.QAbstractListModel"><a name="dtor.QAbstractListModel"></a>QAbstractListModel::<span class="name">~QAbstractListModel</span>()</h3> <p>Destroys the abstract list model.</p> <!-- @@@~QAbstractListModel --> <!-- $$$dropMimeData[overload1]$$$dropMimeDataconstQMimeData*Qt::DropActionintintconstQModelIndex& --> <h3 class="fn" id="dropMimeData"><a name="dropMimeData"></a><code>[virtual] </code><span class="type">bool</span> QAbstractListModel::<span class="name">dropMimeData</span>(const <span class="type"><a href="qmimedata.html">QMimeData</a></span> *<i>data</i>, <span class="type"><a href="qt.html#DropAction-enum">Qt::DropAction</a></span> <i>action</i>, <span class="type">int</span> <i>row</i>, <span class="type">int</span> <i>column</i>, const <span class="type"><a href="qmodelindex.html">QModelIndex</a></span> &<i>parent</i>)</h3> <p>Reimplemented from <a href="qabstractitemmodel.html#dropMimeData">QAbstractItemModel::dropMimeData</a>().</p> <!-- @@@dropMimeData --> <!-- $$$flags[overload1]$$$flagsconstQModelIndex& --> <h3 class="fn" id="flags"><a name="flags"></a><code>[virtual] </code><span class="type"><a href="qt.html#ItemFlag-enum">Qt::ItemFlags</a></span> QAbstractListModel::<span class="name">flags</span>(const <span class="type"><a href="qmodelindex.html">QModelIndex</a></span> &<i>index</i>) const</h3> <p>Reimplemented from <a href="qabstractitemmodel.html#flags">QAbstractItemModel::flags</a>().</p> <!-- @@@flags --> <!-- $$$index[overload1]$$$indexintintconstQModelIndex& --> <h3 class="fn" id="index"><a name="index"></a><code>[virtual] </code><span class="type"><a href="qmodelindex.html">QModelIndex</a></span> QAbstractListModel::<span class="name">index</span>(<span class="type">int</span> <i>row</i>, <span class="type">int</span> <i>column</i> = 0, const <span class="type"><a href="qmodelindex.html">QModelIndex</a></span> &<i>parent</i> = QModelIndex()) const</h3> <p>Reimplemented from <a href="qabstractitemmodel.html#index">QAbstractItemModel::index</a>().</p> <p>Returns the index of the data in <i>row</i> and <i>column</i> with <i>parent</i>.</p> <p><b>See also </b><a href="qabstractitemmodel.html#parent">parent</a>().</p> <!-- @@@index --> <!-- $$$sibling[overload1]$$$siblingintintconstQModelIndex& --> <h3 class="fn" id="sibling"><a name="sibling"></a><code>[virtual] </code><span class="type"><a href="qmodelindex.html">QModelIndex</a></span> QAbstractListModel::<span class="name">sibling</span>(<span class="type">int</span> <i>row</i>, <span class="type">int</span> <i>column</i>, const <span class="type"><a href="qmodelindex.html">QModelIndex</a></span> &<i>idx</i>) const</h3> <p>Reimplemented from <a href="qabstractitemmodel.html#sibling">QAbstractItemModel::sibling</a>().</p> <!-- @@@sibling --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. </p> </div> </body> </html>