sc/inc/detfunc.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 #ifndef INCLUDED_SC_INC_DETFUNC_HXX
  21 #define INCLUDED_SC_INC_DETFUNC_HXX
  22
  23 #include "address.hxx"
  24 #include <tools/gen.hxx>
  25 #include <tools/color.hxx>
  26 #include "scdllapi.h"
  27 #include "token.hxx"
  28
  29 #include <vector>
  30
  31 class SdrObject;
  32
  33 class ScDetectiveData;
  34 class ScDocument;
  35 class ScAddress;
  36 class ScRange;
  37
  38 #define SC_DET_MAXCIRCLE    1000
  39
  40 enum ScDetectiveDelete { SC_DET_ALL, SC_DET_DETECTIVE, SC_DET_CIRCLES, SC_DET_ARROWS };
  41
  42 enum ScDetectiveObjType
  43 {
  44     SC_DETOBJ_NONE,
  45     SC_DETOBJ_ARROW,
  46     SC_DETOBJ_FROMOTHERTAB,
  47     SC_DETOBJ_TOOTHERTAB,
  48     SC_DETOBJ_CIRCLE
  49 };
  50
  51 class SC_DLLPUBLIC ScDetectiveFunc
  52 {
  53     static ColorData nArrowColor;
  54     static ColorData nErrorColor;
  55     static ColorData nCommentColor;
  56     static bool      bColorsInitialized;
  57
  58     ScDocument*     pDoc;
  59     SCTAB           nTab;
  60
  61     enum DrawPosMode
  62     {
  63         DRAWPOS_TOPLEFT,        ///< Top-left edge of the cell.
  64         DRAWPOS_BOTTOMRIGHT,    ///< Bottom-right edge of the cell.
  65         DRAWPOS_DETARROW,       ///< Position inside cell for detective arrows.
  66         DRAWPOS_CAPTIONLEFT,    ///< Top-left edge of the cell for captions.
  67         DRAWPOS_CAPTIONRIGHT    ///< Top-right edge of the cell for captions (incl. merged cells).
  68     };
  69
  70     /** @return a drawing layer position for the passed cell address. */
  71     Point       GetDrawPos( SCCOL nCol, SCROW nRow, DrawPosMode eMode ) const;
  72
  73     /** @return the drawing layer rectangle for the passed cell range. */
  74     Rectangle   GetDrawRect( SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2 ) const;
  75
  76     /** @return the drawing layer rectangle for the passed cell address. */
  77     Rectangle   GetDrawRect( SCCOL nCol, SCROW nRow ) const;
  78
  79     bool        HasArrow( const ScAddress& rStart,
  80                             SCCOL nEndCol, SCROW nEndRow, SCTAB nEndTab );
  81
  82     void        DeleteArrowsAt( SCCOL nCol, SCROW nRow, bool bDestPnt );
  83     void        DeleteBox( SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2 );
  84
  85     bool        HasError( const ScRange& rRange, ScAddress& rErrPos );
  86
  87                 /// called from DrawEntry/DrawAlienEntry and InsertObject
  88     bool        InsertArrow( SCCOL nCol, SCROW nRow,
  89                                 SCCOL nRefStartCol, SCROW nRefStartRow,
  90                                 SCCOL nRefEndCol, SCROW nRefEndRow,
  91                                 bool bFromOtherTab, bool bRed,
  92                                 ScDetectiveData& rData );
  93     bool        InsertToOtherTab( SCCOL nStartCol, SCROW nStartRow,
  94                                 SCCOL nEndCol, SCROW nEndRow, bool bRed,
  95                                 ScDetectiveData& rData );
  96
  97                 /// DrawEntry / DrawAlienEntry check for existing arrows and errors
  98     bool        DrawEntry( SCCOL nCol, SCROW nRow, const ScRange& rRef,
  99                                 ScDetectiveData& rData );
 100     bool        DrawAlienEntry( const ScRange& rRef,
 101                                 ScDetectiveData& rData );
 102
 103     void        DrawCircle( SCCOL nCol, SCROW nRow, ScDetectiveData& rData );
 104
 105     sal_uInt16      InsertPredLevel( SCCOL nCol, SCROW nRow, ScDetectiveData& rData, sal_uInt16 nLevel );
 106     sal_uInt16      InsertPredLevelArea( const ScRange& rRef,
 107                                         ScDetectiveData& rData, sal_uInt16 nLevel );
 108     sal_uInt16      FindPredLevel( SCCOL nCol, SCROW nRow, sal_uInt16 nLevel, sal_uInt16 nDeleteLevel );
 109     sal_uInt16      FindPredLevelArea( const ScRange& rRef,
 110                                     sal_uInt16 nLevel, sal_uInt16 nDeleteLevel );
 111
 112     sal_uInt16      InsertErrorLevel( SCCOL nCol, SCROW nRow, ScDetectiveData& rData, sal_uInt16 nLevel );
 113
 114     sal_uInt16      InsertSuccLevel( SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2,
 115                                         ScDetectiveData& rData, sal_uInt16 nLevel );
 116     sal_uInt16      FindSuccLevel( SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2,
 117                                 sal_uInt16 nLevel, sal_uInt16 nDeleteLevel );
 118
 119     void        FindFrameForObject( SdrObject* pObject, ScRange& rRange );
 120
 121     void        Modified();
 122
 123 public:
 124                 ScDetectiveFunc(ScDocument* pDocument, SCTAB nTable) : pDoc(pDocument),nTab(nTable) {}
 125
 126     bool        ShowSucc( SCCOL nCol, SCROW nRow );
 127     bool        ShowPred( SCCOL nCol, SCROW nRow );
 128     bool        ShowError( SCCOL nCol, SCROW nRow );
 129
 130     bool        DeleteSucc( SCCOL nCol, SCROW nRow );
 131     bool        DeletePred( SCCOL nCol, SCROW nRow );
 132     bool        DeleteAll( ScDetectiveDelete eWhat );
 133
 134     bool        MarkInvalid(bool& rOverflow);
 135
 136     void        GetAllPreds(SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2, ::std::vector<ScTokenRef>& rRefTokens);
 137     void        GetAllSuccs(SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2, ::std::vector<ScTokenRef>& rRefTokens);
 138
 139     static void UpdateAllComments( ScDocument& rDoc );        ///< on all tables
 140     void        UpdateAllArrowColors();     ///< on all tables
 141
 142     static bool IsNonAlienArrow( SdrObject* pObject );
 143
 144     ScDetectiveObjType GetDetectiveObjectType( SdrObject* pObject, SCTAB nObjTab,
 145                                 ScAddress& rPosition, ScRange& rSource, bool& rRedLine );
 146     void        InsertObject( ScDetectiveObjType eType, const ScAddress& rPosition,
 147                                 const ScRange& rSource, bool bRedLine );
 148
 149     static ColorData GetArrowColor();
 150     static ColorData GetErrorColor();
 151     static ColorData GetCommentColor();
 152     static void InitializeColors();
 153     static bool IsColorsInitialized();
 154     static void AppendChangTrackNoteSeparator(OUString &str);
 155 };
 156
 157 #endif
 158
 159 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */