summaryrefslogtreecommitdiffstats
path: root/doc/man/man3/tqdatatable.3qt
diff options
context:
space:
mode:
authorMichele Calgaro <michele.calgaro@yahoo.it>2025-07-26 11:44:58 +0900
committerMichele Calgaro <michele.calgaro@yahoo.it>2025-07-30 14:26:34 +0900
commit6dd781c483eea56f51ae0eff47d857976b5d0f0d (patch)
tree0ddd4408e142ae6f8b13d3538359abd127988b2f /doc/man/man3/tqdatatable.3qt
parentff56b6fec14de4cd4b89d5b322531671d200b6e0 (diff)
downloadtqt-6dd781c483eea56f51ae0eff47d857976b5d0f0d.tar.gz
tqt-6dd781c483eea56f51ae0eff47d857976b5d0f0d.zip
Replace TRUE/FALSE with boolean values true/false - part 3
Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it>
Diffstat (limited to 'doc/man/man3/tqdatatable.3qt')
-rw-r--r--doc/man/man3/tqdatatable.3qt64
1 files changed, 32 insertions, 32 deletions
diff --git a/doc/man/man3/tqdatatable.3qt b/doc/man/man3/tqdatatable.3qt
index 73cc7cd1b..52bae0acc 100644
--- a/doc/man/man3/tqdatatable.3qt
+++ b/doc/man/man3/tqdatatable.3qt
@@ -19,7 +19,7 @@ Inherits TQTable.
.BI "\fBTQDataTable\fR ( TQWidget * parent = 0, const char * name = 0 )"
.br
.ti -1c
-.BI "\fBTQDataTable\fR ( TQSqlCursor * cursor, bool autoPopulate = FALSE, TQWidget * parent = 0, const char * name = 0 )"
+.BI "\fBTQDataTable\fR ( TQSqlCursor * cursor, bool autoPopulate = false, TQWidget * parent = 0, const char * name = 0 )"
.br
.ti -1c
.BI "\fB~TQDataTable\fR ()"
@@ -73,7 +73,7 @@ Inherits TQTable.
.BI "TQStringList \fBsort\fR () const"
.br
.ti -1c
-.BI "virtual void \fBsetSqlCursor\fR ( TQSqlCursor * cursor = 0, bool autoPopulate = FALSE, bool autoDelete = FALSE )"
+.BI "virtual void \fBsetSqlCursor\fR ( TQSqlCursor * cursor = 0, bool autoPopulate = false, bool autoDelete = false )"
.br
.ti -1c
.BI "TQSqlCursor * \fBsqlCursor\fR () const"
@@ -127,7 +127,7 @@ Inherits TQTable.
.BI "void \fBrefresh\fR ( Refresh mode )"
.br
.ti -1c
-.BI "virtual void \fBsortColumn\fR ( int col, bool ascending = TRUE, bool wholeRows = FALSE )"
+.BI "virtual void \fBsortColumn\fR ( int col, bool ascending = true, bool wholeRows = false )"
.br
.ti -1c
.BI "virtual TQString \fBtext\fR ( int row, int col ) const"
@@ -297,7 +297,7 @@ When displaying data, TQDataTable only retrieves data for visible rows. If the d
.PP
TQDataTable inherits TQTable's API and extends it with functions to sort and filter the data and sort columns. See setSqlCursor(), setFilter(), setSort(), setSorting(), sortColumn() and refresh().
.PP
-When displaying editable cursors, cell editing will be enabled. (For more information on editable cursors, see TQSqlCursor). TQDataTable can be used to modify existing data and to add new records. When a user makes changes to a field in the table, the cursor's edit buffer is used. The table will not send changes in the edit buffer to the database until the user moves to a different record in the grid or presses Enter. Cell editing is 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 handleError() to change this behavior). Note that if autoEdit() is FALSE navigating to another record will cancel the insert or update.
+When displaying editable cursors, cell editing will be enabled. (For more information on editable cursors, see TQSqlCursor). TQDataTable can be used to modify existing data and to add new records. When a user makes changes to a field in the table, the cursor's edit buffer is used. The table will not send changes in the edit buffer to the database until the user moves to a different record in the grid or presses Enter. Cell editing is 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 handleError() to change this behavior). Note that if autoEdit() is false navigating to another record will cancel the insert or update.
.PP
The user can be asked to confirm all edits with setConfirmEdits(). For more precise control use setConfirmInsert(), setConfirmUpdate(), setConfirmDelete() and setConfirmCancels(). Use setAutoEdit() to control the behaviour of the table when the user edits a record and then navigates. (Note that setAutoDelete() is unrelated; it is used to set whether the TQSqlCursor is deleted when the table is deleted.)
.PP
@@ -313,7 +313,7 @@ Columns in the table can be created automatically based on the cursor (see setSq
.PP
The table automatically copies many of the properties of the cursor to format the display of data within cells (alignment, visibility, etc.). The cursor can be changed with setSqlCursor(). The filter (see setFilter()) and sort defined within the table are used instead of the filter and sort set on the cursor. For sorting options see setSort(), sortColumn(), sortAscending() and sortDescending(). Note that sorting operations will not behave as expected if you are using a TQSqlSelectCursor because it uses user-defined SQL queries to obtain data.
.PP
-The text used to represent NULL, TRUE and FALSE values can be changed with setNullText(), setTrueText() and setFalseText() respectively. You can change the appearance of cells by reimplementing paintField().
+The text used to represent NULL, true and false values can be changed with setNullText(), setTrueText() and setFalseText() respectively. You can change the appearance of cells by reimplementing paintField().
.PP
Whenever a new row is selected in the table the currentChanged() signal is emitted. The primeInsert() signal is emitted when an insert is initiated. The primeUpdate() and primeDelete() signals are emitted when update and deletion are initiated respectively. Just before the database is updated a signal is emitted; beforeInsert(), beforeUpdate() or beforeDelete() as appropriate.
.PP
@@ -330,10 +330,10 @@ This enum describes the refresh options.
.SH MEMBER FUNCTION DOCUMENTATION
.SH "TQDataTable::TQDataTable ( TQWidget * parent = 0, const char * name = 0 )"
Constructs a data table which is a child of \fIparent\fR, called name \fIname\fR.
-.SH "TQDataTable::TQDataTable ( TQSqlCursor * cursor, bool autoPopulate = FALSE, TQWidget * parent = 0, const char * name = 0 )"
+.SH "TQDataTable::TQDataTable ( TQSqlCursor * cursor, bool autoPopulate = false, TQWidget * parent = 0, const char * name = 0 )"
Constructs a data table which is a child of \fIparent\fR, called name \fIname\fR using the cursor \fIcursor\fR.
.PP
-If \fIautoPopulate\fR is TRUE (the default is FALSE), columns are automatically created based upon the fields in the \fIcursor\fR record. Note that \fIautoPopulate\fR only governs the creation of columns; to load the cursor's data into the table use refresh().
+If \fIautoPopulate\fR is true (the default is false), columns are automatically created based upon the fields in the \fIcursor\fR record. Note that \fIautoPopulate\fR only governs the creation of columns; to load the cursor's data into the table use refresh().
.PP
If the \fIcursor\fR is read-only, the table also becomes read-only. In addition, the table adopts the cursor's driver's definition for representing NULL values as strings.
.SH "TQDataTable::~TQDataTable ()"
@@ -352,9 +352,9 @@ Resizes column \fIcol\fR so that the column width is wide enough to display the
.PP
Reimplemented from TQTable.
.SH "bool TQDataTable::autoDelete () const"
-Returns TRUE if the table will automatically delete the cursor specified by setSqlCursor(); otherwise returns FALSE.
+Returns true if the table will automatically delete the cursor specified by setSqlCursor(); otherwise returns false.
.SH "bool TQDataTable::autoEdit () const"
-Returns TRUE if the data table automatically applies edits; otherwise returns FALSE. See the "autoEdit" property for details.
+Returns true if the data table automatically applies edits; otherwise returns false. See the "autoEdit" property for details.
.SH "void TQDataTable::beforeDelete ( TQSqlRecord * buf )\fC [signal]\fR"
This signal is emitted just before the currently selected record is deleted from the database. The \fIbuf\fR parameter points to the edit buffer being deleted. Connect to this signal to, for example, copy some of the fields for later use.
.SH "void TQDataTable::beforeInsert ( TQSqlRecord * buf )\fC [signal]\fR"
@@ -378,17 +378,17 @@ Editing takes place using the cursor's edit buffer (see TQSqlCursor::editBuffer(
.SH "TQSql::Confirm TQDataTable::confirmCancel ( TQSql::Op m )\fC [virtual protected]\fR"
Protected virtual function which returns a confirmation for cancelling an edit mode of \fIm\fR. Derived classes can reimplement this function to provide their own cancel dialog. The default implementation uses a message box which prompts the user to confirm the cancel.
.SH "bool TQDataTable::confirmCancels () const"
-Returns TRUE if the data table confirms cancel operations; otherwise returns FALSE. See the "confirmCancels" property for details.
+Returns true if the data table confirms cancel operations; otherwise returns false. See the "confirmCancels" property for details.
.SH "bool TQDataTable::confirmDelete () const"
-Returns TRUE if the data table confirms delete operations; otherwise returns FALSE. See the "confirmDelete" property for details.
+Returns true if the data table confirms delete operations; otherwise returns false. See the "confirmDelete" property for details.
.SH "TQSql::Confirm TQDataTable::confirmEdit ( TQSql::Op m )\fC [virtual protected]\fR"
Protected virtual function which returns a confirmation for an edit of mode \fIm\fR. Derived classes can reimplement this function to provide their own confirmation dialog. The default implementation uses a message box which prompts the user to confirm the edit action.
.SH "bool TQDataTable::confirmEdits () const"
-Returns TRUE if the data table confirms edit operations; otherwise returns FALSE. See the "confirmEdits" property for details.
+Returns true if the data table confirms edit operations; otherwise returns false. See the "confirmEdits" property for details.
.SH "bool TQDataTable::confirmInsert () const"
-Returns TRUE if the data table confirms insert operations; otherwise returns FALSE. See the "confirmInsert" property for details.
+Returns true if the data table confirms insert operations; otherwise returns false. See the "confirmInsert" property for details.
.SH "bool TQDataTable::confirmUpdate () const"
-Returns TRUE if the data table confirms update operations; otherwise returns FALSE. See the "confirmUpdate" property for details.
+Returns true if the data table confirms update operations; otherwise returns false. See the "confirmUpdate" property for details.
.SH "void TQDataTable::currentChanged ( TQSqlRecord * record )\fC [signal]\fR"
This signal is emitted whenever a new row is selected in the table. The \fIrecord\fR parameter points to the contents of the newly selected record.
.SH "TQSqlRecord * TQDataTable::currentRecord () const"
@@ -398,7 +398,7 @@ This signal is emitted whenever the cursor record was changed due to an edit. Th
.SH "DateFormat TQDataTable::dateFormat () const"
Returns the format used for displaying date/time values. See the "dateFormat" property for details.
.SH "bool TQDataTable::deleteCurrent ()\fC [virtual protected]\fR"
-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 confirmEdits() or confirmDelete() is TRUE, confirmEdit() is called to confirm the delete. Returns TRUE if the delete succeeded; otherwise FALSE.
+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 confirmEdits() or confirmDelete() is true, confirmEdit() is called to confirm the delete. Returns true if the delete succeeded; otherwise false.
.PP
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.
.SH "TQString TQDataTable::falseText () const"
@@ -408,15 +408,15 @@ Returns the alignment for \fIfield\fR.
.SH "TQString TQDataTable::filter () const"
Returns the data filter for the data table. See the "filter" property for details.
.SH "void TQDataTable::find ( const TQString & str, bool caseSensitive, bool backwards )\fC [virtual slot]\fR"
-Searches the current cursor for a cell containing the string \fIstr\fR starting at the current cell and working forwards (or backwards if \fIbackwards\fR is TRUE). If the string is found, the cell containing the string is set as the current cell. If \fIcaseSensitive\fR is FALSE the case of \fIstr\fR will be ignored.
+Searches the current cursor for a cell containing the string \fIstr\fR starting at the current cell and working forwards (or backwards if \fIbackwards\fR is true). If the string is found, the cell containing the string is set as the current cell. If \fIcaseSensitive\fR is false the case of \fIstr\fR will be ignored.
.PP
-The search will wrap, i.e. if the first (or if backwards is TRUE, last) cell is reached without finding \fIstr\fR the search will continue until it reaches the starting cell. If \fIstr\fR is not found the search will fail and the current cell will remain unchanged.
+The search will wrap, i.e. if the first (or if backwards is true, last) cell is reached without finding \fIstr\fR the search will continue until it reaches the starting cell. If \fIstr\fR is not found the search will fail and the current cell will remain unchanged.
.SH "void TQDataTable::handleError ( const TQSqlError & e )\fC [virtual protected]\fR"
Protected virtual function which is called when an error \fIe\fR has occurred on the current cursor(). The default implementation displays a warning message to the user with information about the error.
.SH "int TQDataTable::indexOf ( uint i ) const\fC [protected]\fR"
Returns the index of the field within the current SQL query that is displayed in column \fIi\fR.
.SH "bool TQDataTable::insertCurrent ()\fC [virtual protected]\fR"
-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 confirmEdits() or confirmInsert() is TRUE, confirmEdit() is called to confirm the insert. Returns TRUE if the insert succeeded; otherwise returns FALSE.
+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 confirmEdits() or confirmInsert() is true, confirmEdit() is called to confirm the insert. Returns true if the insert succeeded; otherwise returns false.
.PP
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.
.SH "void TQDataTable::installEditorFactory ( TQSqlEditorFactory * f )"
@@ -469,7 +469,7 @@ Resets the table so that it displays no data.
.PP
See also setSqlCursor().
.SH "void TQDataTable::setAutoDelete ( bool enable )\fC [virtual]\fR"
-Sets the cursor auto-delete flag to \fIenable\fR. If \fIenable\fR is TRUE, the table will automatically delete the cursor specified by setSqlCursor(). If \fIenable\fR is FALSE (the default), the cursor will not be deleted.
+Sets the cursor auto-delete flag to \fIenable\fR. If \fIenable\fR is true, the table will automatically delete the cursor specified by setSqlCursor(). If \fIenable\fR is false (the default), the cursor will not be deleted.
.SH "void TQDataTable::setAutoEdit ( bool autoEdit )\fC [virtual]\fR"
Sets whether the data table automatically applies edits to \fIautoEdit\fR. See the "autoEdit" property for details.
.SH "void TQDataTable::setColumn ( uint col, const TQString & fieldName, const TQString & label = TQString::null, int width = -1, const TQIconSet & iconset = TQIconSet ( ) )\fC [virtual]\fR"
@@ -512,8 +512,8 @@ This is an overloaded member function, provided for convenience. It behaves esse
Sets the sort to be applied to the displayed data to \fIsort\fR. If there is no current cursor, nothing happens. A TQSqlIndex contains field names and their ordering (ASC or DESC); these are used to compose the ORDER BY clause.
.PP
See also sort.
-.SH "void TQDataTable::setSqlCursor ( TQSqlCursor * cursor = 0, bool autoPopulate = FALSE, bool autoDelete = FALSE )\fC [virtual]\fR"
-Sets \fIcursor\fR as the data source for the table. To force the display of the data from \fIcursor\fR, use refresh(). If \fIautoPopulate\fR is TRUE, columns are automatically created based upon the fields in the \fIcursor\fR record. If \fIautoDelete\fR is TRUE (the default is FALSE), the table will take ownership of the \fIcursor\fR and delete it when appropriate. If the \fIcursor\fR is read-only, the table becomes read-only. The table adopts the cursor's driver's definition for representing NULL values as strings.
+.SH "void TQDataTable::setSqlCursor ( TQSqlCursor * cursor = 0, bool autoPopulate = false, bool autoDelete = false )\fC [virtual]\fR"
+Sets \fIcursor\fR as the data source for the table. To force the display of the data from \fIcursor\fR, use refresh(). If \fIautoPopulate\fR is true, columns are automatically created based upon the fields in the \fIcursor\fR record. If \fIautoDelete\fR is true (the default is false), the table will take ownership of the \fIcursor\fR and delete it when appropriate. If the \fIcursor\fR is read-only, the table becomes read-only. The table adopts the cursor's driver's definition for representing NULL values as strings.
.PP
See also refresh(), readOnly, setAutoDelete(), and TQSqlDriver::nullText().
.SH "void TQDataTable::setTrueText ( const TQString & trueText )\fC [virtual]\fR"
@@ -524,8 +524,8 @@ Returns the data table's sort. See the "sort" property for details.
Sorts column \fIcol\fR in ascending order.
.PP
See also sorting.
-.SH "void TQDataTable::sortColumn ( int col, bool ascending = TRUE, bool wholeRows = FALSE )\fC [virtual]\fR"
-Sorts column \fIcol\fR in ascending order if \fIascending\fR is TRUE (the default); otherwise sorts in descending order.
+.SH "void TQDataTable::sortColumn ( int col, bool ascending = true, bool wholeRows = false )\fC [virtual]\fR"
+Sorts column \fIcol\fR in ascending order if \fIascending\fR is true (the default); otherwise sorts in descending order.
.PP
The \fIwholeRows\fR parameter is ignored; TQDataTable always sorts whole rows by the specified column.
.PP
@@ -543,7 +543,7 @@ Reimplemented from TQTable.
.SH "TQString TQDataTable::trueText () const"
Returns the text used to represent true values. See the "trueText" property for details.
.SH "bool TQDataTable::updateCurrent ()\fC [virtual protected]\fR"
-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 confirmEdits() or confirmUpdate() is TRUE, confirmEdit() is called to confirm the update. Returns TRUE if the update succeeded; otherwise returns FALSE.
+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 confirmEdits() or confirmUpdate() is true, confirmEdit() is called to confirm the update. Returns true if the update succeeded; otherwise returns false.
.PP
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.
.SH "TQVariant TQDataTable::value ( int row, int col ) const"
@@ -552,19 +552,19 @@ Returns the value in cell \fIrow\fR, \fIcol\fR, or an invalid value if the cell
.SH "bool autoEdit"
This property holds whether the data table automatically applies edits.
.PP
-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:
+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:
.PP
<ol type=1>
.TP
-the insert or update is is performed -- this occurs if autoEdit is TRUE
+the insert or update is is performed -- this occurs if autoEdit is true
.TP
-the insert or update is abandoned -- this occurs if autoEdit is FALSE
+the insert or update is abandoned -- this occurs if autoEdit is false
.PP
Set this property's value with setAutoEdit() and get this property's value with autoEdit().
.SH "bool confirmCancels"
This property holds whether the data table confirms cancel operations.
.PP
-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 confirmCancel() function), otherwise all cancels occur immediately. The default is FALSE.
+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 confirmCancel() function), otherwise all cancels occur immediately. The default is false.
.PP
See also confirmEdits and confirmCancel().
.PP
@@ -572,7 +572,7 @@ Set this property's value with setConfirmCancels() and get this property's value
.SH "bool confirmDelete"
This property holds whether the data table confirms delete operations.
.PP
-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 confirmEdit() function), otherwise all delete operations occur immediately.
+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 confirmEdit() function), otherwise all delete operations occur immediately.
.PP
See also confirmCancels, confirmEdits, confirmUpdate, and confirmInsert.
.PP
@@ -580,7 +580,7 @@ Set this property's value with setConfirmDelete() and get this property's value
.SH "bool confirmEdits"
This property holds whether the data table confirms edit operations.
.PP
-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 confirmCancels, confirmInsert, confirmUpdate and confirmDelete.
+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 confirmCancels, confirmInsert, confirmUpdate and confirmDelete.
.PP
See also confirmCancels, confirmInsert, confirmUpdate, and confirmDelete.
.PP
@@ -588,7 +588,7 @@ Set this property's value with setConfirmEdits() and get this property's value w
.SH "bool confirmInsert"
This property holds whether the data table confirms insert operations.
.PP
-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 confirmEdit() function), otherwise all insert operations occur immediately.
+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 confirmEdit() function), otherwise all insert operations occur immediately.
.PP
See also confirmCancels, confirmEdits, confirmUpdate, and confirmDelete.
.PP
@@ -596,7 +596,7 @@ Set this property's value with setConfirmInsert() and get this property's value
.SH "bool confirmUpdate"
This property holds whether the data table confirms update operations.
.PP
-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 confirmEdit() function), otherwise all update operations occur immediately.
+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 confirmEdit() function), otherwise all update operations occur immediately.
.PP
See also confirmCancels, confirmEdits, confirmInsert, and confirmDelete.
.PP