diff options
Diffstat (limited to 'doc/html/tqdatatable.html')
| -rw-r--r-- | doc/html/tqdatatable.html | 86 |
1 files changed, 43 insertions, 43 deletions
diff --git a/doc/html/tqdatatable.html b/doc/html/tqdatatable.html index df11bc709..4e5e7b4cc 100644 --- a/doc/html/tqdatatable.html +++ b/doc/html/tqdatatable.html @@ -38,7 +38,7 @@ body { background: #ffffff; color: black; } <h2>Public Members</h2> <ul> <li class=fn><a href="#TQDataTable"><b>TQDataTable</b></a> ( TQWidget * parent = 0, const char * name = 0 )</li> -<li class=fn><a href="#TQDataTable-2"><b>TQDataTable</b></a> ( TQSqlCursor * cursor, bool autoPopulate = FALSE, TQWidget * parent = 0, const char * name = 0 )</li> +<li class=fn><a href="#TQDataTable-2"><b>TQDataTable</b></a> ( TQSqlCursor * cursor, bool autoPopulate = false, TQWidget * parent = 0, const char * name = 0 )</li> <li class=fn><a href="#~TQDataTable"><b>~TQDataTable</b></a> ()</li> <li class=fn>virtual void <a href="#addColumn"><b>addColumn</b></a> ( const TQString & fieldName, const TQString & label = TQString::null, int width = -1, const TQIconSet & iconset = TQIconSet ( ) )</li> <li class=fn>virtual void <a href="#removeColumn"><b>removeColumn</b></a> ( uint col )</li> @@ -56,7 +56,7 @@ body { background: #ffffff; color: black; } <li class=fn>bool <a href="#autoEdit"><b>autoEdit</b></a> () const</li> <li class=fn>TQString <a href="#filter"><b>filter</b></a> () const</li> <li class=fn>TQStringList <a href="#sort"><b>sort</b></a> () const</li> -<li class=fn>virtual void <a href="#setSqlCursor"><b>setSqlCursor</b></a> ( TQSqlCursor * cursor = 0, bool autoPopulate = FALSE, bool autoDelete = FALSE )</li> +<li class=fn>virtual void <a href="#setSqlCursor"><b>setSqlCursor</b></a> ( TQSqlCursor * cursor = 0, bool autoPopulate = false, bool autoDelete = false )</li> <li class=fn>TQSqlCursor * <a href="#sqlCursor"><b>sqlCursor</b></a> () const</li> <li class=fn>virtual void <a href="#setNullText"><b>setNullText</b></a> ( const TQString & nullText )</li> <li class=fn>virtual void <a href="#setTrueText"><b>setTrueText</b></a> ( const TQString & trueText )</li> @@ -74,7 +74,7 @@ body { background: #ffffff; color: black; } <li class=fn>virtual void <a href="#setSort-2"><b>setSort</b></a> ( const TQSqlIndex & sort )</li> <li class=fn>enum <a href="#Refresh-enum"><b>Refresh</b></a> { RefreshData = 1, RefreshColumns = 2, RefreshAll = 3 }</li> <li class=fn>void <a href="#refresh-2"><b>refresh</b></a> ( Refresh mode )</li> -<li class=fn>virtual void <a href="#sortColumn"><b>sortColumn</b></a> ( int col, bool ascending = TRUE, bool wholeRows = FALSE )</li> +<li class=fn>virtual void <a href="#sortColumn"><b>sortColumn</b></a> ( int col, bool ascending = true, bool wholeRows = false )</li> <li class=fn>virtual TQString <a href="#text"><b>text</b></a> ( int row, int col ) const</li> <li class=fn>TQVariant <a href="#value"><b>value</b></a> ( int row, int col ) const</li> <li class=fn>TQSqlRecord * <a href="#currentRecord"><b>currentRecord</b></a> () const</li> @@ -171,7 +171,7 @@ initiated by pressing F2 (or right clicking and then clicking the appropriate popup menu item) and canceled by pressing Esc. If there is a problem updating or adding data, errors are handled automatically (see <a href="#handleError">handleError</a>() to change this behavior). Note -that if <a href="#autoEdit">autoEdit</a>() is FALSE navigating to another record will +that if <a href="#autoEdit">autoEdit</a>() is false navigating to another record will cancel the insert or update. <p> The user can be asked to confirm all edits with <a href="#setConfirmEdits">setConfirmEdits</a>(). For more precise control use <a href="#setConfirmInsert">setConfirmInsert</a>(), @@ -212,7 +212,7 @@ options see <a href="#setSort">setSort</a>(), <a href="#sortColumn">sortColumn</ <a href="#sortDescending">sortDescending</a>(). Note that sorting operations will not behave as expected if you are using a <a href="tqsqlselectcursor.html">TQSqlSelectCursor</a> because it uses user-defined SQL queries to obtain data. -<p> The text used to represent NULL, TRUE and FALSE values can be +<p> The text used to represent NULL, true and false values can be changed with <a href="#setNullText">setNullText</a>(), <a href="#setTrueText">setTrueText</a>() and <a href="#setFalseText">setFalseText</a>() respectively. You can change the appearance of cells by reimplementing <a href="#paintField">paintField</a>(). @@ -239,11 +239,11 @@ Just before the database is updated a signal is emitted; Constructs a data table which is a child of <em>parent</em>, called name <em>name</em>. -<h3 class=fn><a name="TQDataTable-2"></a>TQDataTable::TQDataTable ( <a href="tqsqlcursor.html">TQSqlCursor</a> * cursor, bool autoPopulate = FALSE, <a href="tqwidget.html">TQWidget</a> * parent = 0, const char * name = 0 ) +<h3 class=fn><a name="TQDataTable-2"></a>TQDataTable::TQDataTable ( <a href="tqsqlcursor.html">TQSqlCursor</a> * cursor, bool autoPopulate = false, <a href="tqwidget.html">TQWidget</a> * parent = 0, const char * name = 0 ) </h3> Constructs a data table which is a child of <em>parent</em>, called name <em>name</em> using the cursor <em>cursor</em>. -<p> If <em>autoPopulate</em> is TRUE (the default is FALSE), columns are +<p> If <em>autoPopulate</em> is true (the default is false), columns are automatically created based upon the fields in the <em>cursor</em> record. Note that <em>autoPopulate</em> only governs the creation of columns; to load the cursor's data into the table use <a href="#refresh">refresh</a>(). @@ -278,11 +278,11 @@ result sets. <p>Reimplemented from <a href="tqtable.html#adjustColumn">TQTable</a>. <h3 class=fn>bool <a name="autoDelete"></a>TQDataTable::autoDelete () const </h3> -Returns TRUE if the table will automatically delete the cursor -specified by <a href="#setSqlCursor">setSqlCursor</a>(); otherwise returns FALSE. +Returns true if the table will automatically delete the cursor +specified by <a href="#setSqlCursor">setSqlCursor</a>(); otherwise returns false. <h3 class=fn>bool <a name="autoEdit"></a>TQDataTable::autoEdit () const -</h3><p>Returns TRUE if the data table automatically applies edits; otherwise returns FALSE. +</h3><p>Returns true if the data table automatically applies edits; otherwise returns false. See the <a href="tqdatatable.html#autoEdit-prop">"autoEdit"</a> property for details. <h3 class=fn>void <a name="beforeDelete"></a>TQDataTable::beforeDelete ( <a href="tqsqlrecord.html">TQSqlRecord</a> * buf )<tt> [signal]</tt> </h3> @@ -339,10 +339,10 @@ implementation uses a message box which prompts the user to confirm the cancel. <h3 class=fn>bool <a name="confirmCancels"></a>TQDataTable::confirmCancels () const -</h3><p>Returns TRUE if the data table confirms cancel operations; otherwise returns FALSE. +</h3><p>Returns true if the data table confirms cancel operations; otherwise returns false. See the <a href="tqdatatable.html#confirmCancels-prop">"confirmCancels"</a> property for details. <h3 class=fn>bool <a name="confirmDelete"></a>TQDataTable::confirmDelete () const -</h3><p>Returns TRUE if the data table confirms delete operations; otherwise returns FALSE. +</h3><p>Returns true if the data table confirms delete operations; otherwise returns false. See the <a href="tqdatatable.html#confirmDelete-prop">"confirmDelete"</a> property for details. <h3 class=fn><a href="tqsql.html#Confirm-enum">TQSql::Confirm</a> <a name="confirmEdit"></a>TQDataTable::confirmEdit ( <a href="tqsql.html#Op-enum">TQSql::Op</a> m )<tt> [virtual protected]</tt> </h3> @@ -353,13 +353,13 @@ implementation uses a message box which prompts the user to confirm the edit action. <h3 class=fn>bool <a name="confirmEdits"></a>TQDataTable::confirmEdits () const -</h3><p>Returns TRUE if the data table confirms edit operations; otherwise returns FALSE. +</h3><p>Returns true if the data table confirms edit operations; otherwise returns false. See the <a href="tqdatatable.html#confirmEdits-prop">"confirmEdits"</a> property for details. <h3 class=fn>bool <a name="confirmInsert"></a>TQDataTable::confirmInsert () const -</h3><p>Returns TRUE if the data table confirms insert operations; otherwise returns FALSE. +</h3><p>Returns true if the data table confirms insert operations; otherwise returns false. See the <a href="tqdatatable.html#confirmInsert-prop">"confirmInsert"</a> property for details. <h3 class=fn>bool <a name="confirmUpdate"></a>TQDataTable::confirmUpdate () const -</h3><p>Returns TRUE if the data table confirms update operations; otherwise returns FALSE. +</h3><p>Returns true if the data table confirms update operations; otherwise returns false. See the <a href="tqdatatable.html#confirmUpdate-prop">"confirmUpdate"</a> property for details. <h3 class=fn>void <a name="currentChanged"></a>TQDataTable::currentChanged ( <a href="tqsqlrecord.html">TQSqlRecord</a> * record )<tt> [signal]</tt> </h3> @@ -389,9 +389,9 @@ See the <a href="tqdatatable.html#dateFormat-prop">"dateFormat"</a> property for For an editable table, issues a delete on the current cursor's primary index using the values of the currently selected row. If there is no current cursor or there is no current selection, -nothing happens. If <a href="#confirmEdits">confirmEdits</a>() or <a href="#confirmDelete">confirmDelete</a>() is TRUE, -<a href="#confirmEdit">confirmEdit</a>() is called to confirm the delete. Returns TRUE if the -delete succeeded; otherwise FALSE. +nothing happens. If <a href="#confirmEdits">confirmEdits</a>() or <a href="#confirmDelete">confirmDelete</a>() is true, +<a href="#confirmEdit">confirmEdit</a>() is called to confirm the delete. Returns true if the +delete succeeded; otherwise false. <p> The underlying cursor must have a valid primary index to ensure that a unique record is deleted within the database otherwise the database may be changed to an inconsistent state. @@ -409,9 +409,9 @@ See the <a href="tqdatatable.html#filter-prop">"filter"</a> property for details <h3 class=fn>void <a name="find"></a>TQDataTable::find ( const <a href="tqstring.html">TQString</a> & str, bool caseSensitive, bool backwards )<tt> [virtual slot]</tt> </h3> Searches the current cursor for a cell containing the string <em>str</em> starting at the current cell and working forwards (or -backwards if <em>backwards</em> is TRUE). If the string is found, the -cell containing the string is set as the current cell. If <em>caseSensitive</em> is FALSE the case of <em>str</em> will be ignored. -<p> The search will wrap, i.e. if the first (or if backwards is TRUE, +backwards if <em>backwards</em> is true). If the string is found, the +cell containing the string is set as the current cell. If <em>caseSensitive</em> is false the case of <em>str</em> will be ignored. +<p> The search will wrap, i.e. if the first (or if backwards is true, last) cell is reached without finding <em>str</em> the search will continue until it reaches the starting cell. If <em>str</em> is not found the search will fail and the current cell will remain @@ -434,9 +434,9 @@ is displayed in column <em>i</em>. For an editable table, issues an insert on the current cursor using the values in the cursor's edit buffer. If there is no current cursor or there is no current "insert" row, nothing -happens. If <a href="#confirmEdits">confirmEdits</a>() or <a href="#confirmInsert">confirmInsert</a>() is TRUE, -<a href="#confirmEdit">confirmEdit</a>() is called to confirm the insert. Returns TRUE if the -insert succeeded; otherwise returns FALSE. +happens. If <a href="#confirmEdits">confirmEdits</a>() or <a href="#confirmInsert">confirmInsert</a>() is true, +<a href="#confirmEdit">confirmEdit</a>() is called to confirm the insert. Returns true if the +insert succeeded; otherwise returns false. <p> The underlying cursor must have a valid primary index to ensure that a unique record is inserted within the database otherwise the database may be changed to an inconsistent state. @@ -536,8 +536,8 @@ Resets the table so that it displays no data. <h3 class=fn>void <a name="setAutoDelete"></a>TQDataTable::setAutoDelete ( bool enable )<tt> [virtual]</tt> </h3> Sets the cursor auto-delete flag to <em>enable</em>. If <em>enable</em> is -TRUE, the table will automatically delete the cursor specified by -<a href="#setSqlCursor">setSqlCursor</a>(). If <em>enable</em> is FALSE (the default), the cursor +true, the table will automatically delete the cursor specified by +<a href="#setSqlCursor">setSqlCursor</a>(). If <em>enable</em> is false (the default), the cursor will not be deleted. <h3 class=fn>void <a name="setAutoEdit"></a>TQDataTable::setAutoEdit ( bool autoEdit )<tt> [virtual]</tt> @@ -609,12 +609,12 @@ field names and their ordering (ASC or DESC); these are used to compose the ORDER BY clause. <p> <p>See also <a href="#sort-prop">sort</a>. -<h3 class=fn>void <a name="setSqlCursor"></a>TQDataTable::setSqlCursor ( <a href="tqsqlcursor.html">TQSqlCursor</a> * cursor = 0, bool autoPopulate = FALSE, bool autoDelete = FALSE )<tt> [virtual]</tt> +<h3 class=fn>void <a name="setSqlCursor"></a>TQDataTable::setSqlCursor ( <a href="tqsqlcursor.html">TQSqlCursor</a> * cursor = 0, bool autoPopulate = false, bool autoDelete = false )<tt> [virtual]</tt> </h3> Sets <em>cursor</em> as the data source for the table. To force the -display of the data from <em>cursor</em>, use <a href="#refresh">refresh</a>(). If <em>autoPopulate</em> is TRUE, columns are automatically created based upon -the fields in the <em>cursor</em> record. If <em>autoDelete</em> is TRUE (the -default is FALSE), the table will take ownership of the <em>cursor</em> +display of the data from <em>cursor</em>, use <a href="#refresh">refresh</a>(). If <em>autoPopulate</em> is true, columns are automatically created based upon +the fields in the <em>cursor</em> record. If <em>autoDelete</em> is true (the +default is false), the table will take ownership of the <em>cursor</em> and delete it when appropriate. If the <em>cursor</em> is read-only, the table becomes read-only. The table adopts the cursor's driver's definition for representing NULL values as strings. @@ -631,9 +631,9 @@ See the <a href="tqdatatable.html#sort-prop">"sort"</a> property for details. Sorts column <em>col</em> in ascending order. <p> <p>See also <a href="tqtable.html#sorting-prop">sorting</a>. -<h3 class=fn>void <a name="sortColumn"></a>TQDataTable::sortColumn ( int col, bool ascending = TRUE, bool wholeRows = FALSE )<tt> [virtual]</tt> +<h3 class=fn>void <a name="sortColumn"></a>TQDataTable::sortColumn ( int col, bool ascending = true, bool wholeRows = false )<tt> [virtual]</tt> </h3> -Sorts column <em>col</em> in ascending order if <em>ascending</em> is TRUE +Sorts column <em>col</em> in ascending order if <em>ascending</em> is true (the default); otherwise sorts in descending order. <p> The <em>wholeRows</em> parameter is ignored; TQDataTable always sorts whole rows by the specified column. @@ -664,8 +664,8 @@ See the <a href="tqdatatable.html#trueText-prop">"trueText"</a> property for det For an editable table, issues an update using the cursor's edit buffer. If there is no current cursor or there is no current selection, nothing happens. If <a href="#confirmEdits">confirmEdits</a>() or <a href="#confirmUpdate">confirmUpdate</a>() -is TRUE, <a href="#confirmEdit">confirmEdit</a>() is called to confirm the update. Returns -TRUE if the update succeeded; otherwise returns FALSE. +is true, <a href="#confirmEdit">confirmEdit</a>() is called to confirm the update. Returns +true if the update succeeded; otherwise returns false. <p> The underlying cursor must have a valid primary index to ensure that a unique record is updated within the database otherwise the database may be changed to an inconsistent state. @@ -678,27 +678,27 @@ the cell does not exist or has no value. <hr><h2>Property Documentation</h2> <h3 class=fn>bool <a name="autoEdit-prop"></a>autoEdit</h3> <p>This property holds whether the data table 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 insert or update in the table there are two possible outcomes when they navigate to another record: <p> <ol type=1> -<li> the insert or update is is performed -- this occurs if autoEdit is TRUE -<li> the insert or update is abandoned -- 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 abandoned -- this occurs if autoEdit is false </ol> <p>Set this property's value with <a href="#setAutoEdit">setAutoEdit</a>() and get this property's value with <a href="#autoEdit">autoEdit</a>(). <h3 class=fn>bool <a name="confirmCancels-prop"></a>confirmCancels</h3> <p>This property holds whether the data table confirms cancel operations. -<p>If the confirmCancel property is TRUE, all cancels must be +<p>If the confirmCancel 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. +cancels 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 data table confirms delete operations. -<p>If the confirmDelete property is TRUE, all deletions must be +<p>If the confirmDelete property is true, all deletions must be confirmed by the user through a message box (this behaviour can be changed by overriding the <a href="#confirmEdit">confirmEdit</a>() function), otherwise all delete operations occur immediately. @@ -707,7 +707,7 @@ delete operations occur immediately. <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 data table confirms edit operations. -<p>If the confirmEdits property is TRUE, the data table confirms all +<p>If the confirmEdits property is true, the data table confirms all edit operations (inserts, updates and deletes). Finer control of edit confirmation can be achieved using <a href="#confirmCancels-prop">confirmCancels</a>, <a href="#confirmInsert-prop">confirmInsert</a>, <a href="#confirmUpdate-prop">confirmUpdate</a> and <a href="#confirmDelete-prop">confirmDelete</a>. <p> <p>See also <a href="#confirmCancels-prop">confirmCancels</a>, <a href="#confirmInsert-prop">confirmInsert</a>, <a href="#confirmUpdate-prop">confirmUpdate</a>, and <a href="#confirmDelete-prop">confirmDelete</a>. @@ -715,7 +715,7 @@ edit confirmation can be achieved using <a href="#confirmCancels-prop">confirmCa <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 table confirms insert operations. -<p>If the confirmInsert property is TRUE, all insertions must be +<p>If the confirmInsert property is true, all insertions must be confirmed by the user through a message box (this behaviour can be changed by overriding the <a href="#confirmEdit">confirmEdit</a>() function), otherwise all insert operations occur immediately. @@ -724,7 +724,7 @@ insert operations occur immediately. <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 data table confirms update operations. -<p>If the confirmUpdate property is TRUE, all updates must be +<p>If the confirmUpdate property is true, all updates must be confirmed by the user through a message box (this behaviour can be changed by overriding the <a href="#confirmEdit">confirmEdit</a>() function), otherwise all update operations occur immediately. |