File indexing completed on 2024-05-12 16:36:07

 /* This file is part of the KDE project
    Copyright 2006-2007 Stefan Nikolaus <stefan.nikolaus@kdemail.net>
    Copyright 2004 Tomas Mecir <mecirt@gmail.com>
    Copyright 1999-2002,2004 Laurent Montel <montel@kde.org>
    Copyright 2002,2004 Ariya Hidayat <ariya@kde.org>
    Copyright 2002-2003 Norbert Andres <nandres@web.de>
    Copyright 2003 Stefan Hetzl <shetzl@chello.at>
    Copyright 2001-2002 Philipp Mueller <philipp.mueller@gmx.de>
    Copyright 2002 Harri Porten <porten@kde.org>
    Copyright 2002 John Dailey <dailey@vt.edu>
    Copyright 1999-2001 David Faure <faure@kde.org>
    Copyright 2000-2001 Werner Trobin <trobin@kde.org>
    Copyright 2000 Simon Hausmann <hausmann@kde.org
    Copyright 1998-1999 Torben Weis <weis@kde.org>
    Copyright 1999 Michael Reiher <michael.reiher@gmx.de>
    Copyright 1999 Reginald Stadlbauer <reggie@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; only
    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 CALLIGRA_SHEETS_CELL_VIEW
 #define CALLIGRA_SHEETS_CELL_VIEW
 
 // Qt
 #include <QExplicitlySharedDataPointer>
 
 // Sheets
 #include "Global.h"
 #include "Style.h"
 #include "sheets_common_export.h"
 
 class QFontMetricsF;
 class QRectF;
 
 namespace Calligra
 {
 namespace Sheets
 {
 class Cell;
 class Sheet;
 class SheetView;
 class Style;
 
 /**
  * \ingroup Painting
  * Responsible for the painting of Cell.
  * For each visible Cell exists a CellView, which is cached in the
  * corresponding SheetView. If the content of a Cell has changed, the CellView
  * will be destroyed and a new one will be created.
  */
 class CALLIGRA_SHEETS_COMMON_EXPORT CellView
 {
     friend class SheetView;
     friend class PixmapCachingSheetView;
 
 public:
     CellView(SheetView* sheetView, int col, int row);
     CellView(const CellView& other);
     virtual ~CellView();
     CellView& operator=(const CellView& other);
 
     enum Border {
         NoBorder     = 0x0,
         LeftBorder   = 0x1,
         RightBorder  = 0x2,
         TopBorder    = 0x4,
         BottomBorder = 0x8
     };
     Q_DECLARE_FLAGS(Borders, Border)
 
     /**
      * \return the style for the cell associated with this view
      */
     Style style() const;
 
     /**
      * Paints the cell's background.
      * \param painter the used painter
      * \param clipRegion the clip region
      * \param coordinate the top left coordinate (scroll offset dependent)
      */
     void paintCellBackground(QPainter& painter, const QRegion &clipRegion, const QPointF& coordinate) const;
 
     /**
      * Paints the cell.
      * \param paintRegion the portion of the canvas that is actually in view
      * \param painter the used painter
      * \param clipRegion the clip region
      * \param coordinate the top left coordinate (scroll offset dependent)
      * \param cell the Cell
      * \param sheetView the sheet view
      */
     virtual void paintCellContents(const QRectF& paintRegion, QPainter& painter, const QRegion &clipRegion,
                            const QPointF& coordinate,
                            const Cell& cell, SheetView* sheetView) const;
 
     /**
      * Paints the cell custom borders, the page borders, diagonal lines.
      * \param paintRegion the portion of the canvas that is actually in view
      * \param painter the used painter
      * \param clipRegion the clip region
      * \param coordinate the top left coordinate (scroll offset dependent)
      * \param cellRange the cell range, that is painted
      * \param cell the Cell
      * \param sheetView the SheetView
      */
     void paintCellBorders(const QRectF& paintRegion, QPainter& painter, const QRegion &clipRegion,
                           const QPointF& coordinate,
                           const QRect& cellRange,
                           const Cell& cell, SheetView* sheetView) const;
 
     /**
      * Paints the default cell borders.
      * \param painter the used painter
      * \param clipRegion the clip region
      * \param paintRegion the portion of the canvas that is actually in view
      * \param coordinate the painting coordinate
      * \param paintBorder the borders, that should be painted (should be removed???)
      * \param cellRange the cell range, that is painted
      * \param cell the Cell
      * \param sheetView the SheetView
      */
     void paintDefaultBorders(QPainter& painter, const QRegion &clipRegion, const QRectF &paintRegion,
                              const QPointF& coordinate,
                              Borders paintBorder, const QRect& cellRange,
                              const Cell& cell, SheetView* sheetView) const;
 
     /**
      * \return width of the text
      */
     qreal textWidth() const;
 
     /**
      * \return height of the text
      */
     qreal textHeight() const;
 
     /**
      * \return the rectangle the text covers
      */
     QRectF textRect() const;
 
     QString testAnchor(SheetView* sheetView, const Cell& cell, qreal x, qreal y) const;
 
     bool hitTestFilterButton(const Cell& cell, const QRect& cellRect, const QPoint& position) const;
 
     qreal cellHeight() const;
     qreal cellWidth() const;
 
     bool dimensionFits() const;
 
     void detach();
 protected:
     /**
      * \ingroup Layout
      * Calculates the layout of the cell.
      *
      * I.e. recalculates the text to be shown, its dimensions, its offset,
      * breaks lines of the text to fit it into the cell, obscures neighbouring
      * cells, if necessary.
      */
     void makeLayout(SheetView* sheetView, const Cell& cell);
 
     /**
      * \ingroup Layout
      * Determines the text offset relative to the cell's top left corner.
      *
      * This depends on the following variables:
      * \li horizontal alignment
      * \li vertical alignment
      * \li text angle
      * \li text direction (horizontal or vertical)
      * \li text width and height
      * \li single or multiple rows
      * \li cell width and height, including obscured cells
      * \li thickness of the border pens
      *
      * \internal Called from makeLayout().
      */
     void textOffset(const QFontMetricsF& fontMetrics, const Cell& cell);
 
     /**
      * \ingroup Layout
      * Determines the dimension of this cell including any merged cells.
      * Does NOT consider space, which is available from empty neighbours,
      * and would be able to be obscured.
      *
      * \internal Called from makeLayout().
      */
     void calculateCellDimension(const Cell& cell);
 
     /**
      * \ingroup Layout
      * Checks, whether horizontal neighbours could be obscured
      * and does so, if necessary.
      *
      * \internal Called from makeLayout().
      */
     void obscureHorizontalCells(SheetView* sheetView, const Cell& cell);
 
     /**
      * \ingroup Layout
      * Checks, whether vertical neighbours could be obscured
      * and does so, if necessary.
      *
      * \internal Called from makeLayout().
      */
     void obscureVerticalCells(SheetView* sheetView, const Cell& cell);
 
     /**
      * Adjust the output text, so that it only holds the part that can be
      * displayed. The altered text is only temporary stored. It is restored
      * after the paint event has been processed.
      *
      * This depends on the following variables:
      * \li horizontal alignment
      * \li value format
      * \li text direction (horizontal or vertical)
      * \li indentation
      *
      * \internal Called from paintText().
      */
     QString textDisplaying(const QFontMetricsF& fontMetrics, const Cell& cell);
 
     /**
      * helper function for paintCell() function
      * @see paintCell()
      * @internal
      */
     void paintCustomBorders(QPainter& painter, const QRectF &paintRegion,
                             const QPointF& coordinate, Borders paintBorder,
                             bool rtl) const;
 
     /**
      * helper function for paintCell() function
      * @see paintCell()
      * @internal
      */
     void paintPageBorders(QPainter& painter, const QPointF &coordinate,
                           Borders paintBorder, const Cell& cell) const;
 
     /**
      * helper function for paintCell() function
      * @see paintCell()
      * @internal
      */
     void paintText(QPainter& painter, const QPointF& coordinate, const Cell& cell) const;
 
     /**
      * helper function for paintCell() function
      * @see paintCell()
      * @internal
      */
     void paintMoreTextIndicator(QPainter& painter, const QPointF& coordinate) const;
 
     /**
      * helper function for paintCell() function
      * @see paintCell()
      * @internal
      */
     void paintCommentIndicator(QPainter& painter, const QPointF& coordinate,
                                const Cell& cell) const;
 
     /**
      * helper function for paintCell() function
      * @see paintCell()
      * @internal
      */
     void paintFormulaIndicator(QPainter& painter, const QPointF& coordinate, const Cell& cell) const;
 
     /**
      * helper function for paintCell() function
      * @see paintCell()
      * @internal
      */
     void paintMatrixElementIndicator(QPainter& painter, const QPointF& coordinate, const Cell& cell) const;
 
     /**
      * helper function for paintCell() function
      * @see paintCell()
      * @internal
      */
     void paintCellDiagonalLines(QPainter& painter, const QPointF& coordinate) const;
 
     /**
      * helper function for paintCell() function
      * @see paintCell()
      * @internal
      */
     void paintFilterButton(QPainter& painter, const QPointF& coordinate,
                            const Cell& cell, SheetView* sheetView) const;
 
     void drawText(QPainter& painter, const QPointF& location, const QStringList& textLines,
                   const Cell& cell, qreal lineSpacing = 0) const;
 
     /**
      * Default CellView used by SheetView.
      */
     CellView(SheetView* sheetView);
 
     class Private;
     QExplicitlySharedDataPointer<Private> d;
 };
 
 Q_DECLARE_OPERATORS_FOR_FLAGS(CellView::Borders)
 
 } // namespace Sheets
 } // namespace Calligra
 
 Q_DECLARE_TYPEINFO(Calligra::Sheets::CellView, Q_MOVABLE_TYPE);
 
 #endif