sc/inc/drwlayer.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_DRWLAYER_HXX
  21 #define INCLUDED_SC_INC_DRWLAYER_HXX
  22
  23 #include <svx/fmmodel.hxx>
  24 #include <svx/svdundo.hxx>
  25 #include "global.hxx"
  26
  27 class ScDocument;
  28 class SfxObjectShell;
  29 class ScDrawObjData;
  30 class ScIMapInfo;
  31 class ScMacroInfo;
  32 class IMapObject;
  33 class ScMarkData;
  34
  35 class ScTabDeletedHint : public SfxHint
  36 {
  37 private:
  38     SCTAB const   nTab;
  39 public:
  40             ScTabDeletedHint( SCTAB nTabNo );
  41     virtual ~ScTabDeletedHint() override;
  42
  43     SCTAB   GetTab() const { return nTab; }
  44 };
  45
  46 class ScTabSizeChangedHint : public SfxHint
  47 {
  48 private:
  49     SCTAB const   nTab;
  50 public:
  51             ScTabSizeChangedHint( SCTAB nTabNo );
  52     virtual ~ScTabSizeChangedHint() override;
  53
  54     SCTAB   GetTab() const  { return nTab; }
  55 };
  56
  57 //  Adjusting of detective UserData and draw undo's both have to be in SdrUndoGroup;
  58 //  therefore derived from SdrUndoAction
  59
  60 class ScUndoObjData : public SdrUndoObj
  61 {
  62 private:
  63     ScAddress const   aOldStt;
  64     ScAddress const   aOldEnd;
  65     ScAddress const   aNewStt;
  66     ScAddress const   aNewEnd;
  67 public:
  68                 ScUndoObjData( SdrObject* pObj, const ScAddress& rOS, const ScAddress& rOE,
  69                                                 const ScAddress& rNS, const ScAddress& rNE );
  70                 virtual ~ScUndoObjData() override;
  71
  72     virtual void     Undo() override;
  73     virtual void     Redo() override;
  74 };
  75
  76 class ScUndoAnchorData : public SdrUndoObj
  77 {
  78 private:
  79     bool                    mbWasCellAnchored;
  80     bool                    mbWasResizeWithCell;
  81     ScDocument* const       mpDoc;
  82     SCTAB const             mnTab;
  83 public:
  84                 ScUndoAnchorData( SdrObject* pObj, ScDocument* pDoc, SCTAB nTab );
  85                 virtual ~ScUndoAnchorData() override;
  86
  87     virtual void     Undo() override;
  88     virtual void     Redo() override;
  89 };
  90
  91 class SC_DLLPUBLIC ScDrawLayer : public FmFormModel
  92 {
  93 private:
  94     OUString const  aName;
  95     ScDocument*     pDoc;
  96     std::unique_ptr<SdrUndoGroup> pUndoGroup;
  97     bool            bRecording;
  98     bool            bAdjustEnabled;
  99     bool            bHyphenatorSet;
 100
 101 private:
 102     void            MoveCells( SCTAB nTab, SCCOL nCol1,SCROW nRow1, SCCOL nCol2,SCROW nRow2,
 103                                 SCCOL nDx,SCROW nDy, bool bUpdateNoteCaptionPos );
 104
 105     void            ResizeLastRectFromAnchor( const SdrObject* pObj, ScDrawObjData& rData, bool bUseLogicRect, bool bNegativePage, bool bCanResize, bool bHiddenAsZero = true );
 106
 107 public:
 108                     ScDrawLayer( ScDocument* pDocument, const OUString& rName );
 109     virtual         ~ScDrawLayer() override;
 110
 111     virtual SdrPage*  AllocPage(bool bMasterPage) override;
 112     virtual SdrModel* AllocModel() const override;
 113     virtual void    SetChanged( bool bFlg = true ) override;
 114
 115     bool            HasObjects() const;
 116
 117     bool            ScAddPage( SCTAB nTab );
 118     void            ScRemovePage( SCTAB nTab );
 119     void            ScRenamePage( SCTAB nTab, const OUString& rNewName );
 120     void            ScMovePage( sal_uInt16 nOldPos, sal_uInt16 nNewPos );
 121     void            ScCopyPage( sal_uInt16 nOldPos, sal_uInt16 nNewPos );
 122     void            ResetTab( SCTAB nStart, SCTAB nEnd );
 123
 124     ScDocument*     GetDocument() const { return pDoc; }
 125
 126     void            UseHyphenator();
 127
 128     bool            GetPrintArea( ScRange& rRange, bool bSetHor, bool bSetVer ) const;
 129
 130                     //      automatic adjustments
 131
 132     void            EnableAdjust( bool bSet )    { bAdjustEnabled = bSet; }
 133
 134     void            BeginCalcUndo(bool bDisableTextEditUsesCommonUndoManager);
 135     std::unique_ptr<SdrUndoGroup> GetCalcUndo();
 136     bool            IsRecording() const         { return bRecording; }
 137     void            AddCalcUndo( std::unique_ptr<SdrUndoAction> pUndo );
 138
 139     void            MoveArea( SCTAB nTab, SCCOL nCol1,SCROW nRow1, SCCOL nCol2,SCROW nRow2,
 140                                 SCCOL nDx,SCROW nDy, bool bInsDel, bool bUpdateNoteCaptionPos );
 141     void            RecalcPos( SdrObject* pObj, ScDrawObjData& rData, bool bNegativePage, bool bUpdateNoteCaptionPos );
 142
 143     bool            HasObjectsInRows( SCTAB nTab, SCROW nStartRow, SCROW nEndRow );
 144
 145     void            DeleteObjectsInArea( SCTAB nTab, SCCOL nCol1,SCROW nRow1,
 146                                             SCCOL nCol2,SCROW nRow2 );
 147     void            DeleteObjectsInSelection( const ScMarkData& rMark );
 148
 149     void            CopyToClip( ScDocument* pClipDoc, SCTAB nTab, const tools::Rectangle& rRange );
 150     void            CopyFromClip( ScDrawLayer* pClipModel,
 151                                     SCTAB nSourceTab, const tools::Rectangle& rSourceRange,
 152                                     const ScAddress& rDestPos, const tools::Rectangle& rDestRange );
 153
 154     void            SetPageSize( sal_uInt16 nPageNo, const Size& rSize, bool bUpdateNoteCaptionPos );
 155
 156                     //  mirror or move between positive and negative positions for RTL
 157     void            MirrorRTL( SdrObject* pObj );
 158     static void     MirrorRectRTL( tools::Rectangle& rRect );      // for bounding rectangles etc.
 159
 160     /** Returns the rectangle for the passed cell address in 1/100 mm.
 161         @param bMergedCell  True = regards merged cells. False = use single column/row size. */
 162     static tools::Rectangle GetCellRect( const ScDocument& rDoc, const ScAddress& rPos, bool bMergedCell );
 163
 164                     //  GetVisibleName: name for navigator etc: GetPersistName or GetName
 165                     //  (ChartListenerCollection etc. must use GetPersistName directly)
 166     static OUString GetVisibleName( const SdrObject* pObj );
 167
 168     SdrObject*      GetNamedObject( const OUString& rName, sal_uInt16 nId, SCTAB& rFoundTab ) const;
 169                     // if pnCounter != NULL, the search for a name starts with this index + 1,
 170                     // and the index really used is returned.
 171     OUString        GetNewGraphicName( long* pnCounter = nullptr ) const;
 172     void            EnsureGraphicNames();
 173
 174     static bool IsCellAnchored( const SdrObject& rObj );
 175     static bool IsResizeWithCell( const SdrObject& rObj );
 176     static void             SetPageAnchored( SdrObject& );
 177     static void             SetCellAnchored( SdrObject&, const ScDrawObjData &rAnchor );
 178     static void             SetVisualCellAnchored( SdrObject&, const ScDrawObjData &rAnchor );
 179
 180     // Updates rAnchor based on position of rObj
 181     static void GetCellAnchorFromPosition(
 182         const tools::Rectangle &rRectangle,
 183         ScDrawObjData &rAnchor,
 184         const ScDocument &rDoc,
 185         SCTAB nTab,
 186         bool bHiddenAsZero = true);
 187
 188     static void             SetCellAnchoredFromPosition( SdrObject &rObj, const ScDocument &rDoc, SCTAB nTab, bool bResizeWithCell );
 189     static void             UpdateCellAnchorFromPositionEnd( const SdrObject &rObj, ScDrawObjData &rAnchor, const ScDocument &rDoc, SCTAB nTab, bool bUseLogicRect = true );
 190     static ScAnchorType     GetAnchorType( const SdrObject& );
 191     std::vector<SdrObject*> GetObjectsAnchoredToRows(SCTAB nTab, SCROW nStartRow, SCROW nEndRow);
 192     std::map<SCROW, std::vector<SdrObject*>> GetObjectsAnchoredToRange(SCTAB nTab, SCCOL nCol, SCROW nStartRow, SCROW nEndRow);
 193     bool HasObjectsAnchoredInRange(const ScRange& rRange);
 194     void MoveObject(SdrObject* pObj, const ScAddress& rNewPosition);
 195
 196     // positions for detektive lines
 197     static ScDrawObjData* GetObjData( SdrObject* pObj, bool bCreate=false );
 198     static ScDrawObjData* GetNonRotatedObjData( SdrObject* pObj, bool bCreate=false );
 199
 200     // The sheet information in ScDrawObjData isn't updated when sheets are inserted/deleted.
 201     // Use this method to get an object with positions on the specified sheet (should be the
 202     // sheet on which the object is inserted).
 203     static ScDrawObjData* GetObjDataTab( SdrObject* pObj, SCTAB nTab );
 204
 205     /** Returns true, if the passed object is the caption of a cell note. */
 206     static bool     IsNoteCaption( SdrObject* pObj );
 207
 208     /** Returns the object data, if the passed object is a cell note caption. */
 209     static ScDrawObjData* GetNoteCaptionData( SdrObject* pObj, SCTAB nTab );
 210
 211     // Image-Map
 212     static ScIMapInfo* GetIMapInfo( const SdrObject* pObj );
 213
 214     static IMapObject* GetHitIMapObject( const SdrObject* pObject,
 215                             const Point& rWinPoint, const vcl::Window& rCmpWnd );
 216
 217     static ScMacroInfo* GetMacroInfo( SdrObject* pObj, bool bCreate = false );
 218
 219     virtual ImageMap* GetImageMapForObject(SdrObject* pObj) override;
 220
 221 private:
 222     static SfxObjectShell* pGlobalDrawPersist;          // for AllocModel
 223 public:
 224     static void     SetGlobalDrawPersist(SfxObjectShell* pPersist);
 225 protected:
 226     virtual css::uno::Reference< css::uno::XInterface > createUnoModel() override;
 227 };
 228
 229 extern bool bDrawIsInUndo; // somewhere as member!
 230
 231 #endif
 232
 233 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */