<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- cachedtable.qdoc -->
<title>Cached Table Example | Qt SQL 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="qtsql-index.html">Qt SQL</a></td><td >Cached Table Example</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="#tableeditor-class-definition">TableEditor Class Definition</a></li>
<li class="level1"><a href="#tableeditor-class-implementation">TableEditor Class Implementation</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Cached Table Example</h1>
<span class="subtitle"></span>
<!-- $$$cachedtable-description -->
<div class="descr"> <a name="details"></a>
<div class="border"><p class="centerAlign"><img src="images/cachedtable-example.png" alt="" /></p></div><p>The example consists of a single class, <code>TableEditor</code>, which is a custom dialog widget that allows the user to modify data stored in a database. We will first review the class definiton and how to use the class, then we will take a look at the implementation.</p>
<a name="tableeditor-class-definition"></a>
<h2 id="tableeditor-class-definition">TableEditor Class Definition</h2>
<p>The <code>TableEditor</code> class inherits <a href="../qtwidgets/qdialog.html">QDialog</a> making the table editor widget a top-level dialog window.</p>
<pre class="cpp">
<span class="keyword">class</span> TableEditor : <span class="keyword">public</span> <span class="type"><a href="../qtwidgets/qwidget.html">QWidget</a></span>
{
Q_OBJECT
<span class="keyword">public</span>:
<span class="keyword">explicit</span> TableEditor(<span class="keyword">const</span> <span class="type"><a href="../qtcore/qstring.html">QString</a></span> <span class="operator">&</span>tableName<span class="operator">,</span> <span class="type"><a href="../qtwidgets/qwidget.html">QWidget</a></span> <span class="operator">*</span>parent <span class="operator">=</span> nullptr);
<span class="keyword">private</span> <span class="keyword">slots</span>:
<span class="type">void</span> submit();
<span class="keyword">private</span>:
<span class="type"><a href="../qtwidgets/qpushbutton.html">QPushButton</a></span> <span class="operator">*</span>submitButton;
<span class="type"><a href="../qtwidgets/qpushbutton.html">QPushButton</a></span> <span class="operator">*</span>revertButton;
<span class="type"><a href="../qtwidgets/qpushbutton.html">QPushButton</a></span> <span class="operator">*</span>quitButton;
<span class="type"><a href="../qtwidgets/qdialogbuttonbox.html">QDialogButtonBox</a></span> <span class="operator">*</span>buttonBox;
<span class="type"><a href="qsqltablemodel.html">QSqlTableModel</a></span> <span class="operator">*</span>model;
};
</pre>
<p>The <code>TableEditor</code> constructor takes two arguments: The first is a pointer to the parent widget and is passed on to the base class constructor. The other is a reference to the database table the <code>TableEditor</code> object will operate on.</p>
<p>Note the <a href="qsqltablemodel.html">QSqlTableModel</a> variable declaration: As we will see in this example, the <a href="qsqltablemodel.html">QSqlTableModel</a> class can be used to provide data to view classes such as <a href="../qtwidgets/qtableview.html">QTableView</a>. The <a href="qsqltablemodel.html">QSqlTableModel</a> class provides an editable data model making it possible to read and write database records from a single table. It is build on top of the lower-level <a href="qsqlquery.html">QSqlQuery</a> class which provides means of executing and manipulating SQL statements.</p>
<p>We are also going to show how a table view can be used to cache any changes to the data until the user explicitly requests to submit them. For that reason we need to declare a <code>submit()</code> slot in additon to the model and the editor's buttons.</p>
<div class="table"><table class="generic" width="100%">
<thead><tr class="qt-style"><th >Connecting to a Database</th></tr></thead>
<tr valign="top" class="odd"><td >Before we can use the <code>TableEditor</code> class, we must create a connection to the database containing the table we want to edit:<pre class="cpp">
<span class="type">int</span> main(<span class="type">int</span> argc<span class="operator">,</span> <span class="type">char</span> <span class="operator">*</span>argv<span class="operator">[</span><span class="operator">]</span>)
{
<span class="type"><a href="../qtwidgets/qapplication.html">QApplication</a></span> app(argc<span class="operator">,</span> argv);
<span class="keyword">if</span> (<span class="operator">!</span>createConnection())
<span class="keyword">return</span> <span class="number">1</span>;
TableEditor editor(<span class="string">"person"</span>);
editor<span class="operator">.</span>show();
<span class="keyword">return</span> app<span class="operator">.</span>exec();
}
</pre>
<p>The <code>createConnection()</code> function is a helper function provided for convenience. It is defined in the <code>connection.h</code> file which is located in the <code>sql</code> example directory (all the examples in the <code>sql</code> directory use this function to connect to a database).</p>
<pre class="cpp">
<span class="keyword">static</span> bool createConnection()
{
<span class="type"><a href="qsqldatabase.html">QSqlDatabase</a></span> db <span class="operator">=</span> <span class="type"><a href="qsqldatabase.html">QSqlDatabase</a></span><span class="operator">::</span>addDatabase(<span class="string">"QSQLITE"</span>);
db<span class="operator">.</span>setDatabaseName(<span class="string">":memory:"</span>);
<span class="keyword">if</span> (<span class="operator">!</span>db<span class="operator">.</span>open()) {
<span class="type"><a href="../qtwidgets/qmessagebox.html">QMessageBox</a></span><span class="operator">::</span>critical(nullptr<span class="operator">,</span> <span class="type"><a href="../qtcore/qobject.html">QObject</a></span><span class="operator">::</span>tr(<span class="string">"Cannot open database"</span>)<span class="operator">,</span>
<span class="type"><a href="../qtcore/qobject.html">QObject</a></span><span class="operator">::</span>tr(<span class="string">"Unable to establish a database connection.\n"</span>
<span class="string">"This example needs SQLite support. Please read "</span>
<span class="string">"the Qt SQL driver documentation for information how "</span>
<span class="string">"to build it.\n\n"</span>
<span class="string">"Click Cancel to exit."</span>)<span class="operator">,</span> <span class="type"><a href="../qtwidgets/qmessagebox.html">QMessageBox</a></span><span class="operator">::</span>Cancel);
<span class="keyword">return</span> <span class="keyword">false</span>;
}
<span class="type"><a href="qsqlquery.html">QSqlQuery</a></span> query;
query<span class="operator">.</span>exec(<span class="string">"create table person (id int primary key, "</span>
<span class="string">"firstname varchar(20), lastname varchar(20))"</span>);
query<span class="operator">.</span>exec(<span class="string">"insert into person values(101, 'Danny', 'Young')"</span>);
query<span class="operator">.</span>exec(<span class="string">"insert into person values(102, 'Christine', 'Holand')"</span>);
query<span class="operator">.</span>exec(<span class="string">"insert into person values(103, 'Lars', 'Gordon')"</span>);
query<span class="operator">.</span>exec(<span class="string">"insert into person values(104, 'Roberto', 'Robitaille')"</span>);
query<span class="operator">.</span>exec(<span class="string">"insert into person values(105, 'Maria', 'Papadopoulos')"</span>);
query<span class="operator">.</span>exec(<span class="string">"create table items (id int primary key,"</span>
<span class="string">"imagefile int,"</span>
<span class="string">"itemtype varchar(20),"</span>
<span class="string">"description varchar(100))"</span>);
query<span class="operator">.</span>exec(<span class="string">"insert into items "</span>
<span class="string">"values(0, 0, 'Qt',"</span>
<span class="string">"'Qt is a full development framework with tools designed to "</span>
<span class="string">"streamline the creation of stunning applications and "</span>
<span class="string">"amazing user interfaces for desktop, embedded and mobile "</span>
<span class="string">"platforms.')"</span>);
query<span class="operator">.</span>exec(<span class="string">"insert into items "</span>
<span class="string">"values(1, 1, 'Qt Quick',"</span>
<span class="string">"'Qt Quick is a collection of techniques designed to help "</span>
<span class="string">"developers create intuitive, modern-looking, and fluid "</span>
<span class="string">"user interfaces using a CSS & JavaScript like language.')"</span>);
query<span class="operator">.</span>exec(<span class="string">"insert into items "</span>
<span class="string">"values(2, 2, 'Qt Creator',"</span>
<span class="string">"'Qt Creator is a powerful cross-platform integrated "</span>
<span class="string">"development environment (IDE), including UI design tools "</span>
<span class="string">"and on-device debugging.')"</span>);
query<span class="operator">.</span>exec(<span class="string">"insert into items "</span>
<span class="string">"values(3, 3, 'Qt Project',"</span>
<span class="string">"'The Qt Project governs the open source development of Qt, "</span>
<span class="string">"allowing anyone wanting to contribute to join the effort "</span>
<span class="string">"through a meritocratic structure of approvers and "</span>
<span class="string">"maintainers.')"</span>);
query<span class="operator">.</span>exec(<span class="string">"create table images (itemid int, file varchar(20))"</span>);
query<span class="operator">.</span>exec(<span class="string">"insert into images values(0, 'images/qt-logo.png')"</span>);
query<span class="operator">.</span>exec(<span class="string">"insert into images values(1, 'images/qt-quick.png')"</span>);
query<span class="operator">.</span>exec(<span class="string">"insert into images values(2, 'images/qt-creator.png')"</span>);
query<span class="operator">.</span>exec(<span class="string">"insert into images values(3, 'images/qt-project.png')"</span>);
<span class="keyword">return</span> <span class="keyword">true</span>;
}
</pre>
<p>The <code>createConnection</code> function opens a connection to an in-memory SQLITE database and creates a test table. If you want to use another database, simply modify this function's code.</p>
</td></tr>
</table></div>
<a name="tableeditor-class-implementation"></a>
<h2 id="tableeditor-class-implementation">TableEditor Class Implementation</h2>
<p>The class implementation consists of only two functions, the constructor and the <code>submit()</code> slot. In the constructor we create and customize the data model and the various window elements:</p>
<pre class="cpp">
TableEditor<span class="operator">::</span>TableEditor(<span class="keyword">const</span> <span class="type"><a href="../qtcore/qstring.html">QString</a></span> <span class="operator">&</span>tableName<span class="operator">,</span> <span class="type"><a href="../qtwidgets/qwidget.html">QWidget</a></span> <span class="operator">*</span>parent)
: <span class="type"><a href="../qtwidgets/qwidget.html">QWidget</a></span>(parent)
{
model <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qsqltablemodel.html">QSqlTableModel</a></span>(<span class="keyword">this</span>);
model<span class="operator">-</span><span class="operator">></span>setTable(tableName);
model<span class="operator">-</span><span class="operator">></span>setEditStrategy(<span class="type"><a href="qsqltablemodel.html">QSqlTableModel</a></span><span class="operator">::</span>OnManualSubmit);
model<span class="operator">-</span><span class="operator">></span>select();
model<span class="operator">-</span><span class="operator">></span>setHeaderData(<span class="number">0</span><span class="operator">,</span> <span class="type"><a href="../qtcore/qt.html">Qt</a></span><span class="operator">::</span>Horizontal<span class="operator">,</span> tr(<span class="string">"ID"</span>));
model<span class="operator">-</span><span class="operator">></span>setHeaderData(<span class="number">1</span><span class="operator">,</span> <span class="type"><a href="../qtcore/qt.html">Qt</a></span><span class="operator">::</span>Horizontal<span class="operator">,</span> tr(<span class="string">"First name"</span>));
model<span class="operator">-</span><span class="operator">></span>setHeaderData(<span class="number">2</span><span class="operator">,</span> <span class="type"><a href="../qtcore/qt.html">Qt</a></span><span class="operator">::</span>Horizontal<span class="operator">,</span> tr(<span class="string">"Last name"</span>));
</pre>
<p>First we create the data model and set the SQL database table we want the model to operate on. Note that the <a href="qsqltablemodel.html#setTable">QSqlTableModel::setTable</a>() function does not select data from the table; it only fetches its field information. For that reason we call the <a href="qsqltablemodel.html#select">QSqlTableModel::select</a>() function later on, populating the model with data from the table. The selection can be customized by specifying filters and sort conditions (see the <a href="qsqltablemodel.html">QSqlTableModel</a> class documentation for more details).</p>
<p>We also set the model's edit strategy. The edit strategy dictates when the changes done by the user in the view, are actually applied to the database. Since we want to cache the changes in the table view (i.e. in the model) until the user explicitly submits them, we choose the <a href="qsqltablemodel.html#EditStrategy-enum">QSqlTableModel::OnManualSubmit</a> strategy. The alternatives are <a href="qsqltablemodel.html#EditStrategy-enum">QSqlTableModel::OnFieldChange</a> and <a href="qsqltablemodel.html#EditStrategy-enum">QSqlTableModel::OnRowChange</a>.</p>
<p>Finally, we set up the labels displayed in the view header using the <a href="qsqlquerymodel.html#setHeaderData">setHeaderData()</a> function that the model inherits from the <a href="qsqlquerymodel.html">QSqlQueryModel</a> class.</p>
<pre class="cpp">
<span class="type"><a href="../qtwidgets/qtableview.html">QTableView</a></span> <span class="operator">*</span>view <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="../qtwidgets/qtableview.html">QTableView</a></span>;
view<span class="operator">-</span><span class="operator">></span>setModel(model);
view<span class="operator">-</span><span class="operator">></span>resizeColumnsToContents();
</pre>
<p>Then we create a table view. The <a href="../qtwidgets/qtableview.html">QTableView</a> class provides a default model/view implementation of a table view, i.e. it implements a table view that displays items from a model. It also allows the user to edit the items, storing the changes in the model. To create a read only view, set the proper flag using the <a href="../qtwidgets/qabstractitemview.html#editTriggers-prop">editTriggers</a> property the view inherits from the <a href="../qtwidgets/qabstractitemview.html">QAbstractItemView</a> class.</p>
<p>To make the view present our data, we pass our model to the view using the <a href="../qtwidgets/qabstractitemview.html#setModel">setModel()</a> function.</p>
<pre class="cpp">
submitButton <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="../qtwidgets/qpushbutton.html">QPushButton</a></span>(tr(<span class="string">"Submit"</span>));
submitButton<span class="operator">-</span><span class="operator">></span>setDefault(<span class="keyword">true</span>);
revertButton <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="../qtwidgets/qpushbutton.html">QPushButton</a></span>(tr(<span class="string">"&Revert"</span>));
quitButton <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="../qtwidgets/qpushbutton.html">QPushButton</a></span>(tr(<span class="string">"Quit"</span>));
buttonBox <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="../qtwidgets/qdialogbuttonbox.html">QDialogButtonBox</a></span>(<span class="type"><a href="../qtcore/qt.html">Qt</a></span><span class="operator">::</span>Vertical);
buttonBox<span class="operator">-</span><span class="operator">></span>addButton(submitButton<span class="operator">,</span> <span class="type"><a href="../qtwidgets/qdialogbuttonbox.html">QDialogButtonBox</a></span><span class="operator">::</span>ActionRole);
buttonBox<span class="operator">-</span><span class="operator">></span>addButton(revertButton<span class="operator">,</span> <span class="type"><a href="../qtwidgets/qdialogbuttonbox.html">QDialogButtonBox</a></span><span class="operator">::</span>ActionRole);
buttonBox<span class="operator">-</span><span class="operator">></span>addButton(quitButton<span class="operator">,</span> <span class="type"><a href="../qtwidgets/qdialogbuttonbox.html">QDialogButtonBox</a></span><span class="operator">::</span>RejectRole);
</pre>
<p>The <code>TableEditor</code>'s buttons are regular <a href="../qtwidgets/qpushbutton.html">QPushButton</a> objects. We add them to a button box to ensure that the buttons are presented in a layout that is appropriate to the current widget style. The rationale for this is that dialogs and message boxes typically present buttons in a layout that conforms to the interface guidelines for that platform. Invariably, different platforms have different layouts for their dialogs. <a href="../qtwidgets/qdialogbuttonbox.html">QDialogButtonBox</a> allows a developer to add buttons to it and will automatically use the appropriate layout for the user's desktop environment.</p>
<p>Most buttons for a dialog follow certain roles. When adding a button to a button box using the <a href="../qtwidgets/qdialogbuttonbox.html">addButton()</a> function, the button's role must be specified using the <a href="../qtwidgets/qdialogbuttonbox.html#ButtonRole-enum">QDialogButtonBox::ButtonRole</a> enum. Alternatively, <a href="../qtwidgets/qdialogbuttonbox.html">QDialogButtonBox</a> provides several standard buttons (e.g. <b>OK</b>, <b>Cancel</b>, <b>Save</b>) that you can use. They exist as flags so you can OR them together in the constructor.</p>
<pre class="cpp">
connect(submitButton<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="../qtwidgets/qpushbutton.html">QPushButton</a></span><span class="operator">::</span>clicked<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>TableEditor<span class="operator">::</span>submit);
connect(revertButton<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="../qtwidgets/qpushbutton.html">QPushButton</a></span><span class="operator">::</span>clicked<span class="operator">,</span> model<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="qsqltablemodel.html">QSqlTableModel</a></span><span class="operator">::</span>revertAll);
connect(quitButton<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="../qtwidgets/qpushbutton.html">QPushButton</a></span><span class="operator">::</span>clicked<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>TableEditor<span class="operator">::</span>close);
</pre>
<p>We connect the <b>Quit</b> button to the table editor's <a href="../qtwidgets/qwidget.html#close">close()</a> slot, and the <b>Submit</b> button to our private <code>submit()</code> slot. The latter slot will take care of the data transactions. Finally, we connect the <b>Revert</b> button to our model's <a href="qsqltablemodel.html#revertAll">revertAll()</a> slot, reverting all pending changes (i.e., restoring the original data).</p>
<pre class="cpp">
<span class="type"><a href="../qtwidgets/qhboxlayout.html">QHBoxLayout</a></span> <span class="operator">*</span>mainLayout <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="../qtwidgets/qhboxlayout.html">QHBoxLayout</a></span>;
mainLayout<span class="operator">-</span><span class="operator">></span>addWidget(view);
mainLayout<span class="operator">-</span><span class="operator">></span>addWidget(buttonBox);
setLayout(mainLayout);
setWindowTitle(tr(<span class="string">"Cached Table"</span>));
}
</pre>
<p>In the end we add the button box and the table view to a layout, install the layout on the table editor widget, and set the editor's window title.</p>
<pre class="cpp">
<span class="type">void</span> TableEditor<span class="operator">::</span>submit()
{
model<span class="operator">-</span><span class="operator">></span>database()<span class="operator">.</span>transaction();
<span class="keyword">if</span> (model<span class="operator">-</span><span class="operator">></span>submitAll()) {
model<span class="operator">-</span><span class="operator">></span>database()<span class="operator">.</span>commit();
} <span class="keyword">else</span> {
model<span class="operator">-</span><span class="operator">></span>database()<span class="operator">.</span>rollback();
<span class="type"><a href="../qtwidgets/qmessagebox.html">QMessageBox</a></span><span class="operator">::</span>warning(<span class="keyword">this</span><span class="operator">,</span> tr(<span class="string">"Cached Table"</span>)<span class="operator">,</span>
tr(<span class="string">"The database reported an error: %1"</span>)
<span class="operator">.</span>arg(model<span class="operator">-</span><span class="operator">></span>lastError()<span class="operator">.</span>text()));
}
}
</pre>
<p>The <code>submit()</code> slot is called whenever the users hit the <b>Submit</b> button to save their changes.</p>
<p>First, we begin a transaction on the database using the <a href="qsqldatabase.html#transaction">QSqlDatabase::transaction</a>() function. A database transaction is a unit of interaction with a database management system or similar system that is treated in a coherent and reliable way independent of other transactions. A pointer to the used database can be obtained using the <a href="qsqltablemodel.html#database">QSqlTableModel::database</a>() function.</p>
<p>Then, we try to submit all the pending changes, i.e. the model's modified items. If no error occurs, we commit the transaction to the database using the <a href="qsqldatabase.html#commit">QSqlDatabase::commit</a>() function (note that on some databases, this function will not work if there is an active <a href="qsqlquery.html">QSqlQuery</a> on the database). Otherwise we perform a rollback of the transaction using the <a href="qsqldatabase.html#rollback">QSqlDatabase::rollback</a>() function and post a warning to the user.</p>
<div class="table"><table class="generic" width="100%">
<tr valign="top" class="odd"><td ><b>See also:</b><p>A complete list of Qt's SQL <a href="sql-programming.html#database-classes">Database Classes</a>, and the <a href="../qtwidgets/model-view-programming.html">Model/View Programming</a> documentation.</p>
</td></tr>
</table></div>
<p>Files:</p>
<ul>
<li><a href="qtsql-cachedtable-tableeditor-cpp.html">cachedtable/tableeditor.cpp</a></li>
<li><a href="qtsql-cachedtable-tableeditor-h.html">cachedtable/tableeditor.h</a></li>
<li><a href="qtsql-cachedtable-main-cpp.html">cachedtable/main.cpp</a></li>
<li><a href="qtsql-cachedtable-cachedtable-pro.html">cachedtable/cachedtable.pro</a></li>
</ul>
</div>
<!-- @@@cachedtable -->
</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>
distrib
>
Mageia
>
6
>
armv5tl
>
media
>
core-updates
>
by-pkgid
>
768f7d9f703884aa2562bf0a651086df
>
files
>
2294
