include/svx/svdoashp.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_SVDOASHP_HXX
  21 #define INCLUDED_SVX_SVDOASHP_HXX
  22
  23 #include <svx/svdobj.hxx>
  24 #include <svx/svdotext.hxx>
  25 #include <svx/svdhdl.hxx>
  26 #include <vector>
  27 #include <com/sun/star/uno/Reference.h>
  28 #include <com/sun/star/drawing/XCustomShapeEngine.hpp>
  29 #include <com/sun/star/drawing/EnhancedCustomShapeAdjustmentValue.hpp>
  30 #include <svx/svxdllapi.h>
  31 #include <o3tl/typed_flags_set.hxx>
  32
  33 namespace sdr
  34 {
  35     namespace properties
  36     {
  37         class CustomShapeProperties;
  38     }
  39 }
  40
  41 class SdrAShapeObjGeoData : public SdrTextObjGeoData
  42 {
  43 public:
  44     bool        bMirroredX;
  45     bool        bMirroredY;
  46     double      fObjectRotation;
  47
  48     css::uno::Sequence< css::drawing::EnhancedCustomShapeAdjustmentValue > aAdjustmentSeq;
  49 };
  50
  51 enum class CustomShapeHandleModes
  52 {
  53     NONE                 = 0,
  54     RESIZE_FIXED         = 1,
  55     CREATE_FIXED         = 2,
  56     RESIZE_ABSOLUTE_X    = 4,
  57     RESIZE_ABSOLUTE_Y    = 8,
  58     MOVE_SHAPE           = 16,
  59     ORTHO4               = 32,
  60     RESIZE_ABSOLUTE_NEGX = 64
  61 };
  62
  63 namespace o3tl
  64 {
  65     template<> struct typed_flags<CustomShapeHandleModes> : is_typed_flags<CustomShapeHandleModes, 127> {};
  66 }
  67
  68 struct SdrCustomShapeInteraction
  69 {
  70     css::uno::Reference< css::drawing::XCustomShapeHandle > xInteraction;
  71     css::awt::Point                                         aPosition;
  72     CustomShapeHandleModes                                  nMode;
  73 };
  74
  75 class SVX_DLLPUBLIC SdrObjCustomShape : public SdrTextObj
  76 {
  77 private:
  78     // fObjectRotation is containing the object rotation in degrees.
  79     double fObjectRotation;
  80     bool mbAdjustingTextFrameWidthAndHeight;
  81
  82 protected:
  83     virtual std::unique_ptr<sdr::contact::ViewContact> CreateObjectSpecificViewContact() override;
  84     virtual void impl_setUnoShape(const css::uno::Reference<css::uno::XInterface>& rxUnoShape) override;
  85
  86 public:
  87     virtual std::unique_ptr<sdr::properties::BaseProperties> CreateObjectSpecificProperties() override;
  88
  89     // to allow sdr::properties::CustomShapeProperties access
  90     friend class sdr::properties::CustomShapeProperties;
  91
  92     css::uno::Reference< css::drawing::XShape > mXRenderedCustomShape;
  93
  94     mutable css::uno::Reference< css::drawing::XCustomShapeEngine > mxCustomShapeEngine;
  95
  96     // #i37011# render geometry shadow
  97     SdrObject* mpLastShadowGeometry;
  98
  99     css::uno::Reference< css::drawing::XCustomShapeEngine > const & GetCustomShapeEngine() const;
 100
 101     std::vector< SdrCustomShapeInteraction > GetInteractionHandles() const; // needed in unit test
 102     SVX_DLLPRIVATE void DragCreateObject( SdrDragStat& rDrag );
 103     SVX_DLLPRIVATE void DragResizeCustomShape( const tools::Rectangle& rNewRect );
 104     void DragMoveCustomShapeHdl( const Point& rDestination,
 105             const sal_uInt16 nCustomShapeHdlNum, bool bMoveCalloutRectangle ); // needed in unit test
 106
 107     // #i37011# centralize throw-away of render geometry
 108     void InvalidateRenderGeometry();
 109
 110     // #i38892#
 111     void ImpCheckCustomGluePointsAreAdded();
 112
 113     // returns the new text rect that corresponds to the current logic rect, the return value can be empty if nothing changed.
 114     tools::Rectangle ImpCalculateTextFrame( const bool bHgt, const bool bWdt );
 115
 116 public:
 117     // #i37011#
 118     const SdrObject* GetSdrObjectFromCustomShape() const;
 119     const SdrObject* GetSdrObjectShadowFromCustomShape() const;
 120     bool GetTextBounds( tools::Rectangle& rTextBound ) const;
 121     bool IsTextPath() const;
 122     basegfx::B2DPolyPolygon GetLineGeometry( const bool bBezierAllowed ) const;
 123
 124 protected:
 125     // #115391# new method for SdrObjCustomShape and SdrTextObj to correctly handle and set
 126     // SdrTextMinFrameWidthItem and SdrTextMinFrameHeightItem based on all settings, necessities
 127     // and object sizes
 128     virtual void AdaptTextMinSize() override;
 129
 130     Size m_aSuggestedTextFrameSize;
 131
 132     // protected destructor
 133     virtual ~SdrObjCustomShape() override;
 134
 135 public:
 136     bool UseNoFillStyle() const;
 137
 138     bool IsMirroredX() const;
 139     bool IsMirroredY() const;
 140     void SetMirroredX( const bool bMirroredX );
 141     void SetMirroredY( const bool bMirroredY );
 142
 143     double GetObjectRotation() const { return fObjectRotation;}
 144     double GetExtraTextRotation( const bool bPreRotation = false ) const;
 145
 146     SdrObjCustomShape(SdrModel& rSdrModel);
 147
 148     /* is merging default attributes from type-shape into the SdrCustomShapeGeometryItem. If pType
 149     is NULL then the type is being taken from the "Type" property of the SdrCustomShapeGeometryItem.
 150     MergeDefaultAttributes is called when creating CustomShapes via UI and after importing */
 151     void MergeDefaultAttributes( const OUString* pType = nullptr );
 152
 153     /* the method is checking if the geometry data is unchanged/default, in this case the data might not be stored */
 154     enum class DefaultType
 155     {
 156         Path,
 157         Viewbox,
 158         Segments,
 159         Gluepoints,
 160         StretchX,
 161         StretchY,
 162         Equations,
 163         TextFrames
 164     };
 165     bool IsDefaultGeometry( const DefaultType eDefaultType ) const;
 166
 167     virtual sal_uInt16 GetObjIdentifier() const override;
 168     virtual void TakeObjInfo(SdrObjTransformInfoRec& rInfo) const override;
 169
 170     virtual void Move(const Size& rSiz) override;
 171     virtual void Shear(const Point& rRef, long nAngle, double tn, bool bVShear) override;
 172     virtual void SetSnapRect(const tools::Rectangle& rRect) override;
 173     virtual void SetLogicRect(const tools::Rectangle& rRect) override;
 174
 175     virtual void NbcMove(const Size& rSiz) override;
 176     virtual void NbcResize(const Point& rRef, const Fraction& xFact, const Fraction& yFact) override;
 177     virtual void NbcRotate(const Point& rRef, long nAngle, double sn, double cs) override;
 178     virtual void NbcMirror(const Point& rRef1, const Point& rRef2) override;
 179     virtual void NbcShear(const Point& rRef, long nAngle, double tn, bool bVShear) override;
 180     virtual void NbcSetSnapRect(const tools::Rectangle& rRect) override;
 181     virtual void NbcSetLogicRect(const tools::Rectangle& rRect) override;
 182
 183     virtual SdrGluePoint GetVertexGluePoint(sal_uInt16 nNum) const override;
 184
 185     virtual void NbcSetStyleSheet( SfxStyleSheet* pNewStyleSheet, bool bDontRemoveHardAttr ) override;
 186
 187     // special drag methods
 188     virtual bool hasSpecialDrag() const override;
 189     virtual bool beginSpecialDrag(SdrDragStat& rDrag) const override;
 190     virtual bool applySpecialDrag(SdrDragStat& rDrag) override;
 191
 192     virtual bool MovCreate(SdrDragStat& rStat) override; // #i37448#
 193     virtual bool EndCreate(SdrDragStat& rStat, SdrCreateCmd eCmd) override;
 194
 195     /**
 196      * Allows suggesting the text frame size: in case the application has its
 197      * own text associated to the shape, instead of using the shape's editeng
 198      * text.
 199      */
 200     void SuggestTextFrameSize(Size aSuggestedTextFrameSize);
 201     virtual bool AdjustTextFrameWidthAndHeight(tools::Rectangle& rR, bool bHgt = true, bool bWdt = true) const override;
 202     virtual bool NbcAdjustTextFrameWidthAndHeight(bool bHgt = true, bool bWdt = true) override;
 203     virtual bool AdjustTextFrameWidthAndHeight() override;
 204     virtual bool IsAutoGrowHeight() const override;
 205     virtual bool IsAutoGrowWidth() const override;
 206     virtual void SetVerticalWriting(bool bVertical) override;
 207     virtual void TakeTextEditArea(Size* pPaperMin, Size* pPaperMax, tools::Rectangle* pViewInit, tools::Rectangle* pViewMin) const override;
 208     virtual void EndTextEdit( SdrOutliner& rOutl ) override;
 209     virtual void TakeTextAnchorRect( tools::Rectangle& rAnchorRect ) const override;
 210     virtual void TakeTextRect( SdrOutliner& rOutliner, tools::Rectangle& rTextRect, bool bNoEditText,
 211         tools::Rectangle* pAnchorRect, bool bLineWidth = true ) const override;
 212     virtual SdrObjCustomShape* CloneSdrObject(SdrModel& rTargetModel) const override;
 213     SdrObjCustomShape& operator=(const SdrObjCustomShape& rObj);
 214
 215     virtual OUString TakeObjNameSingul() const override;
 216     virtual OUString TakeObjNamePlural() const override;
 217
 218     virtual basegfx::B2DPolyPolygon TakeCreatePoly( const SdrDragStat& rDrag) const override;
 219
 220     virtual basegfx::B2DPolyPolygon TakeXorPoly() const override;
 221     virtual basegfx::B2DPolyPolygon TakeContour() const override;
 222
 223     virtual void NbcSetOutlinerParaObject(std::unique_ptr<OutlinerParaObject> pTextObject) override;
 224
 225     virtual SdrObject* DoConvertToPolyObj(bool bBezier, bool bAddText) const override;
 226
 227     // react on model/page change
 228     virtual void handlePageChange(SdrPage* pOldPage, SdrPage* pNewPage) override;
 229
 230     virtual SdrObjGeoData *NewGeoData() const override;
 231     virtual void SaveGeoData(SdrObjGeoData &rGeo) const override;
 232     virtual void RestGeoData(const SdrObjGeoData &rGeo) override;
 233
 234     // need to take fObjectRotation instead of aGeo.nAngle, replace it temporary
 235     virtual bool TRGetBaseGeometry(basegfx::B2DHomMatrix& rMatrix, basegfx::B2DPolyPolygon& rPolyPolygon) const override;
 236     virtual void TRSetBaseGeometry(const basegfx::B2DHomMatrix& rMatrix, const basegfx::B2DPolyPolygon& rPolyPolygon) override;
 237
 238     virtual const SdrGluePointList* GetGluePointList() const override;
 239     //virtual SdrGluePointList* GetGluePointList();
 240     virtual SdrGluePointList* ForceGluePointList() override;
 241
 242     virtual sal_uInt32 GetHdlCount() const override;
 243     virtual void AddToHdlList(SdrHdlList& rHdlList) const override;
 244
 245     // #i33136#
 246     static bool doConstructOrthogonal(const OUString& rName);
 247
 248     using SdrTextObj::NbcSetOutlinerParaObject;
 249
 250     OUString GetCustomShapeName();
 251 };
 252
 253 #endif // INCLUDED_SVX_SVDOASHP_HXX
 254
 255 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */