Table.h

Go to the documentation of this file.

/***************************************************************************
    File                 : Table.h
    Project              : SciDAVis
    Description          : Table worksheet class
    --------------------------------------------------------------------
    Copyright            : (C) 2006-2009 Tilman Benkert (thzs*gmx.net)
    Copyright            : (C) 2006-2009 Knut Franke (knut.franke*gmx.de)
    Copyright            : (C) 2006-2007 Ion Vasilief (ion_vasilief*yahoo.fr)
                           (replace * with @ in the email addresses) 

 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *  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; either version 2 of the License, or      *
 *  (at your option) any later version.                                    *
 *                                                                         *
 *  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., 51 Franklin Street, Fifth Floor,                    *
 *   Boston, MA  02110-1301  USA                                           *
 *                                                                         *
 ***************************************************************************/
#ifndef TABLE_H
#define TABLE_H

#include <QVarLengthArray>
#include <QDateTime>
#include <QHash>
#include <QMap>

#include "Graph.h"
#include "MyWidget.h"
#include "ScriptingEnv.h"
#include "Script.h"
#include "future/table/future_Table.h"
#include "future/table/TableView.h"
#include "globals.h"

class Table: public TableView, public scripted
{
    Q_OBJECT

public:
    future::Table *d_future_table;

    enum ColType{Numeric = 0, Text = 1, Date = 2, Time = 3, Month = 4, Day = 5, DateTime = 6}; // TODO: remove this in favor of SciDAVis::columnMode

    Table(ScriptingEnv *env, const QString &fname,const QString &sep, int ignoredLines, bool renameCols,
         bool stripSpaces, bool simplifySpaces, bool convertToNumeric, QLocale numericFormat, const QString &label,
         QWidget* parent=0, const char* name=0, Qt::WFlags f=0);
    Table(ScriptingEnv *env, int r,int c, const QString &label, QWidget* parent=0, const char* name=0, Qt::WFlags f=0);

    void setNumericPrecision(int prec);

    virtual QString name() { return d_future_table->name();} 
    virtual void setName(const QString& s) { d_future_table->setName(s); }
    virtual QString windowLabel() { return d_future_table->comment(); }
    virtual void setWindowLabel(const QString& s) { d_future_table->setComment(s); updateCaption(); }
    void setCaptionPolicy(CaptionPolicy policy) 
    { 
        caption_policy = policy; updateCaption(); 
        switch (policy)
        {
            case Name:
                d_future_table->setCaptionSpec("%n");
                break;
            case Label:
                d_future_table->setCaptionSpec("%c");
                break;
            case Both:
                d_future_table->setCaptionSpec("%n%C{ - }%c");
                break;
        }
    }
    virtual void setBirthDate(const QString& s)
    {
        birthdate = s;
        d_future_table->importV0x0001XXCreationTime(s);
    }

    void closeEvent( QCloseEvent *);
public slots:
    void copy(Table *m);
    int numRows();
    int numCols();
    int rowCount();
    int columnCount();
    void setNumRows(int rows);
    void setNumCols(int cols);
    void handleChange();
    void handleRowChange();
    void handleColumnChange(int,int);
    void handleColumnChange(int,int,int,int);
    void handleColumnsAboutToBeRemoved(int,int);
    void handleColumnsRemoved(int,int);

    Column* column(int index) const { return d_future_table->column(index); }

    Column* column(const QString & name) const { return d_future_table->column(name); }


    double cell(int row, int col);
    void setCell(int row, int col, double val);

    QString text(int row, int col);
    QStringList columnsList();
    QStringList colNames();
    QString colName(int col);
    QString colLabel(int col);
    int colIndex(const QString& name);

    SciDAVis::PlotDesignation colPlotDesignation(int col);
    void setColPlotDesignation(int col, SciDAVis::PlotDesignation d);
    void setPlotDesignation(SciDAVis::PlotDesignation pd);
    QList<int> plotDesignations();

    void setColName(int col,const QString& text);
    void setHeader(QStringList header);
    void importV0x0001XXHeader(QStringList header);
    void setText(int row,int col,const QString & text);

    void clearCell(int row, int col);

    void print();
    void print(const QString& fileName);
    void exportPDF(const QString& fileName);
    void customEvent(QEvent* e);


    void removeCol();
    void removeCol(const QStringList& list);
    void clearCol();
    void insertCol();
    void insertCols(int start, int count);
    void addCol(SciDAVis::PlotDesignation pd = SciDAVis::Y);
    void addColumns(int c);

    int firstXCol();
    bool noXColumn();
    bool noYColumn();
    int colX(int col);
    int colY(int col);

    void setCommands(const QStringList& com);
    void setCommands(const QString& com);
    void setCommand(int col, const QString& com);
    bool recalculate(int col, bool only_selected_rows=true);
    bool recalculate();


    void deleteSelectedRows();
    void insertRow();


    void cutSelection();
    void copySelection();
    void clearSelection();
    void pasteSelection();
    void selectAllTable();
    void deselect();
    void clear();

    void init();
    QStringList selectedColumns();
    QStringList selectedYColumns();
    QStringList selectedErrColumns();
    QMap<int, QString> selectedYLabels();
    QStringList drawableColumnSelection();
    QStringList YColumns();
    int selectedColsNumber();

    int columnWidth(int col);
    void setColWidths(const QStringList& widths);

    int numSelectedRows();

    int columnType(int col);

    QList<int> columnTypes();
    void setColumnTypes(QList<int> ctl);
    void setColumnTypes(const QStringList& ctl);
    void setColumnType(int col, SciDAVis::ColumnMode mode);


    QString columnFormat(int col);

    void importASCII(const QString &fname, const QString &sep, int ignoredLines,
            bool renameCols, bool stripSpaces, bool simplifySpaces, bool newTable);
    bool exportASCII(const QString& fname, const QString& separator,
            bool withLabels = false, bool exportSelection = false);


    virtual QString saveToString(const QString& geometry);
    void saveToDevice(QIODevice *device, const QString &geometry);
    QString saveHeader();
    QString saveComments();
    QString saveCommands();
    QString saveColumnWidths();
    QString saveColumnTypes();

    void setBackgroundColor(const QColor& col);
    void setTextColor(const QColor& col);
    void setHeaderColor(const QColor& col);
    void setTextFont(const QFont& fnt);
    void setHeaderFont(const QFont& fnt);

    int verticalHeaderWidth();

    QString colComment(int col);
    void setColComment(int col, const QString& s);
    QStringList colComments();
    void setColComments(const QStringList& lst);
    bool commentsEnabled();

    QString saveAsTemplate(const QString& geometryInfo);
    void restore(const QStringList& lst);

signals:
    void changedColHeader(const QString&, const QString&);
    void aboutToRemoveCol(const QString&);
    void removedCol(const QString&);
    void modifiedData(Table *, const QString&);
    void resizedTable(QWidget*);
    void showContextMenu(bool selection);

protected slots:
    void applyFormula();
    void addFunction();
    void addReference();
    void updateFunctionDoc();
    void handleAspectDescriptionChange(const AbstractAspect *aspect);
    void handleAspectDescriptionAboutToChange(const AbstractAspect *aspect);

private:
    QHash<const AbstractAspect *, QString> d_stored_column_labels;
};

#endif