<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- q3databrowser.cpp -->
<title>Qt 4.8: Q3DataBrowser Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qt3support.html">Qt3Support</a></li>
<li>Q3DataBrowser</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">Q3DataBrowser Class Reference</h1>
<!-- $$$Q3DataBrowser-brief -->
<p>The Q3DataBrowser class provides data manipulation and navigation for data entry forms. <a href="#details">More...</a></p>
<!-- @@@Q3DataBrowser -->
<pre class="cpp"> <span class="preprocessor">#include <Q3DataBrowser></span></pre><p><b>This class is part of the Qt 3 support library.</b> It is provided to keep old source code working. We strongly advise against using it in new code. See <a href="porting4.html#qdatabrowser">Porting to Qt 4</a> for more information.</p>
<p><b>Inherits: </b><a href="qwidget.html">QWidget</a>.</p>
<ul>
<li><a href="q3databrowser-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#Boundary-enum">Boundary</a></b> { Unknown, None, BeforeBeginning, Beginning, End, AfterEnd }</td></tr>
</table>
<a name="properties"></a>
<h2>Properties</h2>
<table class="propsummary">
<tr><td class="topAlign"><ul>
<li class="fn"><b><a href="q3databrowser.html#autoEdit-prop">autoEdit</a></b> : bool</li>
<li class="fn"><b><a href="q3databrowser.html#boundaryChecking-prop">boundaryChecking</a></b> : bool</li>
<li class="fn"><b><a href="q3databrowser.html#confirmCancels-prop">confirmCancels</a></b> : bool</li>
<li class="fn"><b><a href="q3databrowser.html#confirmDelete-prop">confirmDelete</a></b> : bool</li>
<li class="fn"><b><a href="q3databrowser.html#confirmEdits-prop">confirmEdits</a></b> : bool</li>
</ul></td><td class="topAlign"><ul>
<li class="fn"><b><a href="q3databrowser.html#confirmInsert-prop">confirmInsert</a></b> : bool</li>
<li class="fn"><b><a href="q3databrowser.html#confirmUpdate-prop">confirmUpdate</a></b> : bool</li>
<li class="fn"><b><a href="q3databrowser.html#filter-prop">filter</a></b> : QString</li>
<li class="fn"><b><a href="q3databrowser.html#readOnly-prop">readOnly</a></b> : bool</li>
<li class="fn"><b><a href="q3databrowser.html#sort-prop">sort</a></b> : QStringList</li>
</ul>
</td></tr>
</table>
<ul>
<li class="fn">58 properties inherited from <a href="qwidget.html#properties">QWidget</a></li>
<li class="fn">1 property inherited from <a href="qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#Q3DataBrowser">Q3DataBrowser</a></b> ( QWidget * <i>parent</i> = 0, const char * <i>name</i> = 0, Qt::WindowFlags <i>fl</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#dtor.Q3DataBrowser">~Q3DataBrowser</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#autoEdit-prop">autoEdit</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Boundary </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#boundary">boundary</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#boundaryChecking-prop">boundaryChecking</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#confirmCancels-prop">confirmCancels</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#confirmDelete-prop">confirmDelete</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#confirmEdits-prop">confirmEdits</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#confirmInsert-prop">confirmInsert</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#confirmUpdate-prop">confirmUpdate</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#filter-prop">filter</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3SqlForm * </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#form">form</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#readOnly-prop">isReadOnly</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#seek">seek</a></b> ( int <i>i</i>, bool <i>relative</i> = false )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#autoEdit-prop">setAutoEdit</a></b> ( bool <i>autoEdit</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#boundaryChecking-prop">setBoundaryChecking</a></b> ( bool <i>active</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#confirmCancels-prop">setConfirmCancels</a></b> ( bool <i>confirm</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#confirmDelete-prop">setConfirmDelete</a></b> ( bool <i>confirm</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#confirmEdits-prop">setConfirmEdits</a></b> ( bool <i>confirm</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#confirmInsert-prop">setConfirmInsert</a></b> ( bool <i>confirm</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#confirmUpdate-prop">setConfirmUpdate</a></b> ( bool <i>confirm</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#filter-prop">setFilter</a></b> ( const QString & <i>filter</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#setForm">setForm</a></b> ( Q3SqlForm * <i>form</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#readOnly-prop">setReadOnly</a></b> ( bool <i>active</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#sort-prop">setSort</a></b> ( const QStringList & <i>sort</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#sort-prop">setSort</a></b> ( const QSqlIndex & <i>sort</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#setSqlCursor">setSqlCursor</a></b> ( Q3SqlCursor * <i>cursor</i>, bool <i>autoDelete</i> = false )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#sort-prop">sort</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Q3SqlCursor * </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#sqlCursor">sqlCursor</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">221 public functions inherited from <a href="qwidget.html#public-functions">QWidget</a></li>
<li class="fn">29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
<li class="fn">13 public functions inherited from <a href="qpaintdevice.html#public-functions">QPaintDevice</a></li>
</ul>
<a name="public-slots"></a>
<h2>Public Slots</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#clearValues">clearValues</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#del">del</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#first">first</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#insert">insert</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#last">last</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#next">next</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#prev">prev</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#readFields">readFields</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#refresh">refresh</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#update">update</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#updateBoundary">updateBoundary</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#writeFields">writeFields</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">19 public slots inherited from <a href="qwidget.html#public-slots">QWidget</a></li>
<li class="fn">1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
</ul>
<a name="signals"></a>
<h2>Signals</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#beforeDelete">beforeDelete</a></b> ( QSqlRecord * <i>buf</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#beforeInsert">beforeInsert</a></b> ( QSqlRecord * <i>buf</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#beforeUpdate">beforeUpdate</a></b> ( QSqlRecord * <i>buf</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#currentChanged">currentChanged</a></b> ( const QSqlRecord * <i>record</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#cursorChanged">cursorChanged</a></b> ( Q3SqlCursor::Mode <i>mode</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#firstRecordAvailable">firstRecordAvailable</a></b> ( bool <i>available</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#lastRecordAvailable">lastRecordAvailable</a></b> ( bool <i>available</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#nextRecordAvailable">nextRecordAvailable</a></b> ( bool <i>available</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#prevRecordAvailable">prevRecordAvailable</a></b> ( bool <i>available</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#primeDelete">primeDelete</a></b> ( QSqlRecord * <i>buf</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#primeInsert">primeInsert</a></b> ( QSqlRecord * <i>buf</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#primeUpdate">primeUpdate</a></b> ( QSqlRecord * <i>buf</i> )</td></tr>
</table>
<ul>
<li class="fn">1 signal inherited from <a href="qwidget.html#signals">QWidget</a></li>
<li class="fn">1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
</ul>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QSql::Confirm </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#confirmCancel">confirmCancel</a></b> ( QSql::Op <i>m</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QSql::Confirm </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#confirmEdit">confirmEdit</a></b> ( QSql::Op <i>m</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#currentEdited">currentEdited</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#deleteCurrent">deleteCurrent</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#handleError">handleError</a></b> ( const QSqlError & <i>error</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#insertCurrent">insertCurrent</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="q3databrowser.html#updateCurrent">updateCurrent</a></b> ()</td></tr>
</table>
<ul>
<li class="fn">37 protected functions inherited from <a href="qwidget.html#protected-functions">QWidget</a></li>
<li class="fn">8 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
<li class="fn">1 protected function inherited from <a href="qpaintdevice.html#protected-functions">QPaintDevice</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">4 static public members inherited from <a href="qwidget.html#static-public-members">QWidget</a></li>
<li class="fn">7 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li class="fn">1 protected slot inherited from <a href="qwidget.html#protected-slots">QWidget</a></li>
</ul>
<a name="details"></a>
<!-- $$$Q3DataBrowser-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The Q3DataBrowser class provides data manipulation and navigation for data entry forms.</p>
<p>A high-level API is provided for navigating through data records in a cursor, for inserting, updating and deleting records, and for refreshing data in the display.</p>
<p>If you want a read-only form to present database data use <a href="q3dataview.html">Q3DataView</a>; if you want a table-based presentation of your data use <a href="q3datatable.html">Q3DataTable</a>.</p>
<p>A Q3DataBrowser is used to associate a dataset with a form in much the same way as a <a href="q3datatable.html">Q3DataTable</a> associates a dataset with a table. Once the data browser has been constructed it can be associated with a dataset with <a href="q3databrowser.html#setSqlCursor">setSqlCursor</a>(), and with a form with <a href="q3databrowser.html#setForm">setForm</a>(). Boundary checking, sorting and filtering can be set with <a href="q3databrowser.html#boundaryChecking-prop">setBoundaryChecking</a>(), <a href="q3databrowser.html#sort-prop">setSort</a>() and <a href="q3databrowser.html#filter-prop">setFilter</a>(), respectively.</p>
<p>The <a href="q3databrowser.html#insertCurrent">insertCurrent</a>() function reads the fields from the default form into the default cursor and performs the insert. The <a href="q3databrowser.html#updateCurrent">updateCurrent</a>() and <a href="q3databrowser.html#deleteCurrent">deleteCurrent</a>() functions perform similarly to update and delete the current record respectively.</p>
<p>The user can be asked to confirm all edits with <a href="q3databrowser.html#confirmEdits-prop">setConfirmEdits</a>(). For more precise control use <a href="q3databrowser.html#confirmInsert-prop">setConfirmInsert</a>(), <a href="q3databrowser.html#confirmUpdate-prop">setConfirmUpdate</a>(), <a href="q3databrowser.html#confirmDelete-prop">setConfirmDelete</a>() and <a href="q3databrowser.html#confirmCancels-prop">setConfirmCancels</a>(). Use <a href="q3databrowser.html#autoEdit-prop">setAutoEdit</a>() to control the behavior of the form when the user edits a record and then navigates.</p>
<p>The record set is navigated using <a href="q3databrowser.html#first">first</a>(), <a href="q3databrowser.html#next">next</a>(), <a href="q3databrowser.html#prev">prev</a>(), <a href="q3databrowser.html#last">last</a>() and <a href="q3databrowser.html#seek">seek</a>(). The form's display is updated with <a href="q3databrowser.html#refresh">refresh</a>(). When navigation takes place the <a href="q3databrowser.html#firstRecordAvailable">firstRecordAvailable</a>(), <a href="q3databrowser.html#lastRecordAvailable">lastRecordAvailable</a>(), <a href="q3databrowser.html#nextRecordAvailable">nextRecordAvailable</a>() and <a href="q3databrowser.html#prevRecordAvailable">prevRecordAvailable</a>() signals are emitted. When the cursor record is changed due to navigation the <a href="q3databrowser.html#cursorChanged">cursorChanged</a>() signal is emitted.</p>
<p>If you want finer control of the insert, update and delete processes then you can use the lower level functions to perform these operations as described below.</p>
<p>The form is populated with data from the database with <a href="q3databrowser.html#readFields">readFields</a>(). If the user is allowed to edit, (see <a href="q3databrowser.html#readOnly-prop">setReadOnly</a>()), write the form's data back to the cursor's edit buffer with <a href="q3databrowser.html#writeFields">writeFields</a>(). You can clear the values in the form with <a href="q3databrowser.html#clearValues">clearValues</a>(). Editing is performed as follows:</p>
<ul>
<li><i>insert</i> When the data browser enters insertion mode it emits the <a href="q3databrowser.html#primeInsert">primeInsert</a>() signal which you can connect to, for example to pre-populate fields. Call <a href="q3databrowser.html#writeFields">writeFields</a>() to write the user's edits to the cursor's edit buffer then call <a href="q3databrowser.html#insert">insert</a>() to insert the record into the database. The <a href="q3databrowser.html#beforeInsert">beforeInsert</a>() signal is emitted just before the cursor's edit buffer is inserted into the database; connect to this for example, to populate fields such as an auto-generated primary key.</li>
<li><i>update</i> For updates the <a href="q3databrowser.html#primeUpdate">primeUpdate</a>() signal is emitted when the data browser enters update mode. After calling <a href="q3databrowser.html#writeFields">writeFields</a>() call <a href="q3databrowser.html#update">update</a>() to update the record and connect to the <a href="q3databrowser.html#beforeUpdate">beforeUpdate</a>() signal to manipulate the user's data before the update takes place.</li>
<li><i>delete</i> For deletion the <a href="q3databrowser.html#primeDelete">primeDelete</a>() signal is emitted when the data browser enters deletion mode. After calling <a href="q3databrowser.html#writeFields">writeFields</a>() call <a href="q3databrowser.html#del">del</a>() to delete the record and connect to the <a href="q3databrowser.html#beforeDelete">beforeDelete</a>() signal, for example to record an audit of the deleted record.</li>
</ul>
</div>
<!-- @@@Q3DataBrowser -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Boundary$$$Unknown$$$None$$$BeforeBeginning$$$Beginning$$$End$$$AfterEnd -->
<h3 class="fn"><a name="Boundary-enum"></a>enum Q3DataBrowser::<span class="name">Boundary</span></h3>
<p>This enum describes where the data browser is positioned.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>Q3DataBrowser::Unknown</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">the boundary cannot be determined (usually because there is no default cursor, or the default cursor is not active).</td></tr>
<tr><td class="topAlign"><tt>Q3DataBrowser::None</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">the browser is not positioned on a boundary, but it is positioned on a record somewhere in the middle.</td></tr>
<tr><td class="topAlign"><tt>Q3DataBrowser::BeforeBeginning</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">the browser is positioned before the first available record.</td></tr>
<tr><td class="topAlign"><tt>Q3DataBrowser::Beginning</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">the browser is positioned at the first record.</td></tr>
<tr><td class="topAlign"><tt>Q3DataBrowser::End</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">the browser is positioned at the last record.</td></tr>
<tr><td class="topAlign"><tt>Q3DataBrowser::AfterEnd</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">the browser is positioned after the last available record.</td></tr>
</table>
<!-- @@@Boundary -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$autoEdit-prop$$$autoEdit$$$setAutoEditbool -->
<h3 class="fn"><a name="autoEdit-prop"></a><span class="name">autoEdit</span> : <span class="type">bool</span></h3>
<p>This property holds whether the browser automatically applies edits.</p>
<p>The default value for this property is true. When the user begins an insertion or an update on a form there are two possible outcomes when they navigate to another record:</p>
<ul>
<li>the insert or update is is performed -- this occurs if autoEdit is true</li>
<li>the insert or update is discarded -- this occurs if autoEdit is false</li>
</ul>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>autoEdit</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setAutoEdit</b></span> ( bool <i>autoEdit</i> )</td></tr>
</table>
<!-- @@@autoEdit -->
<!-- $$$boundaryChecking-prop$$$boundaryChecking$$$setBoundaryCheckingbool -->
<h3 class="fn"><a name="boundaryChecking-prop"></a><span class="name">boundaryChecking</span> : <span class="type">bool</span></h3>
<p>This property holds whether boundary checking is active.</p>
<p>When boundary checking is active (the default), signals are emitted indicating the current position of the default cursor.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>boundaryChecking</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setBoundaryChecking</b></span> ( bool <i>active</i> )</td></tr>
</table>
<p><b>See also </b><a href="q3databrowser.html#boundary">boundary</a>().</p>
<!-- @@@boundaryChecking -->
<!-- $$$confirmCancels-prop$$$confirmCancels$$$setConfirmCancelsbool -->
<h3 class="fn"><a name="confirmCancels-prop"></a><span class="name">confirmCancels</span> : <span class="type">bool</span></h3>
<p>This property holds whether the browser confirms cancel operations.</p>
<p>If this property is true, all cancels must be confirmed by the user through a message box (this behavior can be changed by overriding the <a href="q3databrowser.html#confirmCancel">confirmCancel</a>() function), otherwise all cancels occur immediately. The default is false.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>confirmCancels</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setConfirmCancels</b></span> ( bool <i>confirm</i> )</td></tr>
</table>
<p><b>See also </b><a href="q3databrowser.html#confirmEdits-prop">confirmEdits</a>() and <a href="q3databrowser.html#confirmCancel">confirmCancel</a>().</p>
<!-- @@@confirmCancels -->
<!-- $$$confirmDelete-prop$$$confirmDelete$$$setConfirmDeletebool -->
<h3 class="fn"><a name="confirmDelete-prop"></a><span class="name">confirmDelete</span> : <span class="type">bool</span></h3>
<p>This property holds whether the browser confirms deletions.</p>
<p>If this property is true, the browser confirms deletions, otherwise deletions happen immediately.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>confirmDelete</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setConfirmDelete</b></span> ( bool <i>confirm</i> )</td></tr>
</table>
<p><b>See also </b><a href="q3databrowser.html#confirmCancels-prop">confirmCancels</a>(), <a href="q3databrowser.html#confirmEdits-prop">confirmEdits</a>(), <a href="q3databrowser.html#confirmUpdate-prop">confirmUpdate</a>(), <a href="q3databrowser.html#confirmInsert-prop">confirmInsert</a>(), and <a href="q3databrowser.html#confirmEdit">confirmEdit</a>().</p>
<!-- @@@confirmDelete -->
<!-- $$$confirmEdits-prop$$$confirmEdits$$$setConfirmEditsbool -->
<h3 class="fn"><a name="confirmEdits-prop"></a><span class="name">confirmEdits</span> : <span class="type">bool</span></h3>
<p>This property holds whether the browser confirms edits.</p>
<p>If this property is true, the browser confirms all edit operations (insertions, updates and deletions), otherwise all edit operations happen immediately. Confirmation is achieved by presenting the user with a message box -- this behavior can be changed by reimplementing the <a href="q3databrowser.html#confirmEdit">confirmEdit</a>() function,</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>confirmEdits</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setConfirmEdits</b></span> ( bool <i>confirm</i> )</td></tr>
</table>
<p><b>See also </b><a href="q3databrowser.html#confirmEdit">confirmEdit</a>(), <a href="q3databrowser.html#confirmCancels-prop">confirmCancels</a>(), <a href="q3databrowser.html#confirmInsert-prop">confirmInsert</a>(), <a href="q3databrowser.html#confirmUpdate-prop">confirmUpdate</a>(), and <a href="q3databrowser.html#confirmDelete-prop">confirmDelete</a>().</p>
<!-- @@@confirmEdits -->
<!-- $$$confirmInsert-prop$$$confirmInsert$$$setConfirmInsertbool -->
<h3 class="fn"><a name="confirmInsert-prop"></a><span class="name">confirmInsert</span> : <span class="type">bool</span></h3>
<p>This property holds whether the data browser confirms insertions.</p>
<p>If this property is true, the browser confirms insertions, otherwise insertions happen immediately.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>confirmInsert</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setConfirmInsert</b></span> ( bool <i>confirm</i> )</td></tr>
</table>
<p><b>See also </b><a href="q3databrowser.html#confirmCancels-prop">confirmCancels</a>(), <a href="q3databrowser.html#confirmEdits-prop">confirmEdits</a>(), <a href="q3databrowser.html#confirmUpdate-prop">confirmUpdate</a>(), <a href="q3databrowser.html#confirmDelete-prop">confirmDelete</a>(), and <a href="q3databrowser.html#confirmEdit">confirmEdit</a>().</p>
<!-- @@@confirmInsert -->
<!-- $$$confirmUpdate-prop$$$confirmUpdate$$$setConfirmUpdatebool -->
<h3 class="fn"><a name="confirmUpdate-prop"></a><span class="name">confirmUpdate</span> : <span class="type">bool</span></h3>
<p>This property holds whether the browser confirms updates.</p>
<p>If this property is true, the browser confirms updates, otherwise updates happen immediately.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>confirmUpdate</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setConfirmUpdate</b></span> ( bool <i>confirm</i> )</td></tr>
</table>
<p><b>See also </b><a href="q3databrowser.html#confirmCancels-prop">confirmCancels</a>(), <a href="q3databrowser.html#confirmEdits-prop">confirmEdits</a>(), <a href="q3databrowser.html#confirmInsert-prop">confirmInsert</a>(), <a href="q3databrowser.html#confirmDelete-prop">confirmDelete</a>(), and <a href="q3databrowser.html#confirmEdit">confirmEdit</a>().</p>
<!-- @@@confirmUpdate -->
<!-- $$$filter-prop$$$filter$$$setFilterconstQString& -->
<h3 class="fn"><a name="filter-prop"></a><span class="name">filter</span> : <span class="type"><a href="qstring.html">QString</a></span></h3>
<p>This property holds the data browser's filter.</p>
<p>The filter applies to the data shown in the browser. Call <a href="q3databrowser.html#refresh">refresh</a>() to apply the new filter. A filter is a string containing a SQL WHERE clause without the WHERE keyword, e.g. "id>1000", "name LIKE 'A%'", etc.</p>
<p>There is no default filter.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QString </td><td class="memItemRight bottomAlign"><span class="name"><b>filter</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setFilter</b></span> ( const QString & <i>filter</i> )</td></tr>
</table>
<p><b>See also </b><a href="q3databrowser.html#sort-prop">sort</a>().</p>
<!-- @@@filter -->
<!-- $$$readOnly-prop$$$isReadOnly$$$setReadOnlybool -->
<h3 class="fn"><a name="readOnly-prop"></a><span class="name">readOnly</span> : <span class="type">bool</span></h3>
<p>This property holds whether the browser is read-only.</p>
<p>The default is false, i.e. data can be edited. If the data browser is read-only, no database edits will be allowed.</p>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b>isReadOnly</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> virtual void </td><td class="memItemRight bottomAlign"><span class="name"><b>setReadOnly</b></span> ( bool <i>active</i> )</td></tr>
</table>
<!-- @@@readOnly -->
<!-- $$$sort-prop$$$sort$$$setSortconstQSqlIndex&$$$setSortconstQStringList& -->
<h3 class="fn"><a name="sort-prop"></a><span class="name">sort</span> : <span class="type"><a href="qstringlist.html">QStringList</a></span></h3>
<p>This property holds the data browser's sort.</p>
<p>The data browser's sort affects the order in which records are viewed in the browser. Call <a href="q3databrowser.html#refresh">refresh</a>() to apply the new sort.</p>
<p>When retrieving the sort property, a string list is returned in the form 'fieldname order', e.g. 'id ASC', 'surname DESC'.</p>
<p>There is no default sort.</p>
<p>Note that if you want to iterate over the list, you should iterate over a copy, e.g.</p>
<pre class="cpp"> <span class="type"><a href="qstringlist.html">QStringList</a></span> list <span class="operator">=</span> myDataBrowser<span class="operator">.</span>sort();
<span class="type"><a href="qstringlist.html">QStringList</a></span><span class="operator">::</span>Iterator it <span class="operator">=</span> list<span class="operator">.</span>begin();
<span class="keyword">while</span>(it <span class="operator">!</span><span class="operator">=</span> list<span class="operator">.</span>end()) {
myProcessing(<span class="operator">*</span>it);
<span class="operator">+</span><span class="operator">+</span>it;
}</pre>
<p><b>Access functions:</b></p>
<table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> QStringList </td><td class="memItemRight bottomAlign"><span class="name"><b>sort</b></span> () const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSort</b></span> ( const QSqlIndex & <i>sort</i> )</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSort</b></span> ( const QStringList & <i>sort</i> )</td></tr>
</table>
<!-- @@@sort -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$Q3DataBrowser[overload1]$$$Q3DataBrowserQWidget*constchar*Qt::WindowFlags -->
<h3 class="fn"><a name="Q3DataBrowser"></a>Q3DataBrowser::<span class="name">Q3DataBrowser</span> ( <span class="type"><a href="qwidget.html">QWidget</a></span> * <i>parent</i> = 0, const <span class="type">char</span> * <i>name</i> = 0, <span class="type"><a href="qt.html#WindowType-enum">Qt::WindowFlags</a></span> <i>fl</i> = 0 )</h3>
<p>Constructs a data browser which is a child of <i>parent</i>, with the name <i>name</i> and widget flags set to <i>fl</i>.</p>
<!-- @@@Q3DataBrowser -->
<!-- $$$~Q3DataBrowser[overload1]$$$~Q3DataBrowser -->
<h3 class="fn"><a name="dtor.Q3DataBrowser"></a>Q3DataBrowser::<span class="name">~Q3DataBrowser</span> ()</h3>
<p>Destroys the object and frees any allocated resources.</p>
<!-- @@@~Q3DataBrowser -->
<!-- $$$beforeDelete[overload1]$$$beforeDeleteQSqlRecord* -->
<h3 class="fn"><a name="beforeDelete"></a><span class="type">void</span> Q3DataBrowser::<span class="name">beforeDelete</span> ( <span class="type"><a href="qsqlrecord.html">QSqlRecord</a></span> * <i>buf</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted just before the cursor's edit buffer is deleted from the database. The <i>buf</i> parameter points to the edit buffer being deleted. You might connect to this signal to capture some auditing information about the deletion.</p>
<!-- @@@beforeDelete -->
<!-- $$$beforeInsert[overload1]$$$beforeInsertQSqlRecord* -->
<h3 class="fn"><a name="beforeInsert"></a><span class="type">void</span> Q3DataBrowser::<span class="name">beforeInsert</span> ( <span class="type"><a href="qsqlrecord.html">QSqlRecord</a></span> * <i>buf</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted just before the cursor's edit buffer is inserted into the database. The <i>buf</i> parameter points to the edit buffer being inserted. You might connect to this signal to populate a generated primary key for example.</p>
<!-- @@@beforeInsert -->
<!-- $$$beforeUpdate[overload1]$$$beforeUpdateQSqlRecord* -->
<h3 class="fn"><a name="beforeUpdate"></a><span class="type">void</span> Q3DataBrowser::<span class="name">beforeUpdate</span> ( <span class="type"><a href="qsqlrecord.html">QSqlRecord</a></span> * <i>buf</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted just before the cursor's edit buffer is updated in the database. The <i>buf</i> parameter points to the edit buffer being updated. You might connect to this signal to capture some auditing information about the update.</p>
<!-- @@@beforeUpdate -->
<!-- $$$boundary[overload1]$$$boundary -->
<h3 class="fn"><a name="boundary"></a><span class="type"><a href="q3databrowser.html#Boundary-enum">Boundary</a></span> Q3DataBrowser::<span class="name">boundary</span> ()</h3>
<p>Returns an enum indicating the boundary status of the browser.</p>
<p>This is achieved by moving the default cursor and checking the position, however the current default form values will not be altered. After checking for the boundary, the cursor is moved back to its former position. See <a href="q3databrowser.html#Boundary-enum">Q3DataBrowser::Boundary</a>.</p>
<p><b>See also </b><a href="q3databrowser.html#Boundary-enum">Boundary</a>.</p>
<!-- @@@boundary -->
<!-- $$$clearValues[overload1]$$$clearValues -->
<h3 class="fn"><a name="clearValues"></a><span class="type">void</span> Q3DataBrowser::<span class="name">clearValues</span> ()<tt> [virtual slot]</tt></h3>
<p>Clears all the values in the form.</p>
<p>All the edit buffer field values are set to their 'zero state', e.g. 0 for numeric fields and "" for string fields. Then the widgets are updated using the property map. For example, a combobox that is property-mapped to integers would scroll to the first item. See the <a href="q3sqlpropertymap.html" class="compat">Q3SqlPropertyMap</a> constructor for the default mappings of widgets to properties.</p>
<!-- @@@clearValues -->
<!-- $$$confirmCancel[overload1]$$$confirmCancelQSql::Op -->
<h3 class="fn"><a name="confirmCancel"></a><span class="type"><a href="qsql-qt3.html#Confirm-enum">QSql::Confirm</a></span> Q3DataBrowser::<span class="name">confirmCancel</span> ( <span class="type"><a href="qsql-qt3.html#Op-enum">QSql::Op</a></span> <i>m</i> )<tt> [virtual protected]</tt></h3>
<p>Protected virtual function which returns a confirmation for canceling an edit mode <i>m</i>. Derived classes can reimplement this function and provide their own confirmation dialog. The default implementation uses a message box which prompts the user to confirm the edit action.</p>
<!-- @@@confirmCancel -->
<!-- $$$confirmEdit[overload1]$$$confirmEditQSql::Op -->
<h3 class="fn"><a name="confirmEdit"></a><span class="type"><a href="qsql-qt3.html#Confirm-enum">QSql::Confirm</a></span> Q3DataBrowser::<span class="name">confirmEdit</span> ( <span class="type"><a href="qsql-qt3.html#Op-enum">QSql::Op</a></span> <i>m</i> )<tt> [virtual protected]</tt></h3>
<p>Protected virtual function which returns a confirmation for an edit of mode <i>m</i>. Derived classes can reimplement this function and provide their own confirmation dialog. The default implementation uses a message box which prompts the user to confirm the edit action.</p>
<!-- @@@confirmEdit -->
<!-- $$$currentChanged[overload1]$$$currentChangedconstQSqlRecord* -->
<h3 class="fn"><a name="currentChanged"></a><span class="type">void</span> Q3DataBrowser::<span class="name">currentChanged</span> ( const <span class="type"><a href="qsqlrecord.html">QSqlRecord</a></span> * <i>record</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted whenever the current cursor position changes. The <i>record</i> parameter points to the contents of the current cursor's record.</p>
<!-- @@@currentChanged -->
<!-- $$$currentEdited[overload1]$$$currentEdited -->
<h3 class="fn"><a name="currentEdited"></a><span class="type">bool</span> Q3DataBrowser::<span class="name">currentEdited</span> ()<tt> [virtual protected]</tt></h3>
<p>Returns true if the form's edit buffer differs from the current cursor buffer; otherwise returns false.</p>
<!-- @@@currentEdited -->
<!-- $$$cursorChanged[overload1]$$$cursorChangedQ3SqlCursor::Mode -->
<h3 class="fn"><a name="cursorChanged"></a><span class="type">void</span> Q3DataBrowser::<span class="name">cursorChanged</span> ( <span class="type"><a href="q3sqlcursor.html#Mode-enum">Q3SqlCursor::Mode</a></span> <i>mode</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted whenever the cursor record was changed due to navigation. The <i>mode</i> parameter is the edit that just took place, e.g. Insert, Update or Delete. See <a href="q3sqlcursor.html#Mode-enum">Q3SqlCursor::Mode</a>.</p>
<!-- @@@cursorChanged -->
<!-- $$$del[overload1]$$$del -->
<h3 class="fn"><a name="del"></a><span class="type">void</span> Q3DataBrowser::<span class="name">del</span> ()<tt> [virtual slot]</tt></h3>
<p>Performs a delete operation on the data browser's cursor. If there is no default cursor or no default form, nothing happens.</p>
<p>Otherwise, the following happens:</p>
<p>The current form's record is deleted from the database, providing that the data browser is not in insert mode. If the data browser is actively inserting a record (see <a href="q3databrowser.html#insert">insert</a>()), the insert action is canceled, and the browser navigates to the last valid record that was current. If there is an error, <a href="q3databrowser.html#handleError">handleError</a>() is called.</p>
<!-- @@@del -->
<!-- $$$deleteCurrent[overload1]$$$deleteCurrent -->
<h3 class="fn"><a name="deleteCurrent"></a><span class="type">bool</span> Q3DataBrowser::<span class="name">deleteCurrent</span> ()<tt> [virtual protected]</tt></h3>
<p>Performs a delete on the default cursor using the values from the default form and updates the default form. If there is no default form or no default cursor, nothing happens. If the deletion was successful, the cursor is repositioned to the nearest record and true is returned. The nearest record is the next record if there is one otherwise the previous record if there is one. If an error occurred during the deletion from the database, <a href="q3databrowser.html#handleError">handleError</a>() is called and false is returned.</p>
<p><b>See also </b><a href="qwidget.html#cursor-prop">cursor</a>(), <a href="q3databrowser.html#form">form</a>(), and <a href="q3databrowser.html#handleError">handleError</a>().</p>
<!-- @@@deleteCurrent -->
<!-- $$$first[overload1]$$$first -->
<h3 class="fn"><a name="first"></a><span class="type">void</span> Q3DataBrowser::<span class="name">first</span> ()<tt> [virtual slot]</tt></h3>
<p>Moves the default cursor to the first record and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If the data browser successfully navigated to the first record, the default cursor is primed for update and the <a href="q3databrowser.html#primeUpdate">primeUpdate</a>() signal is emitted.</p>
<p>If the browser is already positioned on the first record nothing happens.</p>
<!-- @@@first -->
<!-- $$$firstRecordAvailable[overload1]$$$firstRecordAvailablebool -->
<h3 class="fn"><a name="firstRecordAvailable"></a><span class="type">void</span> Q3DataBrowser::<span class="name">firstRecordAvailable</span> ( <span class="type">bool</span> <i>available</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted whenever the position of the cursor changes. The <i>available</i> parameter indicates whether or not the first record in the default cursor is available.</p>
<!-- @@@firstRecordAvailable -->
<!-- $$$form[overload1]$$$form -->
<h3 class="fn"><a name="form"></a><span class="type"><a href="q3sqlform.html">Q3SqlForm</a></span> * Q3DataBrowser::<span class="name">form</span> ()</h3>
<p>Returns the data browser's default form or 0 if no form has been set.</p>
<p><b>See also </b><a href="q3databrowser.html#setForm">setForm</a>().</p>
<!-- @@@form -->
<!-- $$$handleError[overload1]$$$handleErrorconstQSqlError& -->
<h3 class="fn"><a name="handleError"></a><span class="type">void</span> Q3DataBrowser::<span class="name">handleError</span> ( const <span class="type"><a href="qsqlerror.html">QSqlError</a></span> & <i>error</i> )<tt> [virtual protected]</tt></h3>
<p>Virtual function which handles the error <i>error</i>. The default implementation warns the user with a message box.</p>
<!-- @@@handleError -->
<!-- $$$insert[overload1]$$$insert -->
<h3 class="fn"><a name="insert"></a><span class="type">void</span> Q3DataBrowser::<span class="name">insert</span> ()<tt> [virtual slot]</tt></h3>
<p>Performs an insert operation on the data browser's cursor. If there is no default cursor or no default form, nothing happens.</p>
<p>If auto-editing is on (see <a href="q3databrowser.html#autoEdit-prop">setAutoEdit</a>()), the following happens:</p>
<ul>
<li>If the browser is already actively inserting a record, the current form's data is inserted into the database.</li>
<li>If the browser is not inserting a record, but the current record was changed by the user, the record is updated in the database with the current form's data (i.e. with the changes).</li>
</ul>
<p>If there is an error handling any of the above auto-edit actions, <a href="q3databrowser.html#handleError">handleError</a>() is called and no insert or update is performed.</p>
<p>If no error occurred, or auto-editing is not enabled, the data browser begins actively inserting a record into the database by performing the following actions:</p>
<ul>
<li>The default cursor is primed for insert using <a href="q3sqlcursor.html#primeInsert">Q3SqlCursor::primeInsert</a>().</li>
<li>The <a href="q3databrowser.html#primeInsert">primeInsert</a>() signal is emitted.</li>
<li>The form is updated with the values in the default cursor's. edit buffer so that the user can fill in the values to be inserted.</li>
</ul>
<!-- @@@insert -->
<!-- $$$insertCurrent[overload1]$$$insertCurrent -->
<h3 class="fn"><a name="insertCurrent"></a><span class="type">bool</span> Q3DataBrowser::<span class="name">insertCurrent</span> ()<tt> [virtual protected]</tt></h3>
<p>Reads the fields from the default form into the default cursor and performs an insert on the default cursor. If there is no default form or no default cursor, nothing happens. If an error occurred during the insert into the database, <a href="q3databrowser.html#handleError">handleError</a>() is called and false is returned. If the insert was successful, the cursor is refreshed and relocated to the newly inserted record, the <a href="q3databrowser.html#cursorChanged">cursorChanged</a>() signal is emitted, and true is returned.</p>
<p><b>See also </b><a href="q3databrowser.html#cursorChanged">cursorChanged</a>(), <a href="q3databrowser.html#sqlCursor">sqlCursor</a>(), <a href="q3databrowser.html#form">form</a>(), and <a href="q3databrowser.html#handleError">handleError</a>().</p>
<!-- @@@insertCurrent -->
<!-- $$$last[overload1]$$$last -->
<h3 class="fn"><a name="last"></a><span class="type">void</span> Q3DataBrowser::<span class="name">last</span> ()<tt> [virtual slot]</tt></h3>
<p>Moves the default cursor to the last record and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If the data browser successfully navigated to the last record, the default cursor is primed for update and the <a href="q3databrowser.html#primeUpdate">primeUpdate</a>() signal is emitted.</p>
<p>If the browser is already positioned on the last record nothing happens.</p>
<!-- @@@last -->
<!-- $$$lastRecordAvailable[overload1]$$$lastRecordAvailablebool -->
<h3 class="fn"><a name="lastRecordAvailable"></a><span class="type">void</span> Q3DataBrowser::<span class="name">lastRecordAvailable</span> ( <span class="type">bool</span> <i>available</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted whenever the position of the cursor changes. The <i>available</i> parameter indicates whether or not the last record in the default cursor is available.</p>
<!-- @@@lastRecordAvailable -->
<!-- $$$next[overload1]$$$next -->
<h3 class="fn"><a name="next"></a><span class="type">void</span> Q3DataBrowser::<span class="name">next</span> ()<tt> [virtual slot]</tt></h3>
<p>Moves the default cursor to the next record and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If the data browser successfully navigated to the next record, the default cursor is primed for update and the <a href="q3databrowser.html#primeUpdate">primeUpdate</a>() signal is emitted.</p>
<p>If the browser is positioned on the last record nothing happens.</p>
<!-- @@@next -->
<!-- $$$nextRecordAvailable[overload1]$$$nextRecordAvailablebool -->
<h3 class="fn"><a name="nextRecordAvailable"></a><span class="type">void</span> Q3DataBrowser::<span class="name">nextRecordAvailable</span> ( <span class="type">bool</span> <i>available</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted whenever the position of the cursor changes. The <i>available</i> parameter indicates whether or not the next record in the default cursor is available.</p>
<!-- @@@nextRecordAvailable -->
<!-- $$$prev[overload1]$$$prev -->
<h3 class="fn"><a name="prev"></a><span class="type">void</span> Q3DataBrowser::<span class="name">prev</span> ()<tt> [virtual slot]</tt></h3>
<p>Moves the default cursor to the previous record and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If the data browser successfully navigated to the previous record, the default cursor is primed for update and the <a href="q3databrowser.html#primeUpdate">primeUpdate</a>() signal is emitted.</p>
<p>If the browser is positioned on the first record nothing happens.</p>
<!-- @@@prev -->
<!-- $$$prevRecordAvailable[overload1]$$$prevRecordAvailablebool -->
<h3 class="fn"><a name="prevRecordAvailable"></a><span class="type">void</span> Q3DataBrowser::<span class="name">prevRecordAvailable</span> ( <span class="type">bool</span> <i>available</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted whenever the position of the cursor changes. The <i>available</i> parameter indicates whether or not the previous record in the default cursor is available.</p>
<!-- @@@prevRecordAvailable -->
<!-- $$$primeDelete[overload1]$$$primeDeleteQSqlRecord* -->
<h3 class="fn"><a name="primeDelete"></a><span class="type">void</span> Q3DataBrowser::<span class="name">primeDelete</span> ( <span class="type"><a href="qsqlrecord.html">QSqlRecord</a></span> * <i>buf</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the data browser enters deletion mode. The <i>buf</i> parameter points to the record buffer being deleted. (Note that <a href="q3sqlcursor.html#primeDelete">Q3SqlCursor::primeDelete</a>() is <i>not</i> called on the default cursor, as this would corrupt values in the form.) Connect to this signal in order to, for example, save a copy of the deleted record for auditing purposes.</p>
<p><b>See also </b><a href="q3databrowser.html#del">del</a>().</p>
<!-- @@@primeDelete -->
<!-- $$$primeInsert[overload1]$$$primeInsertQSqlRecord* -->
<h3 class="fn"><a name="primeInsert"></a><span class="type">void</span> Q3DataBrowser::<span class="name">primeInsert</span> ( <span class="type"><a href="qsqlrecord.html">QSqlRecord</a></span> * <i>buf</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the data browser enters insertion mode. The <i>buf</i> parameter points to the record buffer that is to be inserted. Connect to this signal to, for example, prime the record buffer with default data values, auto-numbered fields etc. (Note that <a href="q3sqlcursor.html#primeInsert">Q3SqlCursor::primeInsert</a>() is <i>not</i> called on the default cursor, as this would corrupt values in the form.)</p>
<p><b>See also </b><a href="q3databrowser.html#insert">insert</a>().</p>
<!-- @@@primeInsert -->
<!-- $$$primeUpdate[overload1]$$$primeUpdateQSqlRecord* -->
<h3 class="fn"><a name="primeUpdate"></a><span class="type">void</span> Q3DataBrowser::<span class="name">primeUpdate</span> ( <span class="type"><a href="qsqlrecord.html">QSqlRecord</a></span> * <i>buf</i> )<tt> [signal]</tt></h3>
<p>This signal is emitted when the data browser enters update mode. Note that during navigation (<a href="q3databrowser.html#first">first</a>(), <a href="q3databrowser.html#last">last</a>(), <a href="q3databrowser.html#next">next</a>(), <a href="q3databrowser.html#prev">prev</a>()), each record that is shown in the default form is primed for update. The <i>buf</i> parameter points to the record buffer being updated. (Note that <a href="q3sqlcursor.html#primeUpdate">Q3SqlCursor::primeUpdate</a>() is <i>not</i> called on the default cursor, as this would corrupt values in the form.) Connect to this signal in order to, for example, keep track of which records have been updated, perhaps for auditing purposes.</p>
<p><b>See also </b><a href="q3databrowser.html#update">update</a>().</p>
<!-- @@@primeUpdate -->
<!-- $$$readFields[overload1]$$$readFields -->
<h3 class="fn"><a name="readFields"></a><span class="type">void</span> Q3DataBrowser::<span class="name">readFields</span> ()<tt> [virtual slot]</tt></h3>
<p>Reads the fields from the default cursor's edit buffer and displays them in the form. If there is no default cursor or no default form, nothing happens.</p>
<!-- @@@readFields -->
<!-- $$$refresh[overload1]$$$refresh -->
<h3 class="fn"><a name="refresh"></a><span class="type">void</span> Q3DataBrowser::<span class="name">refresh</span> ()<tt> [virtual slot]</tt></h3>
<p>Refreshes the data browser's data using the default cursor. The browser's current filter and sort are applied if they have been set.</p>
<p><b>See also </b><a href="q3databrowser.html#filter-prop">setFilter</a>() and <a href="q3databrowser.html#sort-prop">setSort</a>().</p>
<!-- @@@refresh -->
<!-- $$$seek[overload1]$$$seekintbool -->
<h3 class="fn"><a name="seek"></a><span class="type">bool</span> Q3DataBrowser::<span class="name">seek</span> ( <span class="type">int</span> <i>i</i>, <span class="type">bool</span> <i>relative</i> = false )<tt> [virtual]</tt></h3>
<p>Moves the default cursor to the record specified by index <i>i</i> and refreshes the default form to display that record. If there is no default form or no default cursor, nothing happens. If <i>relative</i> is true (the default is false), the cursor is moved relative to its current position. If the data browser successfully navigated to the desired record, the default cursor is primed for update and the <a href="q3databrowser.html#primeUpdate">primeUpdate</a>() signal is emitted.</p>
<p>If the browser is already positioned on the desired record nothing happens. Returns false if there is no cursor. Otherwise returns true.</p>
<!-- @@@seek -->
<!-- $$$setForm[overload1]$$$setFormQ3SqlForm* -->
<h3 class="fn"><a name="setForm"></a><span class="type">void</span> Q3DataBrowser::<span class="name">setForm</span> ( <span class="type"><a href="q3sqlform.html">Q3SqlForm</a></span> * <i>form</i> )<tt> [virtual]</tt></h3>
<p>Sets the browser's default form to <i>form</i>. The cursor and all navigation and data manipulation functions that the browser provides become available to the <i>form</i>.</p>
<p><b>See also </b><a href="q3databrowser.html#form">form</a>().</p>
<!-- @@@setForm -->
<!-- $$$setSqlCursor[overload1]$$$setSqlCursorQ3SqlCursor*bool -->
<h3 class="fn"><a name="setSqlCursor"></a><span class="type">void</span> Q3DataBrowser::<span class="name">setSqlCursor</span> ( <span class="type"><a href="q3sqlcursor.html">Q3SqlCursor</a></span> * <i>cursor</i>, <span class="type">bool</span> <i>autoDelete</i> = false )<tt> [virtual]</tt></h3>
<p>Sets the default cursor used by the data browser to <i>cursor</i>. If <i>autoDelete</i> is true (the default is false), the data browser takes ownership of the <i>cursor</i> pointer, which will be deleted when the browser is destroyed, or when setSqlCursor() is called again. To activate the <i>cursor</i> use <a href="q3databrowser.html#refresh">refresh</a>(). The cursor's edit buffer is used in the default form to browse and edit records.</p>
<p><b>See also </b><a href="q3databrowser.html#sqlCursor">sqlCursor</a>(), <a href="q3databrowser.html#form">form</a>(), and <a href="q3databrowser.html#setForm">setForm</a>().</p>
<!-- @@@setSqlCursor -->
<!-- $$$sqlCursor[overload1]$$$sqlCursor -->
<h3 class="fn"><a name="sqlCursor"></a><span class="type"><a href="q3sqlcursor.html">Q3SqlCursor</a></span> * Q3DataBrowser::<span class="name">sqlCursor</span> () const</h3>
<p>Returns the default cursor used for navigation, or 0 if there is no default cursor.</p>
<p><b>See also </b><a href="q3databrowser.html#setSqlCursor">setSqlCursor</a>().</p>
<!-- @@@sqlCursor -->
<!-- $$$update[overload1]$$$update -->
<h3 class="fn"><a name="update"></a><span class="type">void</span> Q3DataBrowser::<span class="name">update</span> ()<tt> [virtual slot]</tt></h3>
<p>Performs an update operation on the data browser's cursor.</p>
<p>If there is no default cursor or no default form, nothing happens. Otherwise, the following happens:</p>
<p>If the data browser is actively inserting a record (see <a href="q3databrowser.html#insert">insert</a>()), that record is inserted into the database using <a href="q3databrowser.html#insertCurrent">insertCurrent</a>(). Otherwise, the database is updated with the current form's data using <a href="q3databrowser.html#updateCurrent">updateCurrent</a>(). If there is an error handling either action, <a href="q3databrowser.html#handleError">handleError</a>() is called.</p>
<!-- @@@update -->
<!-- $$$updateBoundary[overload1]$$$updateBoundary -->
<h3 class="fn"><a name="updateBoundary"></a><span class="type">void</span> Q3DataBrowser::<span class="name">updateBoundary</span> ()<tt> [slot]</tt></h3>
<p>If <a href="q3databrowser.html#boundaryChecking-prop">boundaryChecking</a>() is true, checks the boundary of the current default cursor and emits signals which indicate the position of the cursor.</p>
<!-- @@@updateBoundary -->
<!-- $$$updateCurrent[overload1]$$$updateCurrent -->
<h3 class="fn"><a name="updateCurrent"></a><span class="type">bool</span> Q3DataBrowser::<span class="name">updateCurrent</span> ()<tt> [virtual protected]</tt></h3>
<p>Reads the fields from the default form into the default cursor and performs an update on the default cursor. If there is no default form or no default cursor, nothing happens. If an error occurred during the update on the database, <a href="q3databrowser.html#handleError">handleError</a>() is called and false is returned. If the update was successful, the cursor is refreshed and relocated to the updated record, the <a href="q3databrowser.html#cursorChanged">cursorChanged</a>() signal is emitted, and true is returned.</p>
<p><b>See also </b><a href="qwidget.html#cursor-prop">cursor</a>(), <a href="q3databrowser.html#form">form</a>(), and <a href="q3databrowser.html#handleError">handleError</a>().</p>
<!-- @@@updateCurrent -->
<!-- $$$writeFields[overload1]$$$writeFields -->
<h3 class="fn"><a name="writeFields"></a><span class="type">void</span> Q3DataBrowser::<span class="name">writeFields</span> ()<tt> [virtual slot]</tt></h3>
<p>Writes the form's data to the default cursor's edit buffer. If there is no default cursor or no default form, nothing happens.</p>
<!-- @@@writeFields -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
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.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
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. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
1dd17e0d683ef79b4bb6872bbf359d7f
>
files
>
4500
