dbmodel.h

/**
 * @file dbmodel.h
 * @brief Declarations for DbModel class
 * @author Nicu Tofan <nicu.tofan@gmail.com>
 * @copyright Copyright 2014 piles contributors. All rights reserved.
 * This file is released under the
 * [MIT License](http://opensource.org/licenses/mit-license.html)
 */

#ifndef GUARD_DBMODEL_H_INCLUDE
#define GUARD_DBMODEL_H_INCLUDE

#include <dbmodel/dbmodel-config.h>
#include <dbmodel/dbmodelcol.h>
#include <dbmodel/dbmodeltbl.h>

#include <QSqlRecord>
#include <QSortFilterProxyModel>
#include <QSqlDatabase>
#include <QVector>
#include <QModelIndex>

class DbModelPrivate;

QT_BEGIN_NAMESPACE
class QSqlQueryModel;
class QSqlTableModel;
class QAbstractItemView;
QT_END_NAMESPACE

//! A Qt model capable of representing sql tables.
class DBMODEL_EXPORT DbModel : public QSortFilterProxyModel  {
    Q_OBJECT

    DbModelPrivate * impl; /**< the private implementation */
    QString filter_; /**< current installed filter */

public:

    //! Create a new model from a table or view definition and a database.
    DbModel (
            DbStruct * db,
            DbTaew * meta,
            QObject * parent = NULL);

    //! Create a new model from a database and an index.
    DbModel (
            DbStruct * db,
            int component,
            QObject * parent = NULL);

    Q_DISABLE_COPY(DbModel)

    //! Destructor.
    virtual ~DbModel();

    //! Is this a valid model (with a table set) or not?
    bool
    isValid() const;

    //! Set the table or view; old instance is deleted;
    //! ownership of table is assumed.
    void
    setMeta (
            DbTaew * meta);

    //! Set the database and table or view; old instance is deleted;
    //! ownership of table is assumed.
    void
    setMeta (
            DbStruct * database,
            DbTaew * meta);

    //! Give away the pointer and remove it from internal storage.
    DbTaew *
    takeMeta ();

    //! Get a pointer to meta object; ownership stays with this instance.
    DbTaew *
    metaTaew () const;

    //! Get a pointer to internal main model object.
    QSqlTableModel *
    mainModel () const;

    //! Select the model (retrieve information using options).
    bool
    selectMe ();

    //! Number of rows.
    virtual int
    rowCount () const;

    //! Number of columns.
    virtual int
    columnCount () const;

    //! Number of rows.
    virtual int
    rowCount (
            const QModelIndex & idx) const {
        return QSortFilterProxyModel::rowCount (idx);
    }

    //! Number of columns.
    virtual int
    columnCount (
            const QModelIndex & idx) const {
        return QSortFilterProxyModel::columnCount (idx);
    }

    //! Custom sorting.
    bool
    lessThan (
        const QModelIndex &left,
        const QModelIndex &right) const;


    //! Retrieve the database. Ownership of returned pointer stays
    //! with this instance.
    DbStruct *
        database () const;

    //! Set the database; also invalidates the table.
    void
    setDatabase (
        DbStruct * value);

    //! Give away the pointer and remove it from internal storage.
    DbStruct *
    takeDatabase ();

    //! Get the model data regarding a column; index is a virtual index.
    const DbModelCol &
    columnData (
        int index) const;

    //! Get the model data regarding a table.
    const DbModelTbl &
    tableData (
        int table_index) const;

    //! Set a filter on one of the internal models identified by its index.
    bool
    setFilter (
            const QString & filter,
            int table_index = 0);

    //! Set a filter on one of the internal models identified by its name.
    bool
    setFilter (
            const QString & filter,
            const QString & table);

    //! Get the filter installed on main model.
    const QString &
    filter () const {
        return filter_;
    }

    //! Set a filter on one of the internal models identified by its index.
    bool
    setOrder (
            int column,
            Qt::SortOrder order,
            int table_index = 0);

    //! Set a filter on one of the internal models identified by its name.
    bool
    setOrder (
            int column,
            Qt::SortOrder order,
            const QString & table);


    //! Find the index of a model identified by its name.
    int
    findTable (
            const QString & table) const;

    //! Get a record for a row
    QSqlRecord
    record (
            int row) const;

    //! Read the labels again (possibly in a different language).
    void
    reloadHeaders ();


    //! Set the callback for a column in a table.
    bool
    setColumnCallback (
            int table_index,
            int column_index,
            DbColKb value,
            void * user_data = NULL);

    //! Set the callback for a column in main table.
    bool
    setColumnCallback (
            int column_index,
            DbColKb value,
            void * user_data = NULL) {
        return setColumnCallback (0, column_index, value, user_data);
    }

    //! Get the callback for a cell.
    DbColKb
    columnCallback (
            int table_index,
            int column_index);

    //! Get the callback for a cell.
    void *
    columnCallbackData ();

    DbModelPrivate *
    implementation () const {
        return impl;
    }

    /*  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  */
    /** @name Marker
    * A cell may be highlighted in a different color and with
    * a special icon; the model only stores the coordinates
    * of that cell.
    */
    ///@{

    //! Set the indicated .
    bool
    setCurrentMarker (
        int row,
        int column);

    //! Retrieve highlight row.
    int
    getMarkerRow () const;

    //! Retrieve highlight column.
    int
    getMarkerCol () const;

    //! Tell if we have a highlight cell set.
    bool
    hasMarkerCell () const;

    ///@}
    /*  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  -  */


    static int
    findById (
            QAbstractItemModel * m,
            long id,
            int col_id = 0);

    static int
    findById (
            QAbstractItemView *view,
            long id,
            int col_id = 0);

    static int
    selectById (
            QAbstractItemView *view,
            long id,
            int col_id = 0);

public: virtual void anchorVtable() const;
};

#endif // GUARD_DBMODEL_H_INCLUDE