include/svx/svdedtv.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_SVX_SVDEDTV_HXX
  21 #define INCLUDED_SVX_SVDEDTV_HXX
  22
  23 #include <svx/svdmrkv.hxx>
  24 #include <svx/xpoly.hxx>
  25 #include <svx/svdmodel.hxx>
  26 #include <svx/svxdllapi.h>
  27 #include <svx/svdundo.hxx>
  28 #include <o3tl/typed_flags_set.hxx>
  29
  30 class SfxUndoAction;
  31 class SdrUndoAction;
  32 class SdrUndoGroup;
  33 class SfxStyleSheet;
  34 class SdrLayer;
  35 class SvdProgressInfo;
  36
  37 enum class SdrHorAlign  {
  38     NONE,
  39     Left,
  40     Right,
  41     Center
  42 };
  43
  44 enum class SdrVertAlign {
  45     NONE,
  46     Top,
  47     Bottom,
  48     Center
  49 };
  50
  51 enum class SdrMergeMode {
  52     Merge,
  53     Subtract,
  54     Intersect
  55 };
  56
  57 // Options for InsertObject()
  58 enum class SdrInsertFlags
  59 {
  60     NONE        = 0x0000,
  61     DONTMARK    = 0x0001, /* object will not be marked (the actual marking remains) */
  62     ADDMARK     = 0x0002, /* object will be added an existing selection  */
  63     SETDEFATTR  = 0x0004, /* actual attributes (+StyleSheet) are assigned to the object */
  64     SETDEFLAYER = 0x0008, /* actual layer is assigned to the object */
  65 };
  66 namespace o3tl
  67 {
  68     template<> struct typed_flags<SdrInsertFlags> : is_typed_flags<SdrInsertFlags, 0x0f> {};
  69 }
  70
  71 class SVXCORE_DLLPUBLIC SdrEditView : public SdrMarkView
  72 {
  73     friend class SdrPageView;
  74     friend class SdrDragDistort;
  75     friend class SdrDragCrook;
  76
  77 protected:
  78
  79     // cache the transformation queries, etc. a little
  80     bool m_bPossibilitiesDirty : 1;
  81     bool m_bReadOnly : 1;
  82     bool m_bGroupPossible : 1;
  83     bool m_bUnGroupPossible : 1;
  84     bool m_bGrpEnterPossible : 1;
  85     bool m_bToTopPossible : 1;
  86     bool m_bToBtmPossible : 1;
  87     bool m_bReverseOrderPossible : 1;
  88     bool m_bImportMtfPossible : 1;
  89     bool m_bCombinePossible : 1;
  90     bool m_bDismantlePossible : 1;
  91     bool m_bCombineNoPolyPolyPossible : 1;
  92     bool m_bDismantleMakeLinesPossible : 1;
  93     bool m_bOrthoDesiredOnMarked : 1;
  94     bool m_bOneOrMoreMovable : 1;        // at least one object is moveable
  95     bool m_bMoreThanOneNoMovRot : 1;     // more than one object is not movable nor turnable (Crook)
  96     bool m_bContortionPossible : 1;      // all polygones (grouped if necessary)
  97     bool m_bMoveAllowed : 1;
  98     bool m_bResizeFreeAllowed : 1;
  99     bool m_bResizePropAllowed : 1;
 100     bool m_bRotateFreeAllowed : 1;
 101     bool m_bRotate90Allowed : 1;
 102     bool m_bMirrorFreeAllowed : 1;
 103     bool m_bMirror45Allowed : 1;
 104     bool m_bMirror90Allowed : 1;
 105     bool m_bShearAllowed : 1;
 106     bool m_bEdgeRadiusAllowed : 1;
 107     bool m_bTransparenceAllowed : 1;
 108     bool m_bCropAllowed : 1;
 109     bool m_bGradientAllowed : 1;
 110     bool m_bCanConvToPath : 1;
 111     bool m_bCanConvToPoly : 1;
 112     bool m_bCanConvToContour : 1;
 113     bool m_bMoveProtect : 1;
 114     bool m_bResizeProtect : 1;
 115
 116 private:
 117     SVX_DLLPRIVATE void ImpResetPossibilityFlags();
 118
 119 protected:
 120     SAL_DLLPRIVATE void ImpBroadcastEdgesOfMarkedNodes();
 121
 122     // convert the objects marked in poly resp. bezier
 123     SAL_DLLPRIVATE void ImpConvertTo(bool bPath, bool bLineToArea);
 124
 125     // converts an object, when positive it removes the old one from its List
 126     // and inserts the new one instead. including Undo.
 127     // Nor MarkEntry nor ModelChgBroadcast is created.
 128     SAL_DLLPRIVATE rtl::Reference<SdrObject> ImpConvertOneObj(SdrObject* pObj, bool bPath, bool bLineToArea);
 129
 130     // set both flags: bToTopPossible and bToBtmPossible.
 131     // bToTopPossibleDirty and bToBtmPossibleDirty are reset at the same time
 132     SAL_DLLPRIVATE void ImpCheckToTopBtmPossible();
 133
 134     // for CombineMarkedObjects and DismantleMarkedObjects
 135     SAL_DLLPRIVATE void ImpCopyAttributes(const SdrObject* pSource, SdrObject* pDest) const;
 136
 137     // for CombineMarkedObjects
 138     SAL_DLLPRIVATE static bool ImpCanConvertForCombine1(const SdrObject* pObj);
 139     SAL_DLLPRIVATE static bool ImpCanConvertForCombine(const SdrObject* pObj);
 140     SAL_DLLPRIVATE static basegfx::B2DPolyPolygon ImpGetPolyPolygon1(const SdrObject* pObj);
 141     SAL_DLLPRIVATE static basegfx::B2DPolyPolygon ImpGetPolyPolygon(const SdrObject* pObj);
 142     SAL_DLLPRIVATE static basegfx::B2DPolygon ImpCombineToSinglePolygon(const basegfx::B2DPolyPolygon& rPolyPolygon);
 143
 144     // for DismantleMarkedObjects
 145     SAL_DLLPRIVATE static bool ImpCanDismantle(const basegfx::B2DPolyPolygon& rPpolyPpolygon, bool bMakeLines);
 146     SAL_DLLPRIVATE static bool ImpCanDismantle(const SdrObject* pObj, bool bMakeLines);
 147     SAL_DLLPRIVATE void ImpDismantleOneObject(const SdrObject* pObj, SdrObjList& rOL, size_t& rPos, SdrPageView* pPV, bool bMakeLines);
 148     SAL_DLLPRIVATE static void ImpCrookObj(SdrObject* pO, const Point& rRef, const Point& rRad, SdrCrookMode eMode,
 149         bool bVertical, bool bNoContortion, bool bRotate, const tools::Rectangle& rMarkRect);
 150     SAL_DLLPRIVATE static void ImpDistortObj(SdrObject* pO, const tools::Rectangle& rRef, const XPolygon& rDistortedRect, bool bNoContortion);
 151     SAL_DLLPRIVATE bool ImpDelLayerCheck(SdrObjList const * pOL, SdrLayerID nDelID) const;
 152     SAL_DLLPRIVATE void ImpDelLayerDelObjs(SdrObjList* pOL, SdrLayerID nDelID);
 153
 154     // Removes all objects of the MarkList from their ObjLists including Undo.
 155     // The entries in rMark remain.
 156     // @return a list of objects that must be deleted after the outermost EndUndo
 157     SAL_DLLPRIVATE std::vector<rtl::Reference<SdrObject>> DeleteMarkedList(SdrMarkList const& rMark); // DeleteMarked -> DeleteMarkedList
 158
 159     // Check possibilities of all marked objects
 160     virtual void CheckPossibilities();
 161     void ForcePossibilities() const { if (m_bPossibilitiesDirty || mbSomeObjChgdFlag) const_cast<SdrEditView*>(this)->CheckPossibilities(); }
 162
 163 protected:
 164     // #i71538# make constructors of SdrView sub-components protected to avoid incomplete incarnations which may get casted to SdrView
 165     SAL_DLLPRIVATE SdrEditView(
 166         SdrModel& rSdrModel,
 167         OutputDevice* pOut);
 168
 169     SAL_DLLPRIVATE virtual ~SdrEditView() override;
 170
 171 public:
 172     // each call of an undo-capable method from its view, generates an undo action.
 173     // If one wishes to group method calls into one, these calls should be put
 174     // between BegUndo() and EndUndo() calls (unlimited).
 175     // The comment used for the UndoAction is the first BegUndo(String).
 176     // In this case NotifyNewUndoAction is called at the last EndUndo().
 177     // NotifyNewUndoAction() is not called for an empty group
 178     void BegUndo()
 179     {
 180         // open undo-grouping
 181         GetModel().BegUndo();
 182     }
 183     void BegUndo(const OUString& rComment)
 184     {
 185         // open undo-grouping
 186         GetModel().BegUndo(rComment);
 187     }
 188     void BegUndo(const OUString& rComment, const OUString& rObjDescr, SdrRepeatFunc eFunc=SdrRepeatFunc::NONE)
 189     {
 190         // open undo-grouping
 191         GetModel().BegUndo(rComment,rObjDescr,eFunc);
 192     }
 193
 194     void EndUndo(); // close undo-grouping  (incl. BroadcastEdges)
 195
 196     void AddUndo(std::unique_ptr<SdrUndoAction> pUndo)
 197     {
 198         // add action
 199         GetModel().AddUndo(std::move(pUndo));
 200     }
 201
 202     // only after first BegUndo or before last EndUndo:
 203     void SetUndoComment(const OUString& rComment, const OUString& rObjDescr)
 204     {
 205         GetModel().SetUndoComment(rComment,rObjDescr);
 206     }
 207
 208     bool IsUndoEnabled() const;
 209
 210     /**
 211      * Checks if this or other views have an active text edit, if true, end them.
 212      */
 213     void EndTextEditAllViews() const;
 214     void EndTextEditCurrentView(bool bDontDeleteReally = false);
 215
 216     SAL_DLLPRIVATE std::vector< std::unique_ptr<SdrUndoAction> > CreateConnectorUndo( const SdrObject& rO );
 217     SAL_DLLPRIVATE void AddUndoActions( std::vector< std::unique_ptr<SdrUndoAction> > );
 218
 219     // Layermanagement with Undo.
 220     void InsertNewLayer(const OUString& rName, sal_uInt16 nPos);
 221     // Delete a layer including all objects contained
 222     void DeleteLayer(const OUString& rName);
 223
 224     // Marked objects which are outside a page
 225     // are assigned to another page; at the moment without undo!!!
 226     void ForceMarkedObjToAnotherPage();
 227     void ForceMarkedToAnotherPage()   { ForceMarkedObjToAnotherPage(); }
 228
 229     // delete all marked objects
 230     void DeleteMarkedObj();
 231
 232     // Set a logical enclosing rectangle for all marked objects.
 233     // It is not guaranteed if this succeeds, as a horizontal
 234     // line has always a height of 0
 235     void SetMarkedObjRect(const tools::Rectangle& rRect);
 236     void MoveMarkedObj(const Size& rSiz, bool bCopy=false);
 237     void ResizeMarkedObj(const Point& rRef, const Fraction& xFact, const Fraction& yFact, bool bCopy=false);
 238     SAL_DLLPRIVATE void ResizeMultMarkedObj(const Point& rRef, const Fraction& xFact, const Fraction& yFact, const bool bWdh, const bool bHgt);
 239     SAL_DLLPRIVATE Degree100 GetMarkedObjRotate() const;
 240     void RotateMarkedObj(const Point& rRef, Degree100 nAngle, bool bCopy=false);
 241     SAL_DLLPRIVATE void MirrorMarkedObj(const Point& rRef1, const Point& rRef2, bool bCopy=false);
 242     void MirrorMarkedObjHorizontal();
 243     void MirrorMarkedObjVertical();
 244     SAL_DLLPRIVATE Degree100 GetMarkedObjShear() const;
 245     SAL_DLLPRIVATE void ShearMarkedObj(const Point& rRef, Degree100 nAngle, bool bVShear=false, bool bCopy=false);
 246     SAL_DLLPRIVATE void CrookMarkedObj(const Point& rRef, const Point& rRad, SdrCrookMode eMode, bool bVertical, bool bNoContortion, bool bCopy=false);
 247     SAL_DLLPRIVATE void DistortMarkedObj(const tools::Rectangle& rRef, const XPolygon& rDistortedRect, bool bNoContortion, bool bCopy=false);
 248
 249     // copy marked objects and mark them instead of the old ones
 250     void CopyMarkedObj();
 251     void SetAllMarkedRect(const tools::Rectangle& rRect) { SetMarkedObjRect(rRect); }
 252     void MoveAllMarked(const Size& rSiz, bool bCopy=false) { MoveMarkedObj(rSiz,bCopy); }
 253     void ResizeAllMarked(const Point& rRef, const Fraction& xFact, const Fraction& yFact) { ResizeMarkedObj(rRef,xFact,yFact); }
 254     void RotateAllMarked(const Point& rRef, Degree100 nAngle) { RotateMarkedObj(rRef,nAngle); }
 255     void MirrorAllMarkedHorizontal() { MirrorMarkedObjHorizontal(); }
 256     void MirrorAllMarkedVertical() { MirrorMarkedObjVertical(); }
 257     void CopyMarked() { CopyMarkedObj(); }
 258     bool IsMoveAllowed() const { ForcePossibilities(); return m_bMoveAllowed && !m_bMoveProtect; }
 259     bool IsResizeAllowed(bool bProp=false) const;
 260     bool IsRotateAllowed(bool b90Deg=false) const;
 261     bool IsMirrorAllowed(bool b45Deg=false, bool b90Deg=false) const;
 262     bool IsTransparenceAllowed() const;
 263     bool IsGradientAllowed() const;
 264     bool IsShearAllowed() const;
 265     bool IsEdgeRadiusAllowed() const;
 266     bool IsCrookAllowed(bool bNoContortion=false) const;
 267     SAL_DLLPRIVATE bool IsCropAllowed() const;
 268     bool IsDistortAllowed(bool bNoContortion=false) const;
 269
 270     // Consolidate the text from multiple, selected TextObjects,
 271     // attempting to identify paragraph fragments and join them together
 272     void CombineMarkedTextObjects();
 273
 274     // Unite several objects to a polygon:
 275     // - rectangles/circles/text... are implicitly converted.
 276     // - polygones are closed automatically
 277     // - attributes and layer are taken from the first object marked
 278     //   (thus from lowest Z-order).
 279     // - group objects are included when all (!) member objects of
 280     //   the group can be changed. If a group includes for example
 281     //   a bitmap or an OLE-object, the complete group is not considered.
 282     // bNoPolyPoly=TRUE: all is grouped to one single polygon
 283     void CombineMarkedObjects(bool bNoPolyPoly = true);
 284
 285     // for combining multiple polygons, with direct support of the modes
 286     // SID_POLY_MERGE, SID_POLY_SUBSTRACT, SID_POLY_INTERSECT
 287     void MergeMarkedObjects(SdrMergeMode eMode);
 288
 289     // for distribution dialog function
 290     void DistributeMarkedObjects(sal_uInt16 SlotID);
 291
 292     // for setting either the width or height of all selected
 293     // objects to the width/height of the last selected object
 294     // of the selection
 295     void EqualizeMarkedObjects(bool bWidth);
 296
 297     // Decompose marked polypolygon objects into polygons.
 298     // Grouped objects are searched and decomposed, if all member objects are PathObjs.
 299     // bMakeLines=TRUE:  all polygones are decomposed into single lines resp. bezier segments
 300     void DismantleMarkedObjects(bool bMakeLines=false);
 301     bool IsCombinePossible(bool bNoPolyPoly=false) const;
 302     bool IsDismantlePossible(bool bMakeLines=false) const;
 303
 304     // Inserts a new, completely constructed object. Subsequently the object belongs to
 305     // the model. After insertion the object is marked (if not prevented by nOptions).
 306     // Sometimes the object is not inserted, but deleted, this is the case when
 307     // the target layer is locked or not visible. In this case
 308     // the method returns FALSE.
 309     // Amongst others the method does not create an undo-action.
 310     bool InsertObjectAtView(SdrObject* pObj, SdrPageView& rPV, SdrInsertFlags nOptions=SdrInsertFlags::NONE);
 311
 312     // Replace one drawing object by another.
 313     // *pNewObj belongs to me, *pOldObj is changed into Undo.
 314     // In any case an undo grouping is required and should be applied, e.g.:
 315     // aStr+=" replace";
 316     // BegUndo(aStr);
 317     // ReplaceObject(...);
 318
 319     // EndUndo();
 320     void ReplaceObjectAtView(SdrObject* pOldObj, SdrPageView& rPV, SdrObject* pNewObj, bool bMark=true);
 321
 322     SAL_DLLPRIVATE void SetNotPersistAttrToMarked(const SfxItemSet& rAttr);
 323     SAL_DLLPRIVATE void MergeNotPersistAttrFromMarked(SfxItemSet& rAttr) const;
 324     void MergeAttrFromMarked(SfxItemSet& rAttr, bool bOnlyHardAttr) const;
 325     SfxItemSet GetAttrFromMarked(bool bOnlyHardAttr) const;
 326     void SetAttrToMarked(const SfxItemSet& rAttr, bool bReplaceAll);
 327
 328     // geometrical attribute (position, size, rotation angle)
 329     // A PageOrigin set at a position is taken into account.
 330     SfxItemSet GetGeoAttrFromMarked() const;
 331     // In LOK, interactive shape movement uses this function
 332     // in that case, margin is not taken into account
 333     // and the final position of the shape becomes incorrect
 334     // However, "Position and Size" dialog and other cases already add the margins.
 335     void SetGeoAttrToMarked(const SfxItemSet& rAttr, bool addPageMargin = false);
 336
 337     // Returns NULL if:
 338     // - nothing is marked,
 339     // - no stylesheet is set at the marked object
 340     // - point the marked objects to different StyleSheets for multiple selections
 341     SfxStyleSheet* GetStyleSheetFromMarked() const;
 342
 343     // at the moment without undo :(
 344     SAL_DLLPRIVATE void SetStyleSheetToMarked(SfxStyleSheet* pStyleSheet, bool bDontRemoveHardAttr);
 345
 346     /* new interface src537 */
 347     SAL_DLLPRIVATE void GetAttributes(SfxItemSet& rTargetSet, bool bOnlyHardAttr) const;
 348
 349     SAL_DLLPRIVATE void SetAttributes(const SfxItemSet& rSet, bool bReplaceAll);
 350     SAL_DLLPRIVATE SfxStyleSheet* GetStyleSheet() const; // SfxStyleSheet* GetStyleSheet(bool& rOk) const;
 351     SAL_DLLPRIVATE void SetStyleSheet(SfxStyleSheet* pStyleSheet, bool bDontRemoveHardAttr);
 352
 353     // Group all marked objects to a single group.
 354     // Subsequently mark the new group . If the group spawns multiple
 355     // pages a group is created per page.
 356     // All groups created are subsequently marked.
 357     // The method creates SdrObjGroup-instances.
 358     void GroupMarked();
 359
 360     // All marked object groups are dissolved (1 level).
 361     // Now all previously marked member objects are marked.
 362     // Previously marked objects, which are not group objects, remain marked.
 363     void UnGroupMarked();
 364
 365     bool IsGroupPossible() const { ForcePossibilities(); return m_bGroupPossible; }
 366     bool IsUnGroupPossible() const { ForcePossibilities(); return m_bUnGroupPossible; }
 367     bool IsGroupEnterPossible() const { ForcePossibilities(); return m_bGrpEnterPossible; }
 368
 369     // Convert marked objects to polygones/Beziercurves. The bool-functions
 370     // return sal_True, if at least one marked object could be converted.
 371     // Also member objects of group objects are converted.
 372     // For a better description see: SdrObj.HXX
 373     bool IsConvertToPathObjPossible() const { ForcePossibilities(); return m_bCanConvToPath; }
 374     bool IsConvertToPolyObjPossible() const { ForcePossibilities(); return m_bCanConvToPoly; }
 375     bool IsConvertToContourPossible() const { ForcePossibilities(); return m_bCanConvToContour; }
 376     void ConvertMarkedToPathObj(bool bLineToArea);
 377     SAL_DLLPRIVATE void ConvertMarkedToPolyObj();
 378
 379     // Align all marked objects vertically. Normally the SnapRect of an object is used.
 380     void AlignMarkedObjects(SdrHorAlign eHor, SdrVertAlign eVert);
 381     bool IsAlignPossible() const;
 382
 383     // move marked objects "up"
 384     void MovMarkedToTop();
 385
 386     // move marked objects "down"
 387     void MovMarkedToBtm();
 388
 389     // move marked objects "at top"
 390     void PutMarkedToTop();
 391
 392     // move marked objects "at bottom"
 393     void PutMarkedToBtm();
 394
 395     // move marked immediately before the object passed
 396     // NULL -> as PutMarkedToTop();
 397     void PutMarkedInFrontOfObj(const SdrObject* pRefObj);
 398
 399     // move marked immediately after object passed
 400     // NULL -> as PutMarkedToBtm();
 401     void PutMarkedBehindObj(const SdrObject* pRefObj);
 402
 403     // swap Z-Order of marked objects
 404     void ReverseOrderOfMarked();
 405
 406     // Check if forward, backward is possible.
 407     // GetMaxToBtmObj() is only partly taken into account by these methods.
 408     // Which means it can happen that IsToTopPossible() returns sal_True,
 409     // but MovMarkedToTop() changes nothing (e.g. for multiple selections),
 410     // as restriction derived via a view by GetMaxToTopObj() prevents this.
 411     bool IsToTopPossible() const { ForcePossibilities(); return m_bToTopPossible; }
 412     bool IsToBtmPossible() const { ForcePossibilities(); return m_bToBtmPossible; }
 413     bool IsReverseOrderPossible() const { ForcePossibilities(); return m_bReverseOrderPossible; }
 414
 415     // Using this method the view determines how far an object
 416     // can be moved forward or backward (Z-order).
 417     // The object returned is not "obsolete". When NULL is
 418     // returned there is not such a restriction.
 419     virtual SdrObject* GetMaxToTopObj(SdrObject* pObj) const;
 420     virtual SdrObject* GetMaxToBtmObj(SdrObject* pObj) const;
 421
 422     // Next method is called, if via ToTop, ToBtm, ... the
 423     // sequence of object has been changed. It is called after
 424     // each SdrObjList::SetObjectOrdNum(nOldPos,nNewPos);
 425     virtual void ObjOrderChanged(SdrObject* pObj, size_t nOldPos, size_t nNewPos);
 426
 427     // If one or more objects of the type SdrGrafObj or SdrOle2Obj
 428     // are marked and these are capable to deliver a StarView-metafile,
 429     // this methods converts the metafile to a drawing object.
 430     // The SdrGrafObjs/SdrOle2Objs are replaced by the new objects.
 431     void DoImportMarkedMtf(SvdProgressInfo *pProgrInfo=nullptr);
 432     bool IsImportMtfPossible() const { ForcePossibilities(); return m_bImportMtfPossible; }
 433
 434     // override SdrMarkView, for internal use
 435     SAL_DLLPRIVATE virtual void MarkListHasChanged() override;
 436     SAL_DLLPRIVATE virtual void ModelHasChanged() override;
 437 };
 438
 439 #endif // INCLUDED_SVX_SVDEDTV_HXX
 440
 441 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */