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