selection.h

/* This file is part of the KDE project
   Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
   Copyright (C) 2005-2006 Stefan Nikolaus <stefan.nikolaus@kdemail.net>
 
   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_SELECTION
#define KSPREAD_SELECTION
 
#include <tqobject.h>
 
#include <kdebug.h>
 
#include "region.h"
 
namespace KSpread
{
class View;
 
class Selection : public TQObject, public Region
{
  TQ_OBJECT
  
public:
  Selection(View*);
  Selection(const Selection&);
  ~Selection();

  void initialize(const TQPoint&, Sheet* sheet = 0);
  void initialize(const TQRect&, Sheet* sheet = 0);
  void initialize(const Region&, Sheet* sheet = 0);

  void update();
  void update(const TQPoint&);

  void extend(const TQPoint&, Sheet* sheet = 0);
  void extend(const TQRect&, Sheet* sheet = 0);
  void extend(const Region&);

  virtual Element* eor(const TQPoint& point, Sheet* sheet = 0);

  const TQPoint& anchor() const;
  const TQPoint& cursor() const;
  const TQPoint& marker() const;

  bool isSingular() const;
  TQRect selectionHandleArea() const;

  TQString name(Sheet* originSheet = 0) const;

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

  void setActiveElement(const TQPoint& point);
  void setActiveElement(uint number);
  Element* activeElement() const;
  void setActiveSubRegion(uint start, uint length);
  TQString activeSubRegionName() const;
  void clearSubRegion();
  void fixSubRegionDimension();
  virtual void clear();
 

  void setMultipleSelection(bool state);
 
  TQRect lastRange(bool extend = true) const;
  TQRect extendToMergedAreas(TQRect area) const;
 
  const TQValueList<TQColor>& colors() const;
 
  // TODO Stefan #2: replace this
  TQRect selection(bool extend = true) const;
 
signals:
  void changed(const Region&);
 
protected:
  class Point;
  class Range;
 
  virtual Region::Point* createPoint(const TQPoint&) const;
  virtual Region::Point* createPoint(const TQString&) const;
  virtual Region::Point* createPoint(const Point&) const;
  virtual Region::Range* createRange(const TQRect&) const;
  virtual Region::Range* createRange(const TQString&) const;
  virtual Region::Range* createRange(const Range&) const;
 
private:
  class Private;
  Private *d;
};
 
/***************************************************************************
  class Selection::Point
****************************************************************************/
 
class Selection::Point : public Region::Point
{
public:
  Point(const TQPoint& point);
  Point(const TQString& string);
 
  void setColor(const TQColor& color) { m_color = color; }
  virtual const TQColor& color() const { return m_color; }
 
  bool columnFixed() const { return m_columnFixed; }
  bool rowFixed() const { return m_rowFixed; }
 
protected:
 
private:
  TQColor m_color;
  bool m_columnFixed : 1;
  bool m_rowFixed    : 1;
};
 
/***************************************************************************
  class Selection::Range
****************************************************************************/
 
class Selection::Range : public Region::Range
{
public:
  Range(const TQRect& rect);
  Range(const TQString& string);
 
  virtual bool isColorizable() const { return true; }
 
  void setColor(const TQColor& color) { m_color = color; }
  const TQColor& color() const { return m_color; }
 
protected:
 
private:
  TQColor m_color;
  bool m_leftFixed   : 1;
  bool m_rightFixed  : 1;
  bool m_topFixed    : 1;
  bool m_bottomFixed : 1;
};
 
} // namespace KSpread
 
 
/***************************************************************************
  kdDebug support
****************************************************************************/
 
inline kdbgstream operator<<( kdbgstream str, const KSpread::Selection& s )
{
  str << "Selection = " << s.name();
  return str;
}
 
inline kndbgstream operator<<( kndbgstream str, const KSpread::Selection& )
{
  return str;
}
 
#endif // KSPREAD_SELECTION