kspread_util.h

/* This file is part of the KDE project
   Copyright (C) 2006 Stefan Nikolaus <stefan.nikolaus@kdemail.net>
   Copyright (C) 1998, 1999 Torben Weis <weis@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, 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_util_h__
#define __kspread_util_h__
 
#include <tqstring.h>
#include <tqrect.h>
#include <tqdatetime.h>
 
#include <koffice_export.h>
 
#include "kspread_global.h"
#include "kspread_value.h"
 
class TQFont;
class TQPen;
class TQDomElement;
class TQDomDocument;
 
class TDELocale;
 
bool util_isPointValid(TQPoint point);
bool util_isRectValid(TQRect rect);
 
namespace KSpread
{
class Cell;
class Map;
class Sheet;

class KSPREAD_EXPORT Point
{
public:
  Point() { _pos.setX( -1 ); _sheet = 0; _columnFixed = false; _rowFixed = false; }
  Point( const TQString& );
  Point( const TQString&, Map*, Sheet* default_sheet = 0 );
  Point( const Point& c ) {
    _pos = c._pos;
    _sheet = c._sheet;
    _sheetName = c._sheetName;
    _columnFixed = c._columnFixed;
    _rowFixed = c._rowFixed;
  }
 
  bool isValid() const { return ( util_isPointValid(pos()) && ( _sheet != 0 || _sheetName.isEmpty() ) ); }
  bool isSheetKnown() const { return ( ! _sheetName.isEmpty() && _sheet != 0 ); }
 
  Cell* cell() const;
 
  bool operator== (const Point &cell) const;
  bool operator< (const Point &cell) const;
 
  int row () const { return _pos.y(); };
  int column () const { return _pos.x(); };
  void setRow (int r) { _pos.setY (r); };
  void setColumn (int c) { _pos.setX (c); };

  void      setSheet(Sheet* sheet);
  Sheet*    sheet() const;

  void      setSheetName(TQString name);
  TQString   sheetName() const;

  void      setPos(TQPoint pos);
  TQPoint    pos() const;

  void      setColumnFixed(bool colFixed);
  bool      columnFixed() const;

  void      setRowFixed(bool rowFixed);
  bool      rowFixed() const;
 
 
private:
  Sheet* _sheet;
  TQString _sheetName;
  TQPoint _pos;
  bool _columnFixed;
  bool _rowFixed;
 
private:
  void init( const TQString& );
};

class KSPREAD_EXPORT Range
{
public:
  Range();
 
  Range( const TQString& );
  Range( const TQString&, Map*, Sheet* default_sheet = 0 );
  Range( const Range& r );
  Range( const Point& ul, const Point& lr );

  bool isValid() const;

  bool isSheetKnown() const { return ( !sheetName().isEmpty() && sheet() != 0 ); }

  void getStartPoint(Point* pt);
  void getEndPoint(Point* pt);
 
  int startRow () const { return range().top(); };
  int startCol () const { return range().left(); };
  int endRow () const { return range().bottom(); };
  int endCol () const { return range().right(); };

  virtual void setRange(const TQRect& newRange) {_range=newRange;}
 
  void setRange(int newStartCol, int newStartRow, int newEndCol, int newEndRow)
  { _range=TQRect(newStartCol,newStartRow,newEndCol-newStartCol,newEndRow-newStartRow); }

  TQRect range() const;

  bool contains (const Point &cell) const;
  bool intersects (const Range &r) const;

  TQString toString() const;

  void setLeftFixed(bool fixed);
  bool leftFixed() const;

  void setRightFixed(bool fixed);
  bool rightFixed() const;

  void setTopFixed(bool fixed);
  bool topFixed() const;

  void setBottomFixed(bool fixed);
  bool bottomFixed() const;

  void setSheet(Sheet* sheet);
  Sheet* sheet() const;

  void setSheetName(TQString sheetName);
  TQString sheetName() const;

  TQString namedArea() const;

  bool operator==(const Range& range) const;
 
 
private:
  Sheet* _sheet;
  TQString _sheetName;
  TQString _namedArea;
  TQRect _range;
  bool _leftFixed;
  bool _rightFixed;
  bool _topFixed;
  bool _bottomFixed;
};

struct RangeList {
  TQValueList<Point> cells;
  TQValueList<Range> ranges;
};
 

class RangeIterator
{
public:
  RangeIterator(TQRect _range, Sheet* _sheet);
  ~RangeIterator();

  Cell* first();

  Cell* next();
private:
 
  TQRect range;
  Sheet* sheet;
  TQPoint current;
};
 
//helper functions for the formatting
bool formatIsDate (FormatType fmt);
bool formatIsTime (FormatType fmt);
bool formatIsFraction (FormatType fmt);
 
 
 
KSPREAD_EXPORT TQString util_rangeName( const TQRect &_area );
KSPREAD_EXPORT TQString util_rangeName( Sheet *_sheet, const TQRect &_area );
TQString util_rangeColumnName( const TQRect &_area);
TQString util_rangeRowName( const TQRect &_area);

KSPREAD_EXPORT int util_decodeColumnLabelText( const TQString &_col );
KSPREAD_EXPORT TQString util_encodeColumnLabelText( int column );
 
bool util_isAllSelected(const TQRect &selection);
bool util_isColumnSelected(const TQRect &selection);
bool util_isRowSelected(const TQRect &selection);
bool util_isRowOrColumnSelected( const TQRect &selection );
 
 
 
bool util_validateSheetName(const TQString &name);
 
TQDomElement util_createElement( const TQString & tagName, const TQFont & font, TQDomDocument & doc );
TQDomElement util_createElement( const TQString & tagname, const TQPen & pen, TQDomDocument & doc );
TQFont       util_toFont( TQDomElement & element );
TQPen        util_toPen( TQDomElement & element );
int         util_penCompare( TQPen const & pen1, TQPen const & pen2 );
 
TQString convertRefToRange( const TQString & sheet, const TQRect & rect );
TQString convertRefToBase( const TQString & sheet, const TQRect & rect );
TQString convertRangeToRef( const TQString & sheetName, const TQRect & _area );
 
void insertBracket( TQString & s );
TQString convertOasisPenToString( const TQPen & pen );
TQPen convertOasisStringToPen( const TQString &str );
 
//Return true when it's a reference to cell from sheet.
KSPREAD_EXPORT bool localReferenceAnchor( const TQString &_ref );
 
 
 
namespace Oasis
{
  // TODO check visibility
  KSPREAD_EXPORT TQString decodeFormula(const TQString& expr, const TDELocale* locale = 0);
  KSPREAD_EXPORT TQString encodeFormula(const TQString& expr, const TDELocale* locale = 0);
}
 
} // namespace KSpread
 
#endif