Q3DataBrowser Class Reference

#include <q3databrowser.h>

Inheritance diagram for Q3DataBrowser:

[legend]Collaboration diagram for Q3DataBrowser:

[legend]List of all members.

---

Detailed Description

The Q3DataBrowser class provides data manipulation and navigation for data entry forms.

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.

If you want a read-only form to present database data use Q3DataView; if you want a table-based presentation of your data use Q3DataTable.

A Q3DataBrowser is used to associate a dataset with a form in much the same way as a Q3DataTable associates a dataset with a table. Once the data browser has been constructed it can be associated with a dataset with setSqlCursor(), and with a form with setForm(). Boundary checking, sorting and filtering can be set with setBoundaryChecking(), setSort() and setFilter(), respectively.

The insertCurrent() function reads the fields from the default form into the default cursor and performs the insert. The updateCurrent() and deleteCurrent() functions perform similarly to update and delete the current record respectively.

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 behavior of the form when the user edits a record and then navigates.

The record set is navigated using first(), next(), prev(), last() and seek(). The form's display is updated with refresh(). When navigation takes place the firstRecordAvailable(), lastRecordAvailable(), nextRecordAvailable() and prevRecordAvailable() signals are emitted. When the cursor record is changed due to navigation the cursorChanged() signal is emitted.

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.

The form is populated with data from the database with readFields(). If the user is allowed to edit, (see setReadOnly()), write the form's data back to the cursor's edit buffer with writeFields(). You can clear the values in the form with clearValues(). Editing is performed as follows: insert When the data browser enters insertion mode it emits the primeInsert() signal which you can connect to, for example to pre-populate fields. Call writeFields() to write the user's edits to the cursor's edit buffer then call insert() to insert the record into the database. The beforeInsert() 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. update For updates the primeUpdate() signal is emitted when the data browser enters update mode. After calling writeFields() call update() to update the record and connect to the beforeUpdate() signal to manipulate the user's data before the update takes place. delete For deletion the primeDelete() signal is emitted when the data browser enters deletion mode. After calling writeFields() call del() to delete the record and connect to the beforeDelete() signal, for example to record an audit of the deleted record.

Definition at line 44 of file q3databrowser.h.

Public Types
enum	Boundary
Public Slots
virtual void	refresh ()
virtual void	insert ()
virtual void	update ()
virtual void	del ()
virtual void	first ()
virtual void	last ()
virtual void	next ()
virtual void	prev ()
virtual void	readFields ()
virtual void	writeFields ()
virtual void	clearValues ()
void	updateBoundary ()
Signals
void	firstRecordAvailable (bool available)
void	lastRecordAvailable (bool available)
void	nextRecordAvailable (bool available)
void	prevRecordAvailable (bool available)
void	currentChanged (const QSqlRecord *record)
void	primeInsert (QSqlRecord *buf)
void	primeUpdate (QSqlRecord *buf)
void	primeDelete (QSqlRecord *buf)
void	beforeInsert (QSqlRecord *buf)
void	beforeUpdate (QSqlRecord *buf)
void	beforeDelete (QSqlRecord *buf)
void	cursorChanged (Q3SqlCursor::Mode mode)
Public Member Functions
	Q3DataBrowser (QWidget *parent=0, const char *name=0, Qt::WindowFlags fl=0)
	~Q3DataBrowser ()
Boundary	boundary ()
void	setBoundaryChecking (bool active)
bool	boundaryChecking () const
void	setSort (const QSqlIndex &sort)
void	setSort (const QStringList &sort)
QStringList	sort () const
void	setFilter (const QString &filter)
QString	filter () const
virtual void	setSqlCursor (Q3SqlCursor *cursor, bool autoDelete=false)
Q3SqlCursor *	sqlCursor () const
virtual void	setForm (Q3SqlForm *form)
Q3SqlForm *	form ()
virtual void	setConfirmEdits (bool confirm)
virtual void	setConfirmInsert (bool confirm)
virtual void	setConfirmUpdate (bool confirm)
virtual void	setConfirmDelete (bool confirm)
virtual void	setConfirmCancels (bool confirm)
bool	confirmEdits () const
bool	confirmInsert () const
bool	confirmUpdate () const
bool	confirmDelete () const
bool	confirmCancels () const
virtual void	setReadOnly (bool active)
bool	isReadOnly () const
virtual void	setAutoEdit (bool autoEdit)
bool	autoEdit () const
virtual bool	seek (int i, bool relative=false)
Protected Member Functions
virtual bool	insertCurrent ()
virtual bool	updateCurrent ()
virtual bool	deleteCurrent ()
virtual bool	currentEdited ()
virtual QSql::Confirm	confirmEdit (QSql::Op m)
virtual QSql::Confirm	confirmCancel (QSql::Op m)
virtual void	handleError (const QSqlError &error)
Private Types
typedef bool(Q3SqlCursor::*)	Nav ()
Private Member Functions
bool	preNav ()
void	postNav (bool primeUpd)
void	nav (Nav nav)
Private Attributes
Q3DataBrowserPrivate *	d

---

Member Typedef Documentation

typedef bool(Q3SqlCursor::*) Q3DataBrowser::Nav() [private]

Definition at line 148 of file q3databrowser.h.

---

Member Enumeration Documentation

enum Q3DataBrowser::Boundary

This enum describes where the data browser is positioned.

Unknown the boundary cannot be determined (usually because there is no default cursor, or the default cursor is not active).

None the browser is not positioned on a boundary, but it is positioned on a record somewhere in the middle.

BeforeBeginning the browser is positioned before the first available record.

Beginning the browser is positioned at the first record.

End the browser is positioned at the last record.

AfterEnd the browser is positioned after the last available record.

Definition at line 62 of file q3databrowser.h.

                  {
        Unknown,
        None,
        BeforeBeginning,
        Beginning,
        End,
        AfterEnd
    };

---

Constructor & Destructor Documentation

Q3DataBrowser::Q3DataBrowser	(	QWidget *	parent = 0,
		const char *	name = 0,
		Qt::WindowFlags	fl = 0
	)

Constructs a data browser which is a child of parent, with the name name and widget flags set to fl.

Definition at line 143 of file q3databrowser.cpp.

References d, Q3DataBrowserPrivate::dat, and Q3DataManager::setMode().

    : QWidget(parent, name, fl)
{
    d = new Q3DataBrowserPrivate();
    d->dat.setMode(QSql::Update);
}

Here is the call graph for this function:

Q3DataBrowser::~Q3DataBrowser

(

)

Destroys the object and frees any allocated resources.

Definition at line 154 of file q3databrowser.cpp.

References d.

{
    delete d;
}

---

Member Function Documentation

Q3DataBrowser::Boundary Q3DataBrowser::boundary

(

)

Returns an enum indicating the boundary status of the browser.

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 Q3DataBrowser::Boundary.

See also:

Boundary

Definition at line 171 of file q3databrowser.cpp.

References AfterEnd, QSqlQuery::at(), b, BeforeBeginning, Beginning, Q3DataBrowserPrivate::cur, Q3SqlCursorManager::cursor(), d, End, QSqlQuery::isActive(), QSqlQuery::isValid(), Q3SqlCursor::next(), None, Q3SqlCursor::previous(), Q3SqlCursor::seek(), and Unknown.

Referenced by updateBoundary().

{
    Q3SqlCursor* cur = d->cur.cursor();
    if (!cur || !cur->isActive())
        return Unknown;
    if (!cur->isValid()) {
        if (cur->at() == QSql::BeforeFirst)
            return BeforeBeginning;
        if (cur->at() == QSql::AfterLast)
            return AfterEnd;
        return Unknown;
    }
    if (cur->at() == 0)
        return Beginning;
    int currentAt = cur->at();

    Boundary b = None;
    if (!cur->previous())
        b = Beginning;
    else
        cur->seek(currentAt);
    if (b == None && !cur->next())
        b = End;
    cur->seek(currentAt);
    return b;
}

Here is the call graph for this function:

void Q3DataBrowser::setBoundaryChecking

(

bool

active

)

Definition at line 209 of file q3databrowser.cpp.

References Q3DataBrowserPrivate::boundaryCheck, and d.

{
    d->boundaryCheck = active;
}

bool Q3DataBrowser::boundaryChecking

(

)

const

Definition at line 214 of file q3databrowser.cpp.

References Q3DataBrowserPrivate::boundaryCheck, and d.

{
    return d->boundaryCheck;
}

void Q3DataBrowser::setSort

(

const QSqlIndex &

sort

)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets the data browser's sort to the QSqlIndex sort. To apply the new sort, use refresh().

Definition at line 255 of file q3databrowser.cpp.

References Q3DataBrowserPrivate::cur, d, Q3SqlCursorManager::setSort(), and sort().

{
    d->cur.setSort(sort);
}

Here is the call graph for this function:

void Q3DataBrowser::setSort

(

const QStringList &

sort

)

Definition at line 243 of file q3databrowser.cpp.

References Q3DataBrowserPrivate::cur, d, Q3SqlCursorManager::setSort(), and sort().

{
    d->cur.setSort(sort);
}

Here is the call graph for this function:

QStringList Q3DataBrowser::sort

(

)

const

Definition at line 260 of file q3databrowser.cpp.

References Q3DataBrowserPrivate::cur, d, and Q3SqlCursorManager::sort().

Referenced by setSort().

{
    return d->cur.sort();
}

Here is the call graph for this function:

void Q3DataBrowser::setFilter

(

const QString &

filter

)

Definition at line 280 of file q3databrowser.cpp.

References Q3DataBrowserPrivate::cur, d, filter(), and Q3SqlCursorManager::setFilter().

{
    d->cur.setFilter(filter);
}

Here is the call graph for this function:

QString Q3DataBrowser::filter

(

)

const

Definition at line 286 of file q3databrowser.cpp.

References Q3DataBrowserPrivate::cur, d, and Q3SqlCursorManager::filter().

Referenced by setFilter().

{
    return d->cur.filter();
}

Here is the call graph for this function:

void Q3DataBrowser::setSqlCursor	(	Q3SqlCursor *	cursor,
		bool	autoDelete = false
	)			[virtual]

Sets the default cursor used by the data browser to cursor. If autoDelete is true (the default is false), the data browser takes ownership of the cursor pointer, which will be deleted when the browser is destroyed, or when setSqlCursor() is called again. To activate the cursor use refresh(). The cursor's edit buffer is used in the default form to browse and edit records.

See also:

sqlCursor() form() setForm()

Definition at line 303 of file q3databrowser.cpp.

References Q3DataBrowserPrivate::cur, QWidget::cursor(), d, Q3DataBrowserPrivate::frm, Q3SqlCursorManager::setCursor(), setReadOnly(), and Q3SqlFormManager::setRecord().

{
    if (!cursor)
        return;
    d->cur.setCursor(cursor, autoDelete);
    d->frm.setRecord(cursor->editBuffer());
    if (cursor->isReadOnly())
        setReadOnly(true);
}

Here is the call graph for this function:

Q3SqlCursor * Q3DataBrowser::sqlCursor

(

)

const

Returns the default cursor used for navigation, or 0 if there is no default cursor.

See also:

setSqlCursor()

Definition at line 321 of file q3databrowser.cpp.

References Q3DataBrowserPrivate::cur, Q3SqlCursorManager::cursor(), and d.

Referenced by insert().

{
    return d->cur.cursor();
}

Here is the call graph for this function:

void Q3DataBrowser::setForm

(

Q3SqlForm *

form

)

[virtual]

Sets the browser's default form to form. The cursor and all navigation and data manipulation functions that the browser provides become available to the form.

Definition at line 333 of file q3databrowser.cpp.

References d, form(), Q3DataBrowserPrivate::frm, and Q3SqlFormManager::setForm().

{
    d->frm.setForm(form);
}

Here is the call graph for this function:

Q3SqlForm * Q3DataBrowser::form

(

)

Returns the data browser's default form or 0 if no form has been set.

Definition at line 344 of file q3databrowser.cpp.

References d, Q3SqlFormManager::form(), and Q3DataBrowserPrivate::frm.

Referenced by setForm().

{
    return d->frm.form();
}

Here is the call graph for this function:

void Q3DataBrowser::setConfirmEdits

(

bool

confirm

)

[virtual]

Definition at line 367 of file q3databrowser.cpp.

References d, Q3DataBrowserPrivate::dat, and Q3DataManager::setConfirmEdits().

{
    d->dat.setConfirmEdits(confirm);
}

Here is the call graph for this function:

void Q3DataBrowser::setConfirmInsert

(

bool

confirm

)

[virtual]

Definition at line 382 of file q3databrowser.cpp.

References d, Q3DataBrowserPrivate::dat, and Q3DataManager::setConfirmInsert().

{
    d->dat.setConfirmInsert(confirm);
}

Here is the call graph for this function:

void Q3DataBrowser::setConfirmUpdate

(

bool

confirm

)

[virtual]

Definition at line 397 of file q3databrowser.cpp.

References d, Q3DataBrowserPrivate::dat, and Q3DataManager::setConfirmUpdate().

{
    d->dat.setConfirmUpdate(confirm);
}

Here is the call graph for this function:

void Q3DataBrowser::setConfirmDelete

(

bool

confirm

)

[virtual]

Definition at line 412 of file q3databrowser.cpp.

References d, Q3DataBrowserPrivate::dat, and Q3DataManager::setConfirmDelete().

{
    d->dat.setConfirmDelete(confirm);
}

Here is the call graph for this function:

void Q3DataBrowser::setConfirmCancels

(

bool

confirm

)

[virtual]

Definition at line 462 of file q3databrowser.cpp.

References d, Q3DataBrowserPrivate::dat, and Q3DataManager::setConfirmCancels().

{
    d->dat.setConfirmCancels(confirm);
}

Here is the call graph for this function:

bool Q3DataBrowser::confirmEdits

(

)

const

Definition at line 430 of file q3databrowser.cpp.

References Q3DataManager::confirmEdits(), d, and Q3DataBrowserPrivate::dat.

{
    return (d->dat.confirmEdits());
}

Here is the call graph for this function:

bool Q3DataBrowser::confirmInsert

(

)

const

Definition at line 435 of file q3databrowser.cpp.

References Q3DataManager::confirmInsert(), d, and Q3DataBrowserPrivate::dat.

Referenced by insert(), preNav(), and update().

{
    return (d->dat.confirmInsert());
}

Here is the call graph for this function:

bool Q3DataBrowser::confirmUpdate

(

)

const

Definition at line 440 of file q3databrowser.cpp.

References Q3DataManager::confirmUpdate(), d, and Q3DataBrowserPrivate::dat.

Referenced by insert(), preNav(), and update().

{
    return (d->dat.confirmUpdate());
}

Here is the call graph for this function:

bool Q3DataBrowser::confirmDelete

(

)

const

Definition at line 445 of file q3databrowser.cpp.

References Q3DataManager::confirmDelete(), d, and Q3DataBrowserPrivate::dat.

Referenced by del().

{
    return (d->dat.confirmDelete());
}

Here is the call graph for this function:

bool Q3DataBrowser::confirmCancels

(

)

const

Definition at line 467 of file q3databrowser.cpp.

References Q3DataManager::confirmCancels(), d, and Q3DataBrowserPrivate::dat.

Referenced by del().

{
    return d->dat.confirmCancels();
}

Here is the call graph for this function:

void Q3DataBrowser::setReadOnly

(

bool

active

)

[virtual]

Definition at line 357 of file q3databrowser.cpp.

References d, and Q3DataBrowserPrivate::readOnly.

Referenced by setSqlCursor().

{
    d->readOnly = active;
}

bool Q3DataBrowser::isReadOnly

(

)

const

Definition at line 362 of file q3databrowser.cpp.

References d, and Q3DataBrowserPrivate::readOnly.

Referenced by deleteCurrent(), insertCurrent(), preNav(), and updateCurrent().

{
    return d->readOnly;
}

void Q3DataBrowser::setAutoEdit

(

bool

autoEdit

)

[virtual]

Definition at line 486 of file q3databrowser.cpp.

References d, Q3DataBrowserPrivate::dat, and Q3DataManager::setAutoEdit().

{
    d->dat.setAutoEdit(autoEdit);
}

Here is the call graph for this function:

bool Q3DataBrowser::autoEdit

(

)

const

Definition at line 491 of file q3databrowser.cpp.

References Q3DataManager::autoEdit(), d, and Q3DataBrowserPrivate::dat.

Referenced by insert(), and preNav().

{
    return d->dat.autoEdit();
}

Here is the call graph for this function:

bool Q3DataBrowser::seek	(	int	i,
		bool	relative = false
	)			[virtual]

Moves the default cursor to the record specified by the index i and refreshes the default form to display this record. If there is no default form or no default cursor, nothing happens. If relative 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.

If the browser is already positioned on the desired record nothing happens.

Definition at line 802 of file q3databrowser.cpp.

References b, Q3DataBrowserPrivate::cur, Q3SqlCursorManager::cursor(), d, postNav(), preNav(), and Q3SqlCursor::seek().

{
    int b = 0;
    Q3SqlCursor* cur = d->cur.cursor();
    if (!cur)
        return false;
    if (preNav())
        b = cur->seek(i, relative);
    postNav(b);
    return b;
}

Here is the call graph for this function:

void Q3DataBrowser::firstRecordAvailable

(

bool

available

)

[signal]

This signal is emitted whenever the position of the cursor changes. The available parameter indicates whether or not the first record in the default cursor is available.

Referenced by updateBoundary().

void Q3DataBrowser::lastRecordAvailable

(

bool

available

)

[signal]

This signal is emitted whenever the position of the cursor changes. The available parameter indicates whether or not the last record in the default cursor is available.

Referenced by updateBoundary().

void Q3DataBrowser::nextRecordAvailable

(

bool

available

)

[signal]

This signal is emitted whenever the position of the cursor changes. The available parameter indicates whether or not the next record in the default cursor is available.

Referenced by updateBoundary().

void Q3DataBrowser::prevRecordAvailable

(

bool

available

)

[signal]

This signal is emitted whenever the position of the cursor changes. The available parameter indicates whether or not the previous record in the default cursor is available.

Referenced by updateBoundary().

void Q3DataBrowser::currentChanged

(

const QSqlRecord *

record

)

[signal]

This signal is emitted whenever the current cursor position changes. The record parameter points to the contents of the current cursor's record.

Referenced by postNav().

void Q3DataBrowser::primeInsert

(

QSqlRecord *

buf

)

[signal]

This signal is emitted when the data browser enters insertion mode. The buf 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 Q3SqlCursor::primeInsert() is not called on the default cursor, as this would corrupt values in the form.)

See also:

insert()

Referenced by insert().

void Q3DataBrowser::primeUpdate

(

QSqlRecord *

buf

)

[signal]

This signal is emitted when the data browser enters update mode. Note that during navigation (first(), last(), next(), prev()), each record that is shown in the default form is primed for update. The buf parameter points to the record buffer being updated. (Note that Q3SqlCursor::primeUpdate() is not 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.

See also:

update()

Referenced by postNav().

void Q3DataBrowser::primeDelete

(

QSqlRecord *

buf

)

[signal]

This signal is emitted when the data browser enters deletion mode. The buf parameter points to the record buffer being deleted. (Note that Q3SqlCursor::primeDelete() is not 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.

See also:

del()

Referenced by del().

void Q3DataBrowser::beforeInsert

(

QSqlRecord *

buf

)

[signal]

This signal is emitted just before the cursor's edit buffer is inserted into the database. The buf parameter points to the edit buffer being inserted. You might connect to this signal to populate a generated primary key for example.

Referenced by insertCurrent().

void Q3DataBrowser::beforeUpdate

(

QSqlRecord *

buf

)

[signal]

This signal is emitted just before the cursor's edit buffer is updated in the database. The buf parameter points to the edit buffer being updated. You might connect to this signal to capture some auditing information about the update.

Referenced by updateCurrent().

void Q3DataBrowser::beforeDelete

(

QSqlRecord *

buf

)

[signal]

This signal is emitted just before the cursor's edit buffer is deleted from the database. The buf parameter points to the edit buffer being deleted. You might connect to this signal to capture some auditing information about the deletion.

Referenced by deleteCurrent().

void Q3DataBrowser::cursorChanged

(

Q3SqlCursor::Mode

mode

)

[signal]

This signal is emitted whenever the cursor record was changed due to navigation. The mode parameter is the edit that just took place, e.g. Insert, Update or Delete. See Q3SqlCursor::Mode.

Referenced by deleteCurrent(), insertCurrent(), and updateCurrent().

void Q3DataBrowser::refresh

(

)

[virtual, slot]

Refreshes the data browser's data using the default cursor. The browser's current filter and sort are applied if they have been set.

See also:

setFilter() setSort()

Definition at line 599 of file q3databrowser.cpp.

References Q3DataBrowserPrivate::cur, d, and Q3SqlCursorManager::refresh().

Referenced by deleteCurrent(), insertCurrent(), and updateCurrent().

{
    d->cur.refresh();
}

void Q3DataBrowser::insert

(

)

[virtual, slot]

Performs an insert operation on the data browser's cursor. If there is no default cursor or no default form, nothing happens.

If auto-editing is on (see setAutoEdit()), the following happens:

If the browser is already actively inserting a record, the current form's data is inserted into the database. 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).

If there is an error handling any of the above auto-edit actions, handleError() is called and no insert or update is performed.

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:

The default cursor is primed for insert using Q3SqlCursor::primeInsert(). The primeInsert() signal is emitted. 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.

Definition at line 635 of file q3databrowser.cpp.

References autoEdit(), buf, confirmEdit(), confirmInsert(), confirmUpdate(), Q3DataBrowserPrivate::cur, currentEdited(), Q3SqlCursorManager::cursor(), d, Q3DataBrowserPrivate::dat, emit, Q3DataBrowserPrivate::frm, insertCurrent(), Q3DataManager::mode(), Q3SqlCursor::primeInsert(), primeInsert(), readFields(), Q3SqlFormManager::record(), Q3DataManager::setMode(), sqlCursor(), and updateCurrent().

{
    QSqlRecord* buf = d->frm.record();
    Q3SqlCursor* cur = d->cur.cursor();
    if (!buf || !cur)
        return;
    bool doIns = true;
    QSql::Confirm conf = QSql::Yes;
    switch (d->dat.mode()) {
    case QSql::Insert:
        if (autoEdit()) {
            if (confirmInsert())
                conf = confirmEdit(QSql::Insert);
            switch (conf) {
            case QSql::Yes:
                insertCurrent();
                break;
            case QSql::No:
                break;
            case QSql::Cancel:
                doIns = false;
                break;
            }
        }
        break;
    default:
        if (autoEdit() && currentEdited()) {
            if (confirmUpdate())
                conf = confirmEdit(QSql::Update);
            switch (conf) {
            case QSql::Yes:
                updateCurrent();
                break;
            case QSql::No:
                break;
            case QSql::Cancel:
                doIns = false;
                break;
            }
        }
        break;
    }
    if (doIns) {
        d->dat.setMode(QSql::Insert);
        sqlCursor()->primeInsert();
        emit primeInsert(d->frm.record());
        readFields();
    }
}

void Q3DataBrowser::update

(

)

[virtual, slot]

Performs an update operation on the data browser's cursor.

If there is no default cursor or no default form, nothing happens. Otherwise, the following happens:

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.

Reimplemented from QWidget.

Definition at line 699 of file q3databrowser.cpp.

References buf, confirmEdit(), confirmInsert(), confirmUpdate(), Q3DataBrowserPrivate::cur, Q3SqlCursorManager::cursor(), d, Q3DataBrowserPrivate::dat, Q3SqlCursor::editBuffer(), Q3DataBrowserPrivate::frm, insertCurrent(), Q3DataManager::mode(), readFields(), Q3SqlFormManager::record(), Q3DataManager::setMode(), and updateCurrent().

{
    QSqlRecord* buf = d->frm.record();
    Q3SqlCursor* cur = d->cur.cursor();
    if (!buf || !cur)
        return;
    QSql::Confirm conf = QSql::Yes;
    switch (d->dat.mode()){
    case QSql::Insert:
        if (confirmInsert())
            conf = confirmEdit(QSql::Insert);
        switch (conf) {
            case QSql::Yes:
                if (insertCurrent())
                    d->dat.setMode(QSql::Update);
            break;
            case QSql::No:
                d->dat.setMode(QSql::Update);
            cur->editBuffer(true);
            readFields();
            break;
            case QSql::Cancel:
            break;
        }
    break;
    default:
        d->dat.setMode(QSql::Update);
        if (confirmUpdate())
            conf = confirmEdit(QSql::Update);
        switch (conf) {
        case QSql::Yes:
            updateCurrent();
            break;
        case QSql::No:
        case QSql::Cancel:
            break;
        }
        break;
    }
}

void Q3DataBrowser::del

(

)

[virtual, slot]

Performs a delete operation on the data browser's cursor. If there is no default cursor or no default form, nothing happens.

Otherwise, the following happens:

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.

Definition at line 754 of file q3databrowser.cpp.

References buf, confirmCancel(), confirmCancels(), confirmDelete(), confirmEdit(), Q3DataBrowserPrivate::cur, Q3SqlCursorManager::cursor(), d, Q3DataBrowserPrivate::dat, deleteCurrent(), Q3SqlCursor::editBuffer(), emit, Q3DataBrowserPrivate::frm, Q3DataManager::mode(), primeDelete(), readFields(), Q3SqlFormManager::record(), and Q3DataManager::setMode().

{
    QSqlRecord* buf = d->frm.record();
    Q3SqlCursor* cur = d->cur.cursor();
    if (!buf || !cur)
        return;
    QSql::Confirm conf = QSql::Yes;
    switch (d->dat.mode()){
    case QSql::Insert:
        if (confirmCancels())
            conf = confirmCancel(QSql::Insert);
        if (conf == QSql::Yes) {
            cur->editBuffer(true); /* restore from cursor */
            readFields();
            d->dat.setMode(QSql::Update);
        } else
            d->dat.setMode(QSql::Insert);
        break;
    default:
        if (confirmDelete())
            conf = confirmEdit(QSql::Delete);
        switch (conf) {
        case QSql::Yes:
            emit primeDelete(buf);
            deleteCurrent();
            break;
        case QSql::No:
        case QSql::Cancel:
            break;
        }
        d->dat.setMode(QSql::Update);
        break;
    }
}

void Q3DataBrowser::first

(

)

[virtual, slot]

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 primeUpdate() signal is emitted.

If the browser is already positioned on the first record nothing happens.

Definition at line 826 of file q3databrowser.cpp.

References Q3SqlCursor::first(), and nav().

{
    nav(&Q3SqlCursor::first);
}

void Q3DataBrowser::last

(

)

[virtual, slot]

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.

If the browser is already positioned on the last record nothing happens.

Definition at line 843 of file q3databrowser.cpp.

References Q3SqlCursor::last(), and nav().

Referenced by deleteCurrent().

{
    nav(&Q3SqlCursor::last);
}

void Q3DataBrowser::next

(

)

[virtual, slot]

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 primeUpdate() signal is emitted.

If the browser is positioned on the last record nothing happens.

Definition at line 859 of file q3databrowser.cpp.

References nav(), and Q3SqlCursor::next().

{
    nav(&Q3SqlCursor::next);
}

void Q3DataBrowser::prev

(

)

[virtual, slot]

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 primeUpdate() signal is emitted.

If the browser is positioned on the first record nothing happens.

Definition at line 875 of file q3databrowser.cpp.

References nav(), and Q3SqlCursor::previous().

{
    nav(&Q3SqlCursor::previous);
}

void Q3DataBrowser::readFields

(

)

[virtual, slot]

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.

Definition at line 886 of file q3databrowser.cpp.

References d, Q3DataBrowserPrivate::frm, and Q3SqlFormManager::readFields().

Referenced by del(), deleteCurrent(), insert(), postNav(), update(), and updateCurrent().

{
    d->frm.readFields();
}

void Q3DataBrowser::writeFields

(

)

[virtual, slot]

Writes the form's data to the default cursor's edit buffer. If there is no default cursor or no default form, nothing happens.

Definition at line 897 of file q3databrowser.cpp.

References d, Q3DataBrowserPrivate::frm, and Q3SqlFormManager::writeFields().

Referenced by currentEdited(), deleteCurrent(), insertCurrent(), and updateCurrent().

{
    d->frm.writeFields();
}

void Q3DataBrowser::clearValues

(

)

[virtual, slot]

Clears all the values in the form.

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 Q3SqlPropertyMap constructor for the default mappings of widgets to properties.

Definition at line 914 of file q3databrowser.cpp.

References Q3SqlFormManager::clearValues(), d, and Q3DataBrowserPrivate::frm.

Referenced by deleteCurrent().

{
    d->frm.clearValues();
}

void Q3DataBrowser::updateBoundary

(

)

[slot]

If boundaryChecking() is true, checks the boundary of the current default cursor and emits signals which indicate the position of the cursor.

Definition at line 1158 of file q3databrowser.cpp.

References AfterEnd, BeforeBeginning, Beginning, boundary(), Q3DataBrowserPrivate::boundaryCheck, d, emit, End, firstRecordAvailable(), lastRecordAvailable(), nextRecordAvailable(), None, prevRecordAvailable(), and Unknown.

Referenced by deleteCurrent(), insertCurrent(), postNav(), and updateCurrent().

{
    if (d->boundaryCheck) {
        Boundary bound = boundary();
        switch (bound) {
        case Unknown:
        case None:
            emit firstRecordAvailable(true);
            emit prevRecordAvailable(true);
            emit nextRecordAvailable(true);
            emit lastRecordAvailable(true);
            break;

        case BeforeBeginning:
            emit firstRecordAvailable(false);
            emit prevRecordAvailable(false);
            emit nextRecordAvailable(true);
            emit lastRecordAvailable(true);
            break;

        case Beginning:
            emit firstRecordAvailable(false);
            emit prevRecordAvailable(false);
            emit nextRecordAvailable(true);
            emit lastRecordAvailable(true);
            break;

        case End:
            emit firstRecordAvailable(true);
            emit prevRecordAvailable(true);
            emit nextRecordAvailable(false);
            emit lastRecordAvailable(false);
            break;

        case AfterEnd:
            emit firstRecordAvailable(true);
            emit prevRecordAvailable(true);
            emit nextRecordAvailable(false);
            emit lastRecordAvailable(false);
            break;
        }
    }
}

bool Q3DataBrowser::insertCurrent

(

)

[protected, virtual]

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 successful, the cursor is refreshed and relocated to the newly inserted record, the cursorChanged() signal is emitted, and true is returned.

See also:

cursorChanged() sqlCursor() form() handleError()

Definition at line 931 of file q3databrowser.cpp.

References beforeInsert(), buf, Q3DataBrowserPrivate::cur, Q3SqlCursorManager::cursor(), cursorChanged(), d, emit, Q3SqlCursorManager::findBuffer(), Q3DataBrowserPrivate::frm, handleError(), Q3SqlCursor::insert(), Q3SqlCursor::Insert, QSqlQuery::isActive(), isReadOnly(), QSqlQuery::lastError(), Q3SqlCursor::primaryIndex(), Q3SqlFormManager::record(), refresh(), updateBoundary(), and writeFields().

Referenced by insert(), preNav(), and update().

{
    if (isReadOnly())
        return false;
    QSqlRecord* buf = d->frm.record();
    Q3SqlCursor* cur = d->cur.cursor();
    if (!buf || !cur)
        return false;
    writeFields();
    emit beforeInsert(buf);
    int ar = cur->insert();
    if (!ar || !cur->isActive()) {
        handleError(cur->lastError());
        refresh();
        updateBoundary();
    } else {
        refresh();
        d->cur.findBuffer(cur->primaryIndex());
        updateBoundary();
        cursorChanged(Q3SqlCursor::Insert);
        return true;
    }
    return false;
}

Here is the call graph for this function:

bool Q3DataBrowser::updateCurrent

(

)

[protected, virtual]

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 successful, the cursor is refreshed and relocated to the updated record, the cursorChanged() signal is emitted, and true is returned.

See also:

cursor() form() handleError()

Definition at line 969 of file q3databrowser.cpp.

References beforeUpdate(), buf, Q3DataBrowserPrivate::cur, Q3SqlCursorManager::cursor(), cursorChanged(), d, Q3SqlCursor::editBuffer(), emit, Q3SqlCursorManager::findBuffer(), Q3DataBrowserPrivate::frm, handleError(), QSqlQuery::isActive(), isReadOnly(), QSqlQuery::lastError(), Q3SqlCursor::primaryIndex(), readFields(), Q3SqlFormManager::record(), refresh(), Q3SqlCursor::update(), Q3SqlCursor::Update, updateBoundary(), and writeFields().

Referenced by insert(), preNav(), and update().

{
    if (isReadOnly())
        return false;
    QSqlRecord* buf = d->frm.record();
    Q3SqlCursor* cur = d->cur.cursor();
    if (!buf || !cur)
        return false;
    writeFields();
    emit beforeUpdate(buf);
    int ar = cur->update();
    if (!ar || !cur->isActive()) {
        handleError(cur->lastError());
        refresh();
        updateBoundary();
    } else {
        refresh();
        d->cur.findBuffer(cur->primaryIndex());
        updateBoundary();
        cur->editBuffer(true);
        cursorChanged(Q3SqlCursor::Update);
        readFields();
        return true;
    }
    return false;
}

Here is the call graph for this function:

bool Q3DataBrowser::deleteCurrent

(

)

[protected, virtual]

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.

See also:

cursor() form() handleError()

Definition at line 1010 of file q3databrowser.cpp.

References QSqlQuery::at(), beforeDelete(), buf, clearValues(), Q3DataBrowserPrivate::cur, Q3SqlCursorManager::cursor(), cursorChanged(), d, Q3SqlCursor::del(), Q3SqlCursor::Delete, Q3SqlCursor::editBuffer(), emit, Q3DataBrowserPrivate::frm, handleError(), QSqlQuery::isActive(), isReadOnly(), QSqlQuery::isValid(), last(), QSqlQuery::lastError(), n, readFields(), Q3SqlFormManager::record(), refresh(), Q3SqlCursor::seek(), updateBoundary(), and writeFields().

Referenced by del().

{
    if (isReadOnly())
        return false;
    QSqlRecord* buf = d->frm.record();
    Q3SqlCursor* cur = d->cur.cursor();
    if (!buf || !cur)
        return false;
    writeFields();
    int n = cur->at();
    emit beforeDelete(buf);
    int ar = cur->del();
    if (ar) {
        refresh();
        updateBoundary();
        cursorChanged(Q3SqlCursor::Delete);
        if (!cur->seek(n))
            last();
        if (cur->isValid()) {
            cur->editBuffer(true);
            readFields();
        } else {
            clearValues();
        }
        return true;
    } else {
        if (!cur->isActive()) {
            handleError(cur->lastError());
            refresh();
            updateBoundary();
        }
    }
    return false;
}

Here is the call graph for this function:

bool Q3DataBrowser::currentEdited

(

)

[protected, virtual]

Returns true if the form's edit buffer differs from the current cursor buffer; otherwise returns false.

Definition at line 1051 of file q3databrowser.cpp.

References buf, QSqlRecord::count(), Q3DataBrowserPrivate::cur, Q3SqlCursorManager::cursor(), d, Q3DataBrowserPrivate::frm, i, QSqlQuery::isActive(), QSqlQuery::isValid(), Q3SqlFormManager::record(), Q3SqlCursor::value(), and writeFields().

Referenced by insert(), and preNav().

{
    QSqlRecord* buf = d->frm.record();
    Q3SqlCursor* cur = d->cur.cursor();
    if (!buf || !cur)
        return false;
    if (!cur->isActive() || !cur->isValid())
        return false;
    writeFields();
    for (int i = 0; i < cur->count(); ++i) {
        if (cur->value(i) != buf->value(i))
            return true;
    }
    return false;
}

Here is the call graph for this function:

QSql::Confirm Q3DataBrowser::confirmEdit

(

QSql::Op

m

)

[protected, virtual]

Protected virtual function which returns a confirmation for an edit of mode m. 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.

Definition at line 1220 of file q3databrowser.cpp.

References Q3DataManager::confirmEdit(), d, and Q3DataBrowserPrivate::dat.

Referenced by del(), insert(), preNav(), and update().

{
    return d->dat.confirmEdit(this, m);
}

Here is the call graph for this function:

QSql::Confirm Q3DataBrowser::confirmCancel

(

QSql::Op

m

)

[protected, virtual]

Protected virtual function which returns a confirmation for canceling an edit mode m. 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.

Definition at line 1233 of file q3databrowser.cpp.

References Q3DataManager::confirmCancel(), d, and Q3DataBrowserPrivate::dat.

Referenced by del().

{
    return d->dat.confirmCancel(this, m);
}

Here is the call graph for this function:

void Q3DataBrowser::handleError

(

const QSqlError &

error

)

[protected, virtual]

Virtual function which handles the error error. The default implementation warns the user with a message box.

Definition at line 1207 of file q3databrowser.cpp.

References d, Q3DataBrowserPrivate::dat, error, and Q3DataManager::handleError().

Referenced by deleteCurrent(), insertCurrent(), and updateCurrent().

{
    d->dat.handleError(this, error);
}

Here is the call graph for this function:

bool Q3DataBrowser::preNav

(

)

[private]

Definition at line 1072 of file q3databrowser.cpp.

References autoEdit(), buf, confirmEdit(), confirmInsert(), confirmUpdate(), Q3DataBrowserPrivate::cur, currentEdited(), Q3SqlCursorManager::cursor(), d, Q3DataBrowserPrivate::dat, Q3DataBrowserPrivate::frm, insertCurrent(), isReadOnly(), Q3DataManager::mode(), Q3SqlFormManager::record(), Q3DataManager::setMode(), and updateCurrent().

Referenced by nav(), and seek().

{
    QSqlRecord* buf = d->frm.record();
    Q3SqlCursor* cur = d->cur.cursor();
    if (!buf || !cur)
        return false;

    if (!isReadOnly() && autoEdit() && currentEdited()) {
        bool ok = true;
        QSql::Confirm conf = QSql::Yes;
        switch (d->dat.mode()){
        case QSql::Insert:
            if (confirmInsert())
                conf = confirmEdit(QSql::Insert);
            switch (conf) {
            case QSql::Yes:
                ok = insertCurrent();
                d->dat.setMode(QSql::Update);
                break;
            case QSql::No:
                d->dat.setMode(QSql::Update);
                break;
            case QSql::Cancel:
                return false;
            }
            break;
        default:
            if (confirmUpdate())
                conf = confirmEdit(QSql::Update);
            switch (conf) {
            case QSql::Yes:
                ok = updateCurrent();
                break;
            case QSql::No:
                break;
            case QSql::Cancel:
                return false;
            }
        }
        return ok;
    }
    return true;
}

Here is the call graph for this function:

void Q3DataBrowser::postNav

(

bool

primeUpd

)

[private]

Definition at line 1121 of file q3databrowser.cpp.

References buf, Q3DataBrowserPrivate::cur, currentChanged(), Q3SqlCursorManager::cursor(), d, emit, Q3DataBrowserPrivate::frm, primeUpdate(), Q3SqlCursor::primeUpdate(), readFields(), Q3SqlFormManager::record(), and updateBoundary().

Referenced by nav(), and seek().

{
    if (primeUpd) {
        QSqlRecord* buf = d->frm.record();
        Q3SqlCursor* cur = d->cur.cursor();
        if (!buf || !cur)
            return;
        currentChanged(cur);
        cur->primeUpdate();
        emit primeUpdate(buf);
        readFields();
    }
    updateBoundary();
}

Here is the call graph for this function:

void Q3DataBrowser::nav

(

Nav

nav

)

[private]

Definition at line 1141 of file q3databrowser.cpp.

References b, Q3DataBrowserPrivate::cur, Q3SqlCursorManager::cursor(), d, postNav(), and preNav().

Referenced by first(), last(), next(), and prev().

{
    int b = 0;
    Q3SqlCursor* cur = d->cur.cursor();
    if (!cur)
        return;
    if (preNav())
        b = (cur->*nav)();
    postNav(b);
}

Here is the call graph for this function:

---

Member Data Documentation

Q3DataBrowserPrivate* Q3DataBrowser::d [private]

Definition at line 152 of file q3databrowser.h.

Referenced by autoEdit(), boundary(), boundaryChecking(), clearValues(), confirmCancel(), confirmCancels(), confirmDelete(), confirmEdit(), confirmEdits(), confirmInsert(), confirmUpdate(), currentEdited(), del(), deleteCurrent(), filter(), form(), handleError(), insert(), insertCurrent(), isReadOnly(), nav(), postNav(), preNav(), Q3DataBrowser(), readFields(), refresh(), seek(), setAutoEdit(), setBoundaryChecking(), setConfirmCancels(), setConfirmDelete(), setConfirmEdits(), setConfirmInsert(), setConfirmUpdate(), setFilter(), setForm(), setReadOnly(), setSort(), setSqlCursor(), sort(), sqlCursor(), update(), updateBoundary(), updateCurrent(), writeFields(), and ~Q3DataBrowser().

---

The documentation for this class was generated from the following files:

• src/qt3support/sql/q3databrowser.h
• src/qt3support/sql/q3databrowser.cpp

---