diff options
Diffstat (limited to 'doc/html/tqdatabrowser.html')
| -rw-r--r-- | doc/html/tqdatabrowser.html | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/doc/html/tqdatabrowser.html b/doc/html/tqdatabrowser.html index fbef3df52..da1cb4784 100644 --- a/doc/html/tqdatabrowser.html +++ b/doc/html/tqdatabrowser.html @@ -49,7 +49,7 @@ navigation for data entry forms. <li class=fn>TQStringList <a href="#sort"><b>sort</b></a> () const</li> <li class=fn>void <a href="#setFilter"><b>setFilter</b></a> ( const TQString & filter )</li> <li class=fn>TQString <a href="#filter"><b>filter</b></a> () const</li> -<li class=fn>virtual void <a href="#setSqlCursor"><b>setSqlCursor</b></a> ( TQSqlCursor * cursor, bool autoDelete = FALSE )</li> +<li class=fn>virtual void <a href="#setSqlCursor"><b>setSqlCursor</b></a> ( TQSqlCursor * cursor, bool autoDelete = false )</li> <li class=fn>TQSqlCursor * <a href="#sqlCursor"><b>sqlCursor</b></a> () const</li> <li class=fn>virtual void <a href="#setForm"><b>setForm</b></a> ( TQSqlForm * form )</li> <li class=fn>TQSqlForm * <a href="#form"><b>form</b></a> ()</li> @@ -67,7 +67,7 @@ navigation for data entry forms. <li class=fn>bool <a href="#isReadOnly"><b>isReadOnly</b></a> () const</li> <li class=fn>virtual void <a href="#setAutoEdit"><b>setAutoEdit</b></a> ( bool autoEdit )</li> <li class=fn>bool <a href="#autoEdit"><b>autoEdit</b></a> () const</li> -<li class=fn>virtual bool <a href="#seek"><b>seek</b></a> ( int i, bool relative = FALSE )</li> +<li class=fn>virtual bool <a href="#seek"><b>seek</b></a> ( int i, bool relative = false )</li> </ul> <h2>Public Slots</h2> <ul> @@ -215,7 +215,7 @@ name <em>name</em> and widget flags set to <em>fl</em>. Destroys the object and frees any allocated resources. <h3 class=fn>bool <a name="autoEdit"></a>TQDataBrowser::autoEdit () const -</h3><p>Returns TRUE if the browser automatically applies edits; otherwise returns FALSE. +</h3><p>Returns true if the browser automatically applies edits; otherwise returns false. See the <a href="tqdatabrowser.html#autoEdit-prop">"autoEdit"</a> property for details. <h3 class=fn>void <a name="beforeDelete"></a>TQDataBrowser::beforeDelete ( <a href="tqsqlrecord.html">TQSqlRecord</a> * buf )<tt> [signal]</tt> </h3> @@ -251,7 +251,7 @@ to its former position. See <a href="#Boundary-enum">TQDataBrowser::Boundary</a> <p> <p>See also <a href="#Boundary-enum">Boundary</a>. <h3 class=fn>bool <a name="boundaryChecking"></a>TQDataBrowser::boundaryChecking () const -</h3><p>Returns TRUE if boundary checking is active; otherwise returns FALSE. +</h3><p>Returns true if boundary checking is active; otherwise returns false. See the <a href="tqdatabrowser.html#boundaryChecking-prop">"boundaryChecking"</a> property for details. <h3 class=fn>void <a name="clearValues"></a>TQDataBrowser::clearValues ()<tt> [virtual slot]</tt> </h3> @@ -272,10 +272,10 @@ implementation uses a message box which prompts the user to confirm the edit action. <h3 class=fn>bool <a name="confirmCancels"></a>TQDataBrowser::confirmCancels () const -</h3><p>Returns TRUE if the browser confirms cancel operations; otherwise returns FALSE. +</h3><p>Returns true if the browser confirms cancel operations; otherwise returns false. See the <a href="tqdatabrowser.html#confirmCancels-prop">"confirmCancels"</a> property for details. <h3 class=fn>bool <a name="confirmDelete"></a>TQDataBrowser::confirmDelete () const -</h3><p>Returns TRUE if the browser confirms deletions; otherwise returns FALSE. +</h3><p>Returns true if the browser confirms deletions; otherwise returns false. See the <a href="tqdatabrowser.html#confirmDelete-prop">"confirmDelete"</a> property for details. <h3 class=fn><a href="tqsql.html#Confirm-enum">TQSql::Confirm</a> <a name="confirmEdit"></a>TQDataBrowser::confirmEdit ( <a href="tqsql.html#Op-enum">TQSql::Op</a> m )<tt> [virtual protected]</tt> </h3> @@ -286,13 +286,13 @@ implementation uses a message box which prompts the user to confirm the edit action. <h3 class=fn>bool <a name="confirmEdits"></a>TQDataBrowser::confirmEdits () const -</h3><p>Returns TRUE if the browser confirms edits; otherwise returns FALSE. +</h3><p>Returns true if the browser confirms edits; otherwise returns false. See the <a href="tqdatabrowser.html#confirmEdits-prop">"confirmEdits"</a> property for details. <h3 class=fn>bool <a name="confirmInsert"></a>TQDataBrowser::confirmInsert () const -</h3><p>Returns TRUE if the data browser confirms insertions; otherwise returns FALSE. +</h3><p>Returns true if the data browser confirms insertions; otherwise returns false. See the <a href="tqdatabrowser.html#confirmInsert-prop">"confirmInsert"</a> property for details. <h3 class=fn>bool <a name="confirmUpdate"></a>TQDataBrowser::confirmUpdate () const -</h3><p>Returns TRUE if the browser confirms updates; otherwise returns FALSE. +</h3><p>Returns true if the browser confirms updates; otherwise returns false. See the <a href="tqdatabrowser.html#confirmUpdate-prop">"confirmUpdate"</a> property for details. <h3 class=fn>void <a name="currentChanged"></a>TQDataBrowser::currentChanged ( const <a href="tqsqlrecord.html">TQSqlRecord</a> * record )<tt> [signal]</tt> </h3> @@ -303,8 +303,8 @@ current cursor's record. <h3 class=fn>bool <a name="currentEdited"></a>TQDataBrowser::currentEdited ()<tt> [virtual protected]</tt> </h3> -Returns TRUE if the form's edit buffer differs from the current -cursor buffer; otherwise returns FALSE. +Returns true if the form's edit buffer differs from the current +cursor buffer; otherwise returns false. <h3 class=fn>void <a name="cursorChanged"></a>TQDataBrowser::cursorChanged ( <a href="tqsqlcursor.html#Mode-enum">TQSqlCursor::Mode</a> mode )<tt> [signal]</tt> </h3> @@ -330,10 +330,10 @@ 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 +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="#handleError">handleError</a>() is -called and FALSE is returned. +called and false is returned. <p> <p>See also <a href="tqwidget.html#cursor-prop">cursor</a>, <a href="#form">form</a>(), and <a href="#handleError">handleError</a>(). <h3 class=fn><a href="tqstring.html">TQString</a> <a name="filter"></a>TQDataBrowser::filter () const @@ -396,13 +396,13 @@ 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="#handleError">handleError</a>() is called and -FALSE is returned. If the insert was successfull, the cursor is +false is returned. If the insert was successfull, the cursor is refreshed and relocated to the newly inserted record, the -<a href="#cursorChanged">cursorChanged</a>() signal is emitted, and TRUE is returned. +<a href="#cursorChanged">cursorChanged</a>() signal is emitted, and true is returned. <p> <p>See also <a href="#cursorChanged">cursorChanged</a>(), <a href="#sqlCursor">sqlCursor</a>(), <a href="#form">form</a>(), and <a href="#handleError">handleError</a>(). <h3 class=fn>bool <a name="isReadOnly"></a>TQDataBrowser::isReadOnly () const -</h3><p>Returns TRUE if the browser is read-only; otherwise returns FALSE. +</h3><p>Returns true if the browser is read-only; otherwise returns false. See the <a href="tqdatabrowser.html#readOnly-prop">"readOnly"</a> property for details. <h3 class=fn>void <a name="last"></a>TQDataBrowser::last ()<tt> [virtual slot]</tt> </h3> @@ -501,11 +501,11 @@ browser's current filter and sort are applied if they have been set. <p> <p>See also <a href="#filter-prop">filter</a> and <a href="#sort-prop">sort</a>. -<h3 class=fn>bool <a name="seek"></a>TQDataBrowser::seek ( int i, bool relative = FALSE )<tt> [virtual]</tt> +<h3 class=fn>bool <a name="seek"></a>TQDataBrowser::seek ( int i, bool relative = false )<tt> [virtual]</tt> </h3> Moves the default cursor to the record specified by the index <em>i</em> and refreshes the default form to display this record. If there is -no default form or no default cursor, nothing happens. If <em>relative</em> is TRUE (the default is FALSE), the cursor is moved +no default form or no default cursor, nothing happens. If <em>relative</em> 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="#primeUpdate">primeUpdate</a>() signal is emitted. @@ -554,10 +554,10 @@ This is an overloaded member function, provided for convenience. It behaves esse <p> Sets the data browser's sort to the <a href="tqsqlindex.html">TQSqlIndex</a> <em>sort</em>. To apply the new sort, use <a href="#refresh">refresh</a>(). <p> -<h3 class=fn>void <a name="setSqlCursor"></a>TQDataBrowser::setSqlCursor ( <a href="tqsqlcursor.html">TQSqlCursor</a> * cursor, bool autoDelete = FALSE )<tt> [virtual]</tt> +<h3 class=fn>void <a name="setSqlCursor"></a>TQDataBrowser::setSqlCursor ( <a href="tqsqlcursor.html">TQSqlCursor</a> * cursor, bool autoDelete = false )<tt> [virtual]</tt> </h3> Sets the default cursor used by the data browser to <em>cursor</em>. If -<em>autoDelete</em> is TRUE (the default is FALSE), the data browser +<em>autoDelete</em> is true (the default is false), the data browser takes ownership of the <em>cursor</em> pointer, which will be deleted when the browser is destroyed, or when <a href="#setSqlCursor">setSqlCursor</a>() is called again. To activate the <em>cursor</em> use <a href="#refresh">refresh</a>(). The cursor's edit @@ -586,7 +586,7 @@ action, <a href="#handleError">handleError</a>() is called. <h3 class=fn>void <a name="updateBoundary"></a>TQDataBrowser::updateBoundary ()<tt> [slot]</tt> </h3> -If <a href="#boundaryChecking">boundaryChecking</a>() is TRUE, checks the boundary of the current +If <a href="#boundaryChecking">boundaryChecking</a>() is true, checks the boundary of the current default cursor and emits signals which indicate the position of the cursor. @@ -596,9 +596,9 @@ 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="#handleError">handleError</a>() is called and -FALSE is returned. If the update was successfull, the cursor is +false is returned. If the update was successfull, the cursor is refreshed and relocated to the updated record, the <a href="#cursorChanged">cursorChanged</a>() -signal is emitted, and TRUE is returned. +signal is emitted, and true is returned. <p> <p>See also <a href="tqwidget.html#cursor-prop">cursor</a>, <a href="#form">form</a>(), and <a href="#handleError">handleError</a>(). <h3 class=fn>void <a name="writeFields"></a>TQDataBrowser::writeFields ()<tt> [virtual slot]</tt> @@ -609,12 +609,12 @@ there is no default cursor or no default form, nothing happens. <hr><h2>Property Documentation</h2> <h3 class=fn>bool <a name="autoEdit-prop"></a>autoEdit</h3> <p>This property holds whether the browser automatically applies edits. -<p>The default value for this property is TRUE. When the user begins +<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> the insert or update is discarded -- this occurs if autoEdit is FALSE +<li> the insert or update is is performed -- this occurs if autoEdit is true +<li> the insert or update is discarded -- this occurs if autoEdit is false </ul> <p>Set this property's value with <a href="#setAutoEdit">setAutoEdit</a>() and get this property's value with <a href="#autoEdit">autoEdit</a>(). @@ -627,23 +627,23 @@ emitted indicating the current position of the default cursor. <p>Set this property's value with <a href="#setBoundaryChecking">setBoundaryChecking</a>() and get this property's value with <a href="#boundaryChecking">boundaryChecking</a>(). <h3 class=fn>bool <a name="confirmCancels-prop"></a>confirmCancels</h3> <p>This property holds whether the browser confirms cancel operations. -<p>If this property is TRUE, all cancels must be confirmed by the +<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="#confirmCancel">confirmCancel</a>() function), otherwise all cancels -occur immediately. The default is FALSE. +occur immediately. The default is false. <p> <p>See also <a href="#confirmEdits-prop">confirmEdits</a> and <a href="#confirmCancel">confirmCancel</a>(). <p>Set this property's value with <a href="#setConfirmCancels">setConfirmCancels</a>() and get this property's value with <a href="#confirmCancels">confirmCancels</a>(). <h3 class=fn>bool <a name="confirmDelete-prop"></a>confirmDelete</h3> <p>This property holds whether the browser confirms deletions. -<p>If this property is TRUE, the browser confirms deletions, +<p>If this property is true, the browser confirms deletions, otherwise deletions happen immediately. <p> <p>See also <a href="#confirmCancels-prop">confirmCancels</a>, <a href="#confirmEdits-prop">confirmEdits</a>, <a href="#confirmUpdate-prop">confirmUpdate</a>, <a href="#confirmInsert-prop">confirmInsert</a>, and <a href="#confirmEdit">confirmEdit</a>(). <p>Set this property's value with <a href="#setConfirmDelete">setConfirmDelete</a>() and get this property's value with <a href="#confirmDelete">confirmDelete</a>(). <h3 class=fn>bool <a name="confirmEdits-prop"></a>confirmEdits</h3> <p>This property holds whether the browser confirms edits. -<p>If this property is TRUE, the browser confirms all edit operations +<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 @@ -653,14 +653,14 @@ reimplementing the <a href="#confirmEdit">confirmEdit</a>() function, <p>Set this property's value with <a href="#setConfirmEdits">setConfirmEdits</a>() and get this property's value with <a href="#confirmEdits">confirmEdits</a>(). <h3 class=fn>bool <a name="confirmInsert-prop"></a>confirmInsert</h3> <p>This property holds whether the data browser confirms insertions. -<p>If this property is TRUE, the browser confirms insertions, +<p>If this property is true, the browser confirms insertions, otherwise insertions happen immediately. <p> <p>See also <a href="#confirmCancels-prop">confirmCancels</a>, <a href="#confirmEdits-prop">confirmEdits</a>, <a href="#confirmUpdate-prop">confirmUpdate</a>, <a href="#confirmDelete-prop">confirmDelete</a>, and <a href="#confirmEdit">confirmEdit</a>(). <p>Set this property's value with <a href="#setConfirmInsert">setConfirmInsert</a>() and get this property's value with <a href="#confirmInsert">confirmInsert</a>(). <h3 class=fn>bool <a name="confirmUpdate-prop"></a>confirmUpdate</h3> <p>This property holds whether the browser confirms updates. -<p>If this property is TRUE, the browser confirms updates, otherwise +<p>If this property is true, the browser confirms updates, otherwise updates happen immediately. <p> <p>See also <a href="#confirmCancels-prop">confirmCancels</a>, <a href="#confirmEdits-prop">confirmEdits</a>, <a href="#confirmInsert-prop">confirmInsert</a>, <a href="#confirmDelete-prop">confirmDelete</a>, and <a href="#confirmEdit">confirmEdit</a>(). @@ -677,7 +677,7 @@ a SQL WHERE clause without the WHERE keyword, e.g. "id>1000", <p>Set this property's value with <a href="#setFilter">setFilter</a>() and get this property's value with <a href="#filter">filter</a>(). <h3 class=fn>bool <a name="readOnly-prop"></a>readOnly</h3> <p>This property holds whether the browser is read-only. -<p>The default is FALSE, i.e. data can be edited. If the data browser +<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>Set this property's value with <a href="#setReadOnly">setReadOnly</a>() and get this property's value with <a href="#isReadOnly">isReadOnly</a>(). |