diff options
Diffstat (limited to 'doc/man/man3/tqdatabrowser.3qt')
| -rw-r--r-- | doc/man/man3/tqdatabrowser.3qt | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/doc/man/man3/tqdatabrowser.3qt b/doc/man/man3/tqdatabrowser.3qt index d3a8d11d0..3bc586809 100644 --- a/doc/man/man3/tqdatabrowser.3qt +++ b/doc/man/man3/tqdatabrowser.3qt @@ -49,7 +49,7 @@ Inherits TQWidget. .BI "TQString \fBfilter\fR () const" .br .ti -1c -.BI "virtual void \fBsetSqlCursor\fR ( TQSqlCursor * cursor, bool autoDelete = FALSE )" +.BI "virtual void \fBsetSqlCursor\fR ( TQSqlCursor * cursor, bool autoDelete = false )" .br .ti -1c .BI "TQSqlCursor * \fBsqlCursor\fR () const" @@ -103,7 +103,7 @@ Inherits TQWidget. .BI "bool \fBautoEdit\fR () const" .br .ti -1c -.BI "virtual bool \fBseek\fR ( int i, bool relative = FALSE )" +.BI "virtual bool \fBseek\fR ( int i, bool relative = false )" .br .in -1c .SS "Public Slots" @@ -288,7 +288,7 @@ Constructs a data browser which is a child of \fIparent\fR, with the name \fInam .SH "TQDataBrowser::~TQDataBrowser ()" Destroys the object and frees any allocated resources. .SH "bool TQDataBrowser::autoEdit () const" -Returns TRUE if the browser automatically applies edits; otherwise returns FALSE. See the "autoEdit" property for details. +Returns true if the browser automatically applies edits; otherwise returns false. See the "autoEdit" property for details. .SH "void TQDataBrowser::beforeDelete ( TQSqlRecord * buf )\fC [signal]\fR" This signal is emitted just before the cursor's edit buffer is deleted from the database. The \fIbuf\fR parameter points to the edit buffer being deleted. You might connect to this signal to capture some auditing information about the deletion. .SH "void TQDataBrowser::beforeInsert ( TQSqlRecord * buf )\fC [signal]\fR" @@ -302,7 +302,7 @@ This is achieved by moving the default cursor and checking the position, however .PP See also Boundary. .SH "bool TQDataBrowser::boundaryChecking () const" -Returns TRUE if boundary checking is active; otherwise returns FALSE. See the "boundaryChecking" property for details. +Returns true if boundary checking is active; otherwise returns false. See the "boundaryChecking" property for details. .SH "void TQDataBrowser::clearValues ()\fC [virtual slot]\fR" Clears all the values in the form. .PP @@ -310,21 +310,21 @@ All the edit buffer field values are set to their 'zero state', e.g. 0 for numer .SH "TQSql::Confirm TQDataBrowser::confirmCancel ( TQSql::Op m )\fC [virtual protected]\fR" Protected virtual function which returns a confirmation for cancelling an edit mode \fIm\fR. 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. .SH "bool TQDataBrowser::confirmCancels () const" -Returns TRUE if the browser confirms cancel operations; otherwise returns FALSE. See the "confirmCancels" property for details. +Returns true if the browser confirms cancel operations; otherwise returns false. See the "confirmCancels" property for details. .SH "bool TQDataBrowser::confirmDelete () const" -Returns TRUE if the browser confirms deletions; otherwise returns FALSE. See the "confirmDelete" property for details. +Returns true if the browser confirms deletions; otherwise returns false. See the "confirmDelete" property for details. .SH "TQSql::Confirm TQDataBrowser::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 and provide their own confirmation dialog. The default implementation uses a message box which prompts the user to confirm the edit action. .SH "bool TQDataBrowser::confirmEdits () const" -Returns TRUE if the browser confirms edits; otherwise returns FALSE. See the "confirmEdits" property for details. +Returns true if the browser confirms edits; otherwise returns false. See the "confirmEdits" property for details. .SH "bool TQDataBrowser::confirmInsert () const" -Returns TRUE if the data browser confirms insertions; otherwise returns FALSE. See the "confirmInsert" property for details. +Returns true if the data browser confirms insertions; otherwise returns false. See the "confirmInsert" property for details. .SH "bool TQDataBrowser::confirmUpdate () const" -Returns TRUE if the browser confirms updates; otherwise returns FALSE. See the "confirmUpdate" property for details. +Returns true if the browser confirms updates; otherwise returns false. See the "confirmUpdate" property for details. .SH "void TQDataBrowser::currentChanged ( const TQSqlRecord * record )\fC [signal]\fR" This signal is emitted whenever the current cursor position changes. The \fIrecord\fR parameter points to the contents of the current cursor's record. .SH "bool TQDataBrowser::currentEdited ()\fC [virtual protected]\fR" -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. .SH "void TQDataBrowser::cursorChanged ( TQSqlCursor::Mode mode )\fC [signal]\fR" This signal is emitted whenever the cursor record was changed due to navigation. The \fImode\fR parameter is the edit that just took place, e.g. Insert, Update or Delete. See TQSqlCursor::Mode. .SH "void TQDataBrowser::del ()\fC [virtual slot]\fR" @@ -334,7 +334,7 @@ Otherwise, the following happens: .PP 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 insert()), the insert action is canceled, and the browser navigates to the last valid record that was current. If there is an error, handleError() is called. .SH "bool TQDataBrowser::deleteCurrent ()\fC [virtual protected]\fR" -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, handleError() is called and FALSE is returned. +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, handleError() is called and false is returned. .PP See also cursor, form(), and handleError(). .SH "TQString TQDataBrowser::filter () const" @@ -368,11 +368,11 @@ The primeInsert() signal is emitted. .TP 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. .SH "bool TQDataBrowser::insertCurrent ()\fC [virtual protected]\fR" -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, handleError() is called and FALSE is returned. If the insert was successfull, the cursor is refreshed and relocated to the newly inserted record, the cursorChanged() signal is emitted, and TRUE is returned. +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, handleError() is called and false is returned. If the insert was successfull, the cursor is refreshed and relocated to the newly inserted record, the cursorChanged() signal is emitted, and true is returned. .PP See also cursorChanged(), sqlCursor(), form(), and handleError(). .SH "bool TQDataBrowser::isReadOnly () const" -Returns TRUE if the browser is read-only; otherwise returns FALSE. See the "readOnly" property for details. +Returns true if the browser is read-only; otherwise returns false. See the "readOnly" property for details. .SH "void TQDataBrowser::last ()\fC [virtual slot]\fR" 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 primeUpdate() signal is emitted. .PP @@ -409,8 +409,8 @@ Reads the fields from the default cursor's edit buffer and displays them in the Refreshes the data browser's data using the default cursor. The browser's current filter and sort are applied if they have been set. .PP See also filter and sort. -.SH "bool TQDataBrowser::seek ( int i, bool relative = FALSE )\fC [virtual]\fR" -Moves the default cursor to the record specified by the index \fIi\fR and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If \fIrelative\fR 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 primeUpdate() signal is emitted. +.SH "bool TQDataBrowser::seek ( int i, bool relative = false )\fC [virtual]\fR" +Moves the default cursor to the record specified by the index \fIi\fR and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If \fIrelative\fR 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 primeUpdate() signal is emitted. .PP If the browser is already positioned on the desired record nothing happens. .SH "void TQDataBrowser::setAutoEdit ( bool autoEdit )\fC [virtual]\fR" @@ -439,8 +439,8 @@ Sets the data browser's sort to \fIsort\fR. See the "sort" property for details. This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Sets the data browser's sort to the TQSqlIndex \fIsort\fR. To apply the new sort, use refresh(). -.SH "void TQDataBrowser::setSqlCursor ( TQSqlCursor * cursor, bool autoDelete = FALSE )\fC [virtual]\fR" -Sets the default cursor used by the data browser to \fIcursor\fR. If \fIautoDelete\fR is TRUE (the default is FALSE), the data browser takes ownership of the \fIcursor\fR pointer, which will be deleted when the browser is destroyed, or when setSqlCursor() is called again. To activate the \fIcursor\fR use refresh(). The cursor's edit buffer is used in the default form to browse and edit records. +.SH "void TQDataBrowser::setSqlCursor ( TQSqlCursor * cursor, bool autoDelete = false )\fC [virtual]\fR" +Sets the default cursor used by the data browser to \fIcursor\fR. If \fIautoDelete\fR is true (the default is false), the data browser takes ownership of the \fIcursor\fR pointer, which will be deleted when the browser is destroyed, or when setSqlCursor() is called again. To activate the \fIcursor\fR use refresh(). The cursor's edit buffer is used in the default form to browse and edit records. .PP See also sqlCursor(), form(), and setForm(). .SH "TQStringList TQDataBrowser::sort () const" @@ -456,9 +456,9 @@ If there is no default cursor or no default form, nothing happens. Otherwise, th .PP If the data browser is actively inserting a record (see insert()), that record is inserted into the database using insertCurrent(). Otherwise, the database is updated with the current form's data using updateCurrent(). If there is an error handling either action, handleError() is called. .SH "void TQDataBrowser::updateBoundary ()\fC [slot]\fR" -If boundaryChecking() is TRUE, checks the boundary of the current default cursor and emits signals which indicate the position of the cursor. +If boundaryChecking() is true, checks the boundary of the current default cursor and emits signals which indicate the position of the cursor. .SH "bool TQDataBrowser::updateCurrent ()\fC [virtual protected]\fR" -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, handleError() is called and FALSE is returned. If the update was successfull, the cursor is refreshed and relocated to the updated record, the cursorChanged() signal is emitted, and TRUE is returned. +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, handleError() is called and false is returned. If the update was successfull, the cursor is refreshed and relocated to the updated record, the cursorChanged() signal is emitted, and true is returned. .PP See also cursor, form(), and handleError(). .SH "void TQDataBrowser::writeFields ()\fC [virtual slot]\fR" @@ -467,11 +467,11 @@ Writes the form's data to the default cursor's edit buffer. If there is no defau .SH "bool autoEdit" This property holds whether the browser automatically applies edits. .PP -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: +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: .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 discarded -- this occurs if autoEdit is FALSE +the insert or update is discarded -- this occurs if autoEdit is false .PP Set this property's value with setAutoEdit() and get this property's value with autoEdit(). .SH "bool boundaryChecking" @@ -485,7 +485,7 @@ Set this property's value with setBoundaryChecking() and get this property's val .SH "bool confirmCancels" This property holds whether the browser confirms cancel operations. .PP -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 confirmCancel() function), otherwise all cancels occur immediately. The default is FALSE. +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 confirmCancel() function), otherwise all cancels occur immediately. The default is false. .PP See also confirmEdits and confirmCancel(). .PP @@ -493,7 +493,7 @@ Set this property's value with setConfirmCancels() and get this property's value .SH "bool confirmDelete" This property holds whether the browser confirms deletions. .PP -If this property is TRUE, the browser confirms deletions, otherwise deletions happen immediately. +If this property is true, the browser confirms deletions, otherwise deletions happen immediately. .PP See also confirmCancels, confirmEdits, confirmUpdate, confirmInsert, and confirmEdit(). .PP @@ -501,7 +501,7 @@ Set this property's value with setConfirmDelete() and get this property's value .SH "bool confirmEdits" This property holds whether the browser confirms edits. .PP -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 confirmEdit() function, +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 confirmEdit() function, .PP See also confirmEdit(), confirmCancels, confirmInsert, confirmUpdate, and confirmDelete. .PP @@ -509,7 +509,7 @@ Set this property's value with setConfirmEdits() and get this property's value w .SH "bool confirmInsert" This property holds whether the data browser confirms insertions. .PP -If this property is TRUE, the browser confirms insertions, otherwise insertions happen immediately. +If this property is true, the browser confirms insertions, otherwise insertions happen immediately. .PP See also confirmCancels, confirmEdits, confirmUpdate, confirmDelete, and confirmEdit(). .PP @@ -517,7 +517,7 @@ Set this property's value with setConfirmInsert() and get this property's value .SH "bool confirmUpdate" This property holds whether the browser confirms updates. .PP -If this property is TRUE, the browser confirms updates, otherwise updates happen immediately. +If this property is true, the browser confirms updates, otherwise updates happen immediately. .PP See also confirmCancels, confirmEdits, confirmInsert, confirmDelete, and confirmEdit(). .PP @@ -535,7 +535,7 @@ Set this property's value with setFilter() and get this property's value with fi .SH "bool readOnly" This property holds whether the browser is read-only. .PP -The default is FALSE, i.e. data can be edited. If the data browser is read-only, no database edits will be allowed. +The default is false, i.e. data can be edited. If the data browser is read-only, no database edits will be allowed. .PP Set this property's value with setReadOnly() and get this property's value with isReadOnly(). .SH "TQStringList sort" |