sc/inc/attarray.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: attarray.hxx,v $
  10  * $Revision: 1.9.32.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SC_ATRARR_HXX
  32 #define SC_ATRARR_HXX
  33
  34 #include "global.hxx"
  35 #include "attrib.hxx"
  36
  37 class ScDocument;
  38 class ScEditDataArray;
  39 class ScMarkArray;
  40 class ScPatternAttr;
  41 class ScStyleSheet;
  42 class ScFlatBoolRowSegments;
  43
  44 class Rectangle;
  45 class SfxItemPoolCache;
  46 class SfxStyleSheetBase;
  47 class SvxBorderLine;
  48 class SvxBoxItem;
  49 class SvxBoxInfoItem;
  50
  51 #define SC_LINE_EMPTY                   0
  52 #define SC_LINE_SET                             1
  53 #define SC_LINE_DONTCARE                2
  54
  55 #define SC_ATTRARRAY_DELTA      4
  56
  57 struct ScLineFlags
  58 {
  59         BYTE    nLeft;
  60         BYTE    nRight;
  61         BYTE    nTop;
  62         BYTE    nBottom;
  63         BYTE    nHori;
  64         BYTE    nVert;
  65
  66         ScLineFlags() : nLeft(SC_LINE_EMPTY),nRight(SC_LINE_EMPTY),nTop(SC_LINE_EMPTY),
  67                                         nBottom(SC_LINE_EMPTY),nHori(SC_LINE_EMPTY),nVert(SC_LINE_EMPTY) {}
  68 };
  69
  70 struct ScMergePatternState
  71 {
  72     SfxItemSet* pItemSet;           // allocated in MergePatternArea, used for resulting ScPatternAttr
  73     const ScPatternAttr* pOld1;     // existing objects, temporary
  74     const ScPatternAttr* pOld2;
  75
  76     ScMergePatternState() : pItemSet(NULL), pOld1(NULL), pOld2(NULL) {}
  77 };
  78
  79 struct ScAttrEntry
  80 {
  81         SCROW                                   nRow;
  82         const ScPatternAttr*    pPattern;
  83 };
  84
  85
  86 class ScAttrArray
  87 {
  88 private:
  89         SCCOL                   nCol;
  90         SCTAB                   nTab;
  91         ScDocument*             pDocument;
  92
  93         SCSIZE                  nCount;
  94     SCSIZE          nLimit;
  95         ScAttrEntry*    pData;
  96
  97 friend class ScDocument;                                // fuer FillInfo
  98 friend class ScDocumentIterator;
  99 friend class ScAttrIterator;
 100 friend class ScHorizontalAttrIterator;
 101 friend void lcl_IterGetNumberFormat( ULONG& nFormat,
 102                 const ScAttrArray*& rpArr, SCROW& nAttrEndRow,
 103                 const ScAttrArray* pNewArr, SCROW nRow, ScDocument* pDoc );
 104
 105         BOOL    ApplyFrame( const SvxBoxItem* pLineOuter, const SvxBoxInfoItem* pLineInner,
 106                                                         SCROW nStartRow, SCROW nEndRow,
 107                                                         BOOL bLeft, SCCOL nDistRight, BOOL bTop, SCROW nDistBottom );
 108
 109     void RemoveCellCharAttribs( SCROW nStartRow, SCROW nEndRow,
 110                               const ScPatternAttr* pPattern, ScEditDataArray* pDataArray );
 111
 112 public:
 113                         ScAttrArray( SCCOL nNewCol, SCTAB nNewTab, ScDocument* pDoc );
 114                         ~ScAttrArray();
 115
 116         void    SetTab(SCTAB nNewTab)   { nTab = nNewTab; }
 117         void    SetCol(SCCOL nNewCol)   { nCol = nNewCol; }
 118
 119         void    TestData() const;
 120         void    Reset( const ScPatternAttr* pPattern, BOOL bAlloc = TRUE );
 121         BOOL    Concat(SCSIZE nPos);
 122
 123         const ScPatternAttr* GetPattern( SCROW nRow ) const;
 124         const ScPatternAttr* GetPatternRange( SCROW& rStartRow, SCROW& rEndRow, SCROW nRow ) const;
 125         void    MergePatternArea( SCROW nStartRow, SCROW nEndRow, ScMergePatternState& rState, BOOL bDeep ) const;
 126
 127         void    MergeBlockFrame( SvxBoxItem* pLineOuter, SvxBoxInfoItem* pLineInner, ScLineFlags& rFlags,
 128                                                         SCROW nStartRow, SCROW nEndRow, BOOL bLeft, SCCOL nDistRight ) const;
 129         void    ApplyBlockFrame( const SvxBoxItem* pLineOuter, const SvxBoxInfoItem* pLineInner,
 130                                                         SCROW nStartRow, SCROW nEndRow, BOOL bLeft, SCCOL nDistRight );
 131
 132         void    SetPattern( SCROW nRow, const ScPatternAttr* pPattern, BOOL bPutToPool = FALSE );
 133         void    SetPatternArea( SCROW nStartRow, SCROW nEndRow, const ScPatternAttr* pPattern,
 134                             BOOL bPutToPool = FALSE, ScEditDataArray* pDataArray = NULL );
 135         void    ApplyStyleArea( SCROW nStartRow, SCROW nEndRow, ScStyleSheet* pStyle );
 136         void    ApplyCacheArea( SCROW nStartRow, SCROW nEndRow, SfxItemPoolCache* pCache,
 137                             ScEditDataArray* pDataArray = NULL );
 138         void    ApplyLineStyleArea( SCROW nStartRow, SCROW nEndRow,
 139                                                                 const SvxBorderLine* pLine, BOOL bColorOnly );
 140
 141         void    ClearItems( SCROW nStartRow, SCROW nEndRow, const USHORT* pWhich );
 142         void    ChangeIndent( SCROW nStartRow, SCROW nEndRow, BOOL bIncrement );
 143
 144             /// Including current, may return -1
 145         SCsROW  GetNextUnprotected( SCsROW nRow, BOOL bUp ) const;
 146
 147             /// May return -1 if not found
 148         SCsROW  SearchStyle( SCsROW nRow, const ScStyleSheet* pSearchStyle,
 149                                                         BOOL bUp, ScMarkArray* pMarkArray = NULL );
 150         BOOL    SearchStyleRange( SCsROW& rRow, SCsROW& rEndRow, const ScStyleSheet* pSearchStyle,
 151                                                         BOOL bUp, ScMarkArray* pMarkArray = NULL );
 152
 153         BOOL    ApplyFlags( SCROW nStartRow, SCROW nEndRow, INT16 nFlags );
 154         BOOL    RemoveFlags( SCROW nStartRow, SCROW nEndRow, INT16 nFlags );
 155
 156         BOOL    Search( SCROW nRow, SCSIZE& nIndex ) const;
 157
 158         BOOL    HasLines( SCROW nRow1, SCROW nRow2, Rectangle& rSizes,
 159                                                 BOOL bLeft, BOOL bRight ) const;
 160         BOOL    HasAttrib( SCROW nRow1, SCROW nRow2, USHORT nMask ) const;
 161         BOOL    ExtendMerge( SCCOL nThisCol, SCROW nStartRow, SCROW nEndRow,
 162                                                                 SCCOL& rPaintCol, SCROW& rPaintRow,
 163                                                                 BOOL bRefresh, BOOL bAttrs );
 164         BOOL    RemoveAreaMerge( SCROW nStartRow, SCROW nEndRow );
 165
 166         void    FindStyleSheet( const SfxStyleSheetBase* pStyleSheet, ScFlatBoolRowSegments& rUsedRows, bool bReset );
 167         BOOL    IsStyleSheetUsed( const ScStyleSheet& rStyle, BOOL bGatherAllStyles ) const;
 168
 169         void    DeleteAreaSafe(SCROW nStartRow, SCROW nEndRow);
 170         void    SetPatternAreaSafe( SCROW nStartRow, SCROW nEndRow,
 171                                                                         const ScPatternAttr* pWantedPattern, BOOL bDefault );
 172         void    CopyAreaSafe( SCROW nStartRow, SCROW nEndRow, long nDy, ScAttrArray& rAttrArray );
 173
 174         BOOL    IsEmpty() const;
 175
 176 //UNUSED2008-05  SCROW  GetFirstEntryPos() const;
 177 //UNUSED2008-05  SCROW  GetLastEntryPos( BOOL bIncludeBottom ) const;
 178
 179     BOOL    GetFirstVisibleAttr( SCROW& rFirstRow ) const;
 180     BOOL    GetLastVisibleAttr( SCROW& rLastRow, SCROW nLastData ) const;
 181         BOOL    HasVisibleAttrIn( SCROW nStartRow, SCROW nEndRow ) const;
 182         BOOL    IsVisibleEqual( const ScAttrArray& rOther,
 183                                                         SCROW nStartRow, SCROW nEndRow ) const;
 184         BOOL    IsAllEqual( const ScAttrArray& rOther, SCROW nStartRow, SCROW nEndRow ) const;
 185
 186         BOOL    TestInsertCol( SCROW nStartRow, SCROW nEndRow) const;
 187         BOOL    TestInsertRow( SCSIZE nSize ) const;
 188         void    InsertRow( SCROW nStartRow, SCSIZE nSize );
 189         void    DeleteRow( SCROW nStartRow, SCSIZE nSize );
 190         void    DeleteRange( SCSIZE nStartIndex, SCSIZE nEndIndex );
 191         void    DeleteArea( SCROW nStartRow, SCROW nEndRow );
 192         void    MoveTo( SCROW nStartRow, SCROW nEndRow, ScAttrArray& rAttrArray );
 193         void    CopyArea( SCROW nStartRow, SCROW nEndRow, long nDy, ScAttrArray& rAttrArray,
 194                                                 INT16 nStripFlags = 0 );
 195
 196         void    DeleteHardAttr( SCROW nStartRow, SCROW nEndRow );
 197
 198 //UNUSED2008-05  void    ConvertFontsAfterLoad();     // old binary file format
 199 };
 200
 201
 202 //      ------------------------------------------------------------------------------
 203 //                                                              Iterator fuer Attribute
 204 //      ------------------------------------------------------------------------------
 205
 206 class ScAttrIterator
 207 {
 208         const ScAttrArray*      pArray;
 209         SCSIZE                          nPos;
 210         SCROW                           nRow;
 211         SCROW                           nEndRow;
 212 public:
 213         inline                          ScAttrIterator( const ScAttrArray* pNewArray, SCROW nStart, SCROW nEnd );
 214         inline const ScPatternAttr*     Next( SCROW& rTop, SCROW& rBottom );
 215         SCROW                           GetNextRow() const { return nRow; }
 216 };
 217
 218
 219 inline ScAttrIterator::ScAttrIterator( const ScAttrArray* pNewArray, SCROW nStart, SCROW nEnd ) :
 220         pArray( pNewArray ),
 221         nRow( nStart ),
 222         nEndRow( nEnd )
 223 {
 224         if ( nStart > 0 )
 225                 pArray->Search( nStart, nPos );
 226         else
 227                 nPos = 0;
 228 }
 229
 230 inline const ScPatternAttr*     ScAttrIterator::Next( SCROW& rTop, SCROW& rBottom )
 231 {
 232         const ScPatternAttr* pRet;
 233         if ( nPos < pArray->nCount && nRow <= nEndRow )
 234         {
 235                 rTop = nRow;
 236                 rBottom = Min( pArray->pData[nPos].nRow, nEndRow );
 237                 pRet = pArray->pData[nPos].pPattern;
 238                 nRow = rBottom + 1;
 239                 ++nPos;
 240         }
 241         else
 242                 pRet = NULL;
 243         return pRet;
 244 }
 245
 246
 247
 248 #endif
 249
 250