kspread_value.h

/* This file is part of the KDE project
   Copyright (C) 2003,2004 Ariya Hidayat <ariya@kde.org>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License.
 
   This library 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
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
*/
 
#ifndef KSPREAD_VALUE_H
#define KSPREAD_VALUE_H
 
#include <tqdatetime.h>
#include <tqstring.h>
#include <tqtextstream.h>
 
#include <koffice_export.h>
 
namespace KSpread
{
class ValueData;
 
class KSPREAD_EXPORT Value
{
 
  public:
 
    typedef enum {
      Empty,
      Boolean,
      Integer,
      Float,
      String,
      Array,
      CellRange, // not used yet
      Error
    } Type;
 
    typedef enum {
      fmt_None,
      fmt_Boolean,
      fmt_Number,
      fmt_Percent,
      fmt_Money,
      fmt_DateTime,
      fmt_Date,
      fmt_Time,
      fmt_String
    } Format;
    Value();
 
    Value( Type _type );
 
    virtual ~Value();
 
    Value( const Value& _value );
 
    Value& operator= ( const Value& _value );
 
    Value& assign( const Value& _value );
 
    Value( bool b );
 
    Value( long i );
 
    Value( int i );
 
    Value( double f );
 
    Value( const TQString& s );
 
    Value (const char *s);
    Value( const TQDateTime& dt );
 
    Value( const TQTime& time );
 
    Value( const TQDate& date );
 
    Value( unsigned columns, unsigned rows );
 
    Type type() const;
 
    Format format() const;
 
    bool isEmpty() const { return type() == Empty; }
 
    bool isBoolean() const { return type() == Boolean; }
 
    bool isInteger() const { return type() == Integer; }
 
    bool isFloat() const { return type() == Float; }
 
    bool isNumber() const { return (type() == Integer) || (type() == Float); }
 
    bool isString() const { return type() == String; }
 
    bool isArray() const { return type() == Array; }
 
    bool isError() const { return type() == Error; }
 
    void setValue( const Value& v );
 
    void setValue( bool b );
 
    void setValue( long i );
 
    void setValue( int i );
 
    void setValue( double f );
 
    void setValue( const TQString& s );
 
    void setError( const TQString& msg );
 
    void setValue( const TQDateTime& dt );
 
    void setValue( const TQTime& dt );
 
    void setValue( const TQDate& dt );
 
    void setFormat (Format fmt);
 
    bool asBoolean() const;
 
    long asInteger() const;
 
    double asFloat() const;
 
    TQString asString() const;
 
    TQDateTime asDateTime() const;
 
    TQDate asDate() const;
 
    TQTime asTime() const;
 
    Value element( unsigned column, unsigned row ) const;
 
    void setElement( unsigned column, unsigned row, const Value& value );
 
    unsigned columns() const;
 
    unsigned rows() const;
 
    TQString errorMessage() const;
 
    void detach();
 
    static const Value& empty();
 
    static const Value& errorDIV0();
 
    static const Value& errorNA();
 
    static const Value& errorNAME();
 
    static const Value& errorNUM();
 
    static const Value& errorNULL();
 
    static const Value& errorREF();
 
    static const Value& errorVALUE();
 
    bool allowComparison( const Value& v ) const;
    
    int compare( const Value& v ) const;
 
    bool equal( const Value& v ) const;
 
    bool less( const Value& v ) const;
 
    bool greater( const Value& v ) const;
 
    // comparison operator - returns true only if strictly identical, unlike equal()/compare()
    bool operator==( const Value& v ) const;
    inline bool operator!=( const Value& other ) const { return !operator==( other ); }
 
    static int compare( double v1, double v2 );
    
    bool isZero() const;
    
    static bool isZero( double v );
      
  protected:
 
    ValueData* d; // can't never be 0
};
 
} // namespace KSpread
 
TQTextStream& operator<<( TQTextStream& ts, KSpread::Value::Type type );
TQTextStream& operator<<( TQTextStream& ts, KSpread::Value value );
 
#endif // KSPREAD_VALUE_H