koffice/kspread/valueformatter.h

/* This file is part of the KDE project
   Copyright 2004 Tomas Mecir <mecirt@gmail.com>

   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, or (at your option) any later version.

   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_VALUEFORMATTER
#define KSPREAD_VALUEFORMATTER

#include "kspread_format.h"

#include <tqdatetime.h>

namespace KSpread
{
class Cell;
class Value;
class ValueConverter;

/**
The ValueFormatter class generates a textual representation of
data stored in a Value, with a given formatting.
*/

class ValueFormatter {
 public:
  /** copnstructor */
  ValueFormatter (ValueConverter *converter);

  /** create a text representation of data in this cell */
  TQString formatText (Cell *cell, FormatType fmtType);

  /** create a text representation of data in this Value */
  TQString formatText (const Value &value,
      FormatType fmtType, int precision = -1,
      Format::FloatFormat floatFormat = Format::OnlyNegSigned,
      const TQString &prefix = TQString(),
      const TQString &postfix = TQString(),
      const TQString &currencySymbol = TQString());

  /** create a date format */
  TQString dateFormat (const TQDate &_date, FormatType fmtType);

  /** create a time format */
  TQString timeFormat (const TQDateTime &_time, FormatType fmtType);

 protected:

  ValueConverter* converter;

  /** determine the formatting type that should be used to format this value
  in a cell with a given format type */
  FormatType determineFormatting (const Value &value,
      FormatType fmtType);

  /** create a number format */
  TQString createNumberFormat (double value, int precision, FormatType fmt,
      bool alwaysSigned, const TQString& currencySymbol);

  /** create a fraction format */
  TQString fractionFormat (double value, FormatType fmtType);

  TQString errorFormat (Cell *cell);

  /** Remove trailing zeros and the decimal point if necessary
  unless the number has no decimal point */
  void removeTrailingZeros (TQString &str, TQChar decimal_point);
};


}  //namespace KSpread


#endif  //KSPREAD_VALUEFORMATTER