Source: toresultlong.h

# Source: toresultlong.h |
Annotated List
Files
Globals
Hierarchy
Index

    /*****
     *
     * TOra - An Oracle Toolkit for DBA's and developers
     * Copyright (C) 2003-2005 Quest Software, Inc
     * Portions Copyright (C) 2005 Other Contributors
     *
     * This program is free software; you can redistribute it and/or
     * modify it under the terms of the GNU General Public License
     * as published by the Free Software Foundation;  only version 2 of
     * the License is valid for this program.
     *
     * This program is distributed in the hope that it will be useful,
     * but WITHOUT ANY WARRANTY; without even the implied warranty of
     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     * GNU General Public License for more details.
     *
     * You should have received a copy of the GNU General Public License
     * along with this program; if not, write to the Free Software
     * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
     *
     *      As a special exception, you have permission to link this program
     *      with the Oracle Client libraries and distribute executables, as long
     *      as you follow the requirements of the GNU GPL in regard to all of the
     *      software in the executable aside from Oracle client libraries.
     *
     *      Specifically you are not permitted to link this program with the
     *      Qt/UNIX, Qt/Windows or Qt Non Commercial products of TrollTech.
     *      And you are not permitted to distribute binaries compiled against
     *      these libraries without written consent from Quest Software, Inc.
     *      Observe that this does not disallow linking to the Qt Free Edition.
     *
     *      You may link this product with any GPL'd Qt library such as Qt/Free
     *
     * All trademarks belong to their respective owners.
     *
     *****/

    #ifndef TORESULTLONG_H
    #define TORESULTLONG_H

    #include "tobackground.h"
    #include "toconnection.h"
    #include "toresultview.h"

    class QListViewItem;
    class toNoBlockQuery;
    class toResultStats;
    class toResultTip;
    class toresultlong;

    /** A widget which contains the result of a query run in the background.
     */
    class toResultLong : public toResultView {
      Q_OBJECT

      /** No blocking query object.
       */
      toNoBlockQuery *Query;
      /** Timer to poll for new data.
       */
      toBackground Timer;
      /** Indicator if headers have been parsed yet.
       */
      bool HasHeaders;
      /** Indicator if first row has been read yet.
       */
      bool First;
      /** Widget to store query statistics to.
       */
      toResultStats *Statistics;
      /** Description of query
       */
      toQDescList Description;
      /** Number of rows to fetch when starting. (-1 for all)
       */
      int MaxNumber;

      /** The query mode to use for the executed query.
       */
      toQuery::queryMode Mode;

      /** Check if at eof.
       */
      virtual bool eof(void);
      /** Clean up when query is done
       */
      void cleanup(void);
    public:
      /** Create widget.
       * @param readable Indicate if columns are to be made more readable. This means that the
       * descriptions are capitalised and '_' are converted to ' '.
       * @param numCol If number column is to be displayed.
       * @param mode Query mode to use when executing query
       * @param parent Parent of list.
       * @param name Name of widget.
       * @param f Widget flags.
       */
      toResultLong(bool readable,bool numCol,toQuery::queryMode mode,QWidget *parent,const char *name=NULL,WFlags f=0);
      /** Create widget. The columns are not readable and the number column is displayed.
       * @param parent Parent of list.
       * @param name Name of widget.
       * @param f Widget flags.
       */
      toResultLong(QWidget *parent,const char *name=NULL,WFlags f=0);
      ~toResultLong();

      /** Set statistics widget.
       * @param stats Statistics widget.
       */
      void setStatistics(toResultStats *stats)
      { Statistics=stats; }

      /** Check if query is still running.
       * @return True if query is still running.
       */
      bool running(void)
      { return Query; }

      /** Reimplemented for internal reasons.
       */
      virtual void query(const QString &sql,const toQList ¶m);
      /** Reimplemented for internal reasons.
       */
      void query(const QString &sql)
      { toQList p; query(sql,p); }
      /** Reimplemented for internal reasons.
       */
      virtual void editReadAll(void);
    signals:
      /** Emitted when query is finnished.
       */
      void done(void);
      /** Emitted when the first result is available.
       * @param sql SQL that was run.
       * @param res String describing result.
       * @param error Error has occurred.
       */
      void firstResult(const QString &sql,const toConnection::exception &res,bool error);

    public slots:
      /** Stop running query.
       */
      void stop(void);
      /** Reimplemented for internal reasons.
       */
      virtual void addItem(void);
    };

    #endif

Generated by: nneul on skyhawk on Wed Feb 23 19:49:58 2005, using kdoc 2.0a54.