sc/source/ui/inc/prevloc.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <sal/types.h>
  23
  24 #include <address.hxx>
  25
  26 #include <vcl/mapmod.hxx>
  27 #include <vcl/vclptr.hxx>
  28 #include <tools/gen.hxx>
  29
  30 #include <memory>
  31 #include <list>
  32
  33 #define SC_PREVIEW_MAXRANGES    4
  34 #define SC_PREVIEW_RANGE_EDGE   0
  35 #define SC_PREVIEW_RANGE_REPCOL 1
  36 #define SC_PREVIEW_RANGE_REPROW 2
  37 #define SC_PREVIEW_RANGE_TAB    3
  38
  39 class OutputDevice;
  40 class ScDocument;
  41 struct ScPreviewLocationEntry;
  42
  43 struct ScPreviewColRowInfo
  44 {
  45     bool    bIsHeader;
  46     SCCOLROW    nDocIndex;
  47     tools::Long    nPixelStart;
  48     tools::Long    nPixelEnd;
  49
  50     void Set( bool bHeader, SCCOLROW nIndex, tools::Long nStart, tools::Long nEnd )
  51     {
  52         bIsHeader   = bHeader;
  53         nDocIndex   = nIndex;
  54         nPixelStart = nStart;
  55         nPixelEnd   = nEnd;
  56     }
  57 };
  58
  59 class ScPreviewTableInfo
  60 {
  61     SCTAB                   nTab;
  62     SCCOL                   nCols;
  63     SCROW                   nRows;
  64     std::unique_ptr<ScPreviewColRowInfo[]>
  65                             pColInfo;
  66     std::unique_ptr<ScPreviewColRowInfo[]>
  67                             pRowInfo;
  68
  69 public:
  70             ScPreviewTableInfo();
  71             ~ScPreviewTableInfo();
  72
  73     SCTAB                       GetTab() const      { return nTab; }
  74     SCCOL                       GetCols() const     { return nCols; }
  75     SCROW                       GetRows() const     { return nRows; }
  76     const ScPreviewColRowInfo*  GetColInfo() const  { return pColInfo.get(); }
  77     const ScPreviewColRowInfo*  GetRowInfo() const  { return pRowInfo.get(); }
  78
  79     void    SetTab( SCTAB nNewTab );
  80     void    SetColInfo( SCCOL nCount, ScPreviewColRowInfo* pNewInfo );
  81     void    SetRowInfo( SCROW nCount, ScPreviewColRowInfo* pNewInfo );
  82     void    LimitToArea( const tools::Rectangle& rPixelArea );
  83 };
  84
  85 class ScPreviewLocationData
  86 {
  87 public:
  88     typedef std::list<std::unique_ptr<ScPreviewLocationEntry>> Entries_t;
  89 private:
  90     VclPtr<OutputDevice> pWindow;
  91     ScDocument* pDoc;
  92     MapMode     aCellMapMode;
  93     MapMode     aDrawMapMode[SC_PREVIEW_MAXRANGES];
  94     tools::Rectangle   aDrawRectangle[SC_PREVIEW_MAXRANGES];
  95         sal_uInt8       aDrawRangeId[SC_PREVIEW_MAXRANGES];
  96     sal_uInt16      nDrawRanges;
  97     SCTAB       nPrintTab;
  98     Entries_t m_Entries;
  99
 100     tools::Rectangle   GetOffsetPixel( const ScAddress& rCellPos, const ScRange& rRange ) const;
 101
 102 public:
 103             ScPreviewLocationData( ScDocument* pDocument, OutputDevice* pWin );
 104             ~ScPreviewLocationData();
 105
 106     void    SetCellMapMode( const MapMode& rMapMode );
 107     void    SetPrintTab( SCTAB nNew );
 108     void    Clear();
 109     void    AddCellRange( const tools::Rectangle& rRect, const ScRange& rRange, bool bRepCol, bool bRepRow,
 110                             const MapMode& rDrawMap );
 111     void    AddColHeaders( const tools::Rectangle& rRect, SCCOL nStartCol, SCCOL nEndCol, bool bRepCol );
 112     void    AddRowHeaders( const tools::Rectangle& rRect, SCROW nStartRow, SCROW nEndRow, bool bRepRow );
 113     void    AddHeaderFooter( const tools::Rectangle& rRect, bool bHeader, bool bLeft );
 114     void    AddNoteMark( const tools::Rectangle& rRect, const ScAddress& rPos );
 115     void    AddNoteText( const tools::Rectangle& rRect, const ScAddress& rPos );
 116
 117     SCTAB   GetPrintTab() const     { return nPrintTab; }
 118
 119     //  Get info on visible columns/rows in the visible area
 120     void    GetTableInfo( const tools::Rectangle& rVisiblePixel, ScPreviewTableInfo& rInfo ) const;
 121
 122     sal_uInt16  GetDrawRanges() const   { return nDrawRanges; }
 123     void    GetDrawRange( sal_uInt16 nPos, tools::Rectangle& rPixelRect, MapMode& rMapMode, sal_uInt8& rRangeId ) const;
 124
 125     bool    GetHeaderPosition( tools::Rectangle& rHeaderRect ) const;
 126     bool    GetFooterPosition( tools::Rectangle& rFooterRect ) const;
 127     bool    IsHeaderLeft() const;
 128     bool    IsFooterLeft() const;
 129
 130     tools::Long    GetNoteCountInRange( const tools::Rectangle& rVisiblePixel, bool bNoteMarks ) const;
 131     bool    GetNoteInRange( const tools::Rectangle& rVisiblePixel, tools::Long nIndex, bool bNoteMarks,
 132                             ScAddress& rCellPos, tools::Rectangle& rNoteRect ) const;
 133     tools::Rectangle GetNoteInRangeOutputRect(const tools::Rectangle& rVisiblePixel, bool bNoteMarks,
 134                             const ScAddress& aCellPos) const;
 135
 136     //  Check if any cells (including column/row headers) are in the visible area
 137     bool    HasCellsInRange( const tools::Rectangle& rVisiblePixel ) const;
 138
 139     void    GetCellPosition( const ScAddress& rCellPos, tools::Rectangle& rCellRect ) const;
 140
 141     // returns the rectangle where the EditEngine draws the text of a Header Cell
 142     // if bColHeader is true it returns the rectangle of the header of the column in rCellPos
 143     // otherwise of the header of the row in rCellPos
 144     tools::Rectangle GetHeaderCellOutputRect(const tools::Rectangle& rVisRect, const ScAddress& rCellPos, bool bColHeader) const;
 145     tools::Rectangle GetCellOutputRect(const ScAddress& rCellPos) const;
 146
 147     // Query the range and rectangle of the main (non-repeat) cell range.
 148     // Returns sal_False if not contained.
 149     bool    GetMainCellRange( ScRange& rRange, tools::Rectangle& rPixRect ) const;
 150 };
 151
 152 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */