include/svx/svdograf.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_SVDOGRAF_HXX
  21 #define INCLUDED_SVX_SVDOGRAF_HXX
  22
  23 #include <com/sun/star/io/XInputStream.hpp>
  24 #include <com/sun/star/graphic/XGraphic.hpp>
  25 #include <com/sun/star/uno/Sequence.hxx>
  26 #include <vcl/graph.hxx>
  27 #include <svx/svdorect.hxx>
  28 #include <vcl/GraphicObject.hxx>
  29 #include <svx/svxdllapi.h>
  30 #include <o3tl/typed_flags_set.hxx>
  31
  32 namespace sdr
  33 {
  34     namespace properties
  35     {
  36         class GraphicProperties;
  37     } // end of namespace properties
  38     namespace contact
  39     {
  40         class ViewObjectContactOfGraphic;
  41     } // end of namespace contact
  42 } // end of namespace sdr
  43
  44 /**
  45  * Options for GetTransformedGraphic()
  46  */
  47 enum class SdrGrafObjTransformsAttrs
  48 {
  49     NONE       = 0x00,
  50     MIRROR     = 0x01,
  51     ROTATE     = 0x02,
  52     ALL        = 0x03,
  53 };
  54 namespace o3tl
  55 {
  56     template<> struct typed_flags<SdrGrafObjTransformsAttrs> : is_typed_flags<SdrGrafObjTransformsAttrs, 0x03> {};
  57 }
  58
  59 class SdrGrafObjGeoData : public SdrTextObjGeoData
  60 {
  61 public:
  62     bool                    bMirrored;
  63
  64     SdrGrafObjGeoData()
  65     :   bMirrored(false)
  66     {
  67     }
  68 };
  69
  70 class GraphicObject;
  71 class SdrGraphicLink;
  72
  73 /**
  74  * This class represents an embedded or linked bitmap graphic object.
  75  */
  76 class SVX_DLLPUBLIC SdrGrafObj : public SdrRectObj
  77 {
  78 private:
  79     // to allow sdr::properties::GraphicProperties access to SetXPolyDirty()
  80     friend class sdr::properties::GraphicProperties;
  81
  82     // to allow sdr::contact::ViewObjectContactOfGraphic access to ImpUpdateGraphicLink()
  83     friend class sdr::contact::ViewObjectContactOfGraphic;
  84     friend class SdrExchangeView; // Only for a ForceSwapIn() call.
  85     friend class SdrGraphicLink;
  86
  87     virtual std::unique_ptr<sdr::contact::ViewContact> CreateObjectSpecificViewContact() override;
  88     virtual std::unique_ptr<sdr::properties::BaseProperties> CreateObjectSpecificProperties() override;
  89
  90     void ImpSetAttrToGrafInfo(); // Copy values from the pool
  91     GraphicAttr aGrafInfo;
  92
  93     OUString aFileName; // If it's a Link, the filename can be found in here
  94     OUString aReferer;
  95     OUString aFilterName;
  96     std::unique_ptr<GraphicObject> mpGraphicObject; // In order to speed up output of bitmaps, especially rotated ones
  97     std::unique_ptr<GraphicObject> mpReplacementGraphicObject;
  98     SdrGraphicLink* pGraphicLink; // And here a pointer for linked graphics
  99     bool bMirrored:1; // True: the graphic is horizontal, which means it's mirrored along the y-axis
 100
 101     // Flag for allowing text animation. Default is true.
 102     bool mbGrafAnimationAllowed:1;
 103
 104     bool mbIsSignatureLine;
 105     OUString maSignatureLineId;
 106     OUString maSignatureLineSuggestedSignerName;
 107     OUString maSignatureLineSuggestedSignerTitle;
 108     OUString maSignatureLineSuggestedSignerEmail;
 109     OUString maSignatureLineSigningInstructions;
 110     bool mbIsSignatureLineShowSignDate;
 111     bool mbIsSignatureLineCanAddComment;
 112     bool mbSignatureLineIsSigned;
 113     css::uno::Reference<css::graphic::XGraphic> mpSignatureLineUnsignedGraphic;
 114
 115     void                    ImpRegisterLink();
 116     void                    ImpDeregisterLink();
 117     void                    ImpSetLinkedGraphic( const Graphic& rGraphic );
 118                             DECL_LINK( ImpSwapHdl, const GraphicObject*, SvStream* );
 119                             DECL_LINK( ReplacementSwapHdl, const GraphicObject*, SvStream* );
 120     void onGraphicChanged();
 121     GDIMetaFile             GetMetaFile(GraphicType &rGraphicType) const;
 122
 123 protected:
 124     // protected destructor
 125     virtual ~SdrGrafObj() override;
 126
 127 public:
 128     SdrGrafObj(SdrModel& rSdrModel);
 129     SdrGrafObj(
 130         SdrModel& rSdrModel,
 131         const Graphic& rGrf);
 132     SdrGrafObj(
 133         SdrModel& rSdrModel,
 134         const Graphic& rGrf,
 135         const tools::Rectangle& rRect);
 136
 137     void                    SetGraphicObject( const GraphicObject& rGrfObj );
 138     const GraphicObject&    GetGraphicObject(bool bForceSwapIn = false) const;
 139     const GraphicObject*    GetReplacementGraphicObject() const;
 140
 141     void                    NbcSetGraphic(const Graphic& rGrf);
 142     void                    SetGraphic(const Graphic& rGrf);
 143     const Graphic&          GetGraphic() const;
 144
 145     Graphic                 GetTransformedGraphic( SdrGrafObjTransformsAttrs nTransformFlags = SdrGrafObjTransformsAttrs::ALL ) const;
 146     GraphicType             GetGraphicType() const;
 147     GraphicAttr             GetGraphicAttr( SdrGrafObjTransformsAttrs nTransformFlags = SdrGrafObjTransformsAttrs::ALL  ) const;
 148
 149     // Keep ATM for SD.
 150     bool IsAnimated() const;
 151     bool IsEPS() const;
 152
 153     MapMode          GetGrafPrefMapMode() const;
 154     Size             GetGrafPrefSize() const;
 155
 156     void                    SetGrafStreamURL( const OUString& rGraphicStreamURL );
 157     OUString const &        GetGrafStreamURL() const;
 158     Size                    getOriginalSize() const;
 159
 160 private:
 161     void                    ForceSwapIn() const;
 162
 163 public:
 164     void                    SetGraphicLink(const OUString& rFileName, const OUString& rReferer, const OUString& rFilterName);
 165     void                    ReleaseGraphicLink();
 166     bool IsLinkedGraphic() const;
 167
 168     const OUString& GetFileName() const { return aFileName;}
 169
 170     void                    StartAnimation();
 171
 172     virtual void            TakeObjInfo(SdrObjTransformInfoRec& rInfo) const override;
 173     virtual sal_uInt16      GetObjIdentifier() const override;
 174
 175     virtual OUString        TakeObjNameSingul() const override;
 176     virtual OUString        TakeObjNamePlural() const override;
 177
 178     virtual SdrGrafObj* CloneSdrObject(SdrModel& rTargetModel) const override;
 179     SdrGrafObj&             operator=(const SdrGrafObj& rObj);
 180
 181     virtual sal_uInt32 GetHdlCount() const override;
 182     virtual void AddToHdlList(SdrHdlList& rHdlList) const override;
 183
 184     virtual void            NbcResize(const Point& rRef, const Fraction& xFact, const Fraction& yFact) override;
 185     virtual void            NbcMirror(const Point& rRef1, const Point& rRef2) override;
 186     virtual SdrObjGeoData*  NewGeoData() const override;
 187     virtual void            SaveGeoData(SdrObjGeoData& rGeo) const override;
 188     virtual void            RestGeoData(const SdrObjGeoData& rGeo) override;
 189
 190     bool                    HasGDIMetaFile() const;
 191
 192     // react on model/page change
 193     virtual void handlePageChange(SdrPage* pOldPage, SdrPage* pNewPage) override;
 194
 195     bool isEmbeddedVectorGraphicData() const;
 196     GDIMetaFile getMetafileFromEmbeddedVectorGraphicData() const;
 197
 198     bool isEmbeddedPdfData() const;
 199     std::shared_ptr<css::uno::Sequence<sal_Int8>> const & getEmbeddedPdfData() const;
 200     /// Returns the page number of the embedded data (typically to re-render or import it).
 201     sal_Int32 getEmbeddedPageNumber() const;
 202
 203     virtual SdrObject*      DoConvertToPolyObj(bool bBezier, bool bAddText) const override;
 204
 205     virtual void            AdjustToMaxRect( const tools::Rectangle& rMaxRect, bool bShrinkOnly = false ) override;
 206
 207     virtual void            Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) override;
 208
 209     bool IsMirrored() const { return bMirrored;}
 210     void SetMirrored( bool _bMirrored );
 211
 212     virtual bool shouldKeepAspectRatio() const override { return true; }
 213
 214     // Access to GrafAnimationAllowed flag
 215     void SetGrafAnimationAllowed(bool bNew);
 216
 217     css::uno::Reference< css::io::XInputStream > getInputStream();
 218
 219     // #i103116# FullDrag support
 220     virtual SdrObject* getFullDragClone() const override;
 221
 222     // add handles for crop mode when selected
 223     virtual void addCropHandles(SdrHdlList& rTarget) const override;
 224
 225     // Signature Line
 226     void setIsSignatureLine(bool bIsSignatureLine) { mbIsSignatureLine = bIsSignatureLine; };
 227     bool isSignatureLine() const { return mbIsSignatureLine; };
 228     void setSignatureLineId(const OUString& rSignatureLineId)
 229     {
 230         maSignatureLineId = rSignatureLineId;
 231     };
 232     const OUString& getSignatureLineId() const { return maSignatureLineId; };
 233     void setSignatureLineSuggestedSignerName(const OUString& rSuggestedSignerName)
 234     {
 235         maSignatureLineSuggestedSignerName = rSuggestedSignerName;
 236     };
 237     const OUString& getSignatureLineSuggestedSignerName() const
 238     {
 239         return maSignatureLineSuggestedSignerName;
 240     };
 241     void setSignatureLineSuggestedSignerTitle(const OUString& rSuggestedSignerTitle)
 242     {
 243         maSignatureLineSuggestedSignerTitle = rSuggestedSignerTitle;
 244     };
 245     const OUString& getSignatureLineSuggestedSignerTitle() const
 246     {
 247         return maSignatureLineSuggestedSignerTitle;
 248     };
 249     void setSignatureLineSuggestedSignerEmail(const OUString& rSuggestedSignerEmail)
 250     {
 251         maSignatureLineSuggestedSignerEmail = rSuggestedSignerEmail;
 252     };
 253     const OUString& getSignatureLineSuggestedSignerEmail() const
 254     {
 255         return maSignatureLineSuggestedSignerEmail;
 256     };
 257     void setSignatureLineSigningInstructions(const OUString& rSigningInstructions)
 258     {
 259         maSignatureLineSigningInstructions = rSigningInstructions;
 260     };
 261     const OUString& getSignatureLineSigningInstructions() const
 262     {
 263         return maSignatureLineSigningInstructions;
 264     };
 265     void setSignatureLineShowSignDate(bool bIsSignatureLineShowSignDate)
 266     {
 267         mbIsSignatureLineShowSignDate = bIsSignatureLineShowSignDate;
 268     };
 269     bool isSignatureLineShowSignDate() const { return mbIsSignatureLineShowSignDate; };
 270     void setSignatureLineCanAddComment(bool bIsSignatureCanAddComment)
 271     {
 272         mbIsSignatureLineCanAddComment = bIsSignatureCanAddComment;
 273     };
 274     bool isSignatureLineCanAddComment() const { return mbIsSignatureLineCanAddComment; };
 275     css::uno::Reference<css::graphic::XGraphic> const & getSignatureLineUnsignedGraphic() const
 276     {
 277         return mpSignatureLineUnsignedGraphic;
 278     };
 279     void setSignatureLineUnsignedGraphic(css::uno::Reference<css::graphic::XGraphic> rGraphic)
 280     {
 281         mpSignatureLineUnsignedGraphic = rGraphic;
 282     };
 283     bool isSignatureLineSigned() const { return mbSignatureLineIsSigned; };
 284     void setSignatureLineIsSigned(bool bIsSigned) { mbSignatureLineIsSigned = bIsSigned; }
 285 };
 286
 287 #endif // INCLUDED_SVX_SVDOGRAF_HXX
 288
 289 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */