sd/inc/sdpage.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_SD_INC_SDPAGE_HXX
  21 #define INCLUDED_SD_INC_SDPAGE_HXX
  22
  23 #include <com/sun/star/drawing/XDrawPage.hpp>
  24 #include <com/sun/star/presentation/FadeEffect.hpp>
  25 #include <com/sun/star/office/XAnnotation.hpp>
  26
  27 #include <memory>
  28 #include <string_view>
  29 #include <vector>
  30 #include <editeng/flditem.hxx>
  31 #include <svx/svdobj.hxx>
  32 #include <svx/fmpage.hxx>
  33 #include <xmloff/autolayout.hxx>
  34 #include "diadef.h"
  35 #include "pres.hxx"
  36 #include "shapelist.hxx"
  37 #include "misc/scopelock.hxx"
  38 #include "sddllapi.h"
  39
  40 namespace com::sun::star::animations {
  41     class XAnimationNode;
  42 }
  43
  44 class SfxStyleSheet;
  45 class SdDrawDocument;
  46 class SdrTextObj;
  47 class SdPageLink;
  48 class SfxItemSet;
  49 class Paragraph;
  50 class Outliner;
  51 class SdStyleSheet;
  52 class Graphic;
  53
  54 namespace sd
  55 {
  56     class MainSequence;
  57     class Annotation;
  58 }
  59
  60 namespace sd {
  61
  62     struct SD_DLLPUBLIC HeaderFooterSettings
  63     {
  64         bool mbHeaderVisible;
  65         OUString maHeaderText;
  66
  67         bool mbFooterVisible;
  68         OUString maFooterText;
  69
  70         bool mbSlideNumberVisible;
  71
  72         bool mbDateTimeVisible;
  73         bool mbDateTimeIsFixed;
  74         OUString maDateTimeText;
  75         SvxDateFormat meDateFormat;
  76         SvxTimeFormat meTimeFormat;
  77
  78         HeaderFooterSettings();
  79
  80         bool operator==( const HeaderFooterSettings& rSettings ) const;
  81     };
  82
  83     typedef std::vector< rtl::Reference< Annotation > > AnnotationVector;
  84 }
  85
  86 namespace sd {
  87     class UndoAnimation;
  88     class UndoTransition;
  89     class UndoGeoObject;
  90     class UndoAttrObject;
  91 }
  92
  93 class SD_DLLPUBLIC SdPage final : public FmFormPage, public SdrObjUserCall
  94 {
  95     SdPage& operator=(const SdPage&) = delete;
  96     SdPage(const SdPage&) = delete;
  97
  98 friend class SdGenericDrawPage;
  99 friend class SdDrawPage;
 100 friend class sd::UndoAnimation;
 101 friend class sd::UndoTransition;
 102 friend class ModifyPageUndoAction;
 103 friend class sd::UndoGeoObject;
 104 friend class sd::UndoAttrObject;
 105
 106     PageKind    mePageKind;               ///< page type
 107     AutoLayout  meAutoLayout;             ///< AutoLayout
 108     sd::ShapeList maPresentationShapeList;///< presentation objects
 109     sd::ScopeLock maLockAutoLayoutArrangement;
 110     bool    mbSelected;               ///< selection identifier
 111     PresChange  mePresChange;             ///< manual / automatic / semi automatic
 112     double      mfTime;                   ///< Display time in seconds
 113     bool    mbSoundOn;                ///< with / without sound.
 114     bool    mbExcluded;               ///< will (not) be displayed during show.
 115     OUString    maLayoutName;             ///< Name of the layout
 116     OUString    maSoundFile;              ///< Path to sound file (MS-DOS notation).
 117     bool        mbLoopSound;
 118     bool        mbStopSound;
 119     OUString    maCreatedPageName;        ///< generated page name by GetPageName.
 120     OUString    maFileName;               ///< file name.
 121     OUString    maBookmarkName;           ///< Bookmark name.
 122     bool    mbScaleObjects;           ///< Objects should be scaled
 123     rtl_TextEncoding meCharSet;           ///< Text encoding
 124     sal_uInt16  mnPaperBin;               ///< PaperBin
 125     SdPageLink* mpPageLink;               ///< Page link (at left sides only)
 126
 127     sd::AnnotationVector    maAnnotations;
 128
 129     /** holds the smil animation sequences for this page */
 130     css::uno::Reference< css::animations::XAnimationNode > mxAnimationNode;
 131
 132     /** a helper class to manipulate effects inside the main sequence */
 133     std::shared_ptr< sd::MainSequence > mpMainSequence;
 134
 135     virtual css::uno::Reference< css::uno::XInterface > createUnoPage() override;
 136
 137     std::unique_ptr<SfxItemSet> mpItems;
 138
 139     SfxItemSet* getOrCreateItems();
 140
 141     sd::HeaderFooterSettings    maHeaderFooterSettings;
 142
 143     // new transition settings
 144     sal_Int16 mnTransitionType;
 145     sal_Int16 mnTransitionSubtype;
 146     bool mbTransitionDirection;
 147     sal_Int32 mnTransitionFadeColor;
 148     double mfTransitionDuration;
 149
 150     void lateInit(const SdPage& rSrcPage);
 151
 152 public:
 153
 154     SdPage(SdDrawDocument& rNewDoc, bool bMasterPage);
 155     virtual ~SdPage() override;
 156
 157     virtual rtl::Reference<SdrPage> CloneSdrPage(SdrModel& rTargetModel) const override;
 158
 159     virtual void    SetSize(const Size& aSize) override;
 160     virtual void    SetBorder(sal_Int32 nLft, sal_Int32 nUpp, sal_Int32 nRgt, sal_Int32 Lwr) override;
 161     virtual void    SetLeftBorder(sal_Int32 nBorder) override;
 162     virtual void    SetRightBorder(sal_Int32 nBorder) override;
 163     virtual void    SetUpperBorder(sal_Int32 nBorder) override;
 164     virtual void    SetLowerBorder(sal_Int32 nBorder) override;
 165     virtual bool    IsReadOnly() const override;
 166
 167     sd::ShapeList&  GetPresentationShapeList() { return maPresentationShapeList; }
 168
 169     void EnsureMasterPageDefaultBackground();
 170     SdrObject* CreatePresObj(PresObjKind eObjKind, bool bVertical, const ::tools::Rectangle& rRect);
 171     rtl::Reference<SdrObject> CreateDefaultPresObj(PresObjKind eObjKind);
 172     void            DestroyDefaultPresObj(PresObjKind eObjKind);
 173     SdrObject*      GetPresObj(PresObjKind eObjKind, int nIndex = 1, bool bFuzzySearch = false );
 174     PresObjKind     GetPresObjKind(SdrObject* pObj) const;
 175     OUString        GetPresObjText(PresObjKind eObjKind) const;
 176     SfxStyleSheet* GetStyleSheetForMasterPageBackground() const;
 177     SfxStyleSheet*  GetStyleSheetForPresObj(PresObjKind eObjKind) const;
 178     sal_Int64       GetHashCode() const;
 179     bool            RestoreDefaultText( SdrObject* pObj );
 180
 181     /** @return true if the given SdrObject is inside the presentation object list */
 182     bool            IsPresObj(const SdrObject* pObj);
 183
 184     /** removes the given SdrObject from the presentation object list */
 185     void            RemovePresObj(const SdrObject* pObj);
 186
 187     /** inserts the given SdrObject into the presentation object list */
 188     void            InsertPresObj(SdrObject* pObj, PresObjKind eKind );
 189
 190     void            SetAutoLayout(AutoLayout eLayout, bool bInit=false, bool bCreate=false);
 191     AutoLayout      GetAutoLayout() const { return meAutoLayout; }
 192     void            CreateTitleAndLayout(bool bInit=false, bool bCreate=false);
 193     SdrObject*      InsertAutoLayoutShape(SdrObject* pObj, PresObjKind eObjKind, bool bVertical, const ::tools::Rectangle& rRect, bool bInit);
 194
 195     virtual void       NbcInsertObject(SdrObject* pObj, size_t nPos=SAL_MAX_SIZE) override;
 196     virtual rtl::Reference<SdrObject> NbcRemoveObject(size_t nObjNum) override;
 197     virtual rtl::Reference<SdrObject> RemoveObject(size_t nObjNum) override;
 198
 199     /** Also override ReplaceObject methods to realize when
 200     objects are removed with this mechanism instead of RemoveObject*/
 201     virtual rtl::Reference<SdrObject> ReplaceObject(SdrObject* pNewObj, size_t nObjNum) override;
 202
 203     void        SetObjText(SdrTextObj* pObj, SdrOutliner* pOutliner, PresObjKind eObjKind, std::u16string_view rStr );
 204
 205     void        SetPageKind(PageKind ePgType)        { mePageKind = ePgType; }
 206     PageKind    GetPageKind() const                  { return mePageKind; }
 207
 208     void        SetSelected(bool bSel)               { mbSelected = bSel; }
 209     bool        IsSelected() const                   { return mbSelected; }
 210
 211     void        SetFadeEffect(css::presentation::FadeEffect eNewEffect);
 212     css::presentation::FadeEffect  GetFadeEffect() const;
 213
 214     void        SetPresChange(PresChange eChange)    { mePresChange = eChange; }
 215     PresChange  GetPresChange() const                { return mePresChange; }
 216
 217     void        SetTime(double fNewTime)             { mfTime = fNewTime; }
 218     double      GetTime() const                      { return mfTime; }
 219
 220     void        SetSound(bool bNewSoundOn)           { mbSoundOn = bNewSoundOn; }
 221     bool        IsSoundOn() const                    { return mbSoundOn; }
 222
 223     void        SetExcluded(bool bNewExcluded)      { mbExcluded = bNewExcluded; }
 224     bool        IsExcluded() const                  { return mbExcluded; }
 225
 226     bool        IsScaleObjects() const              { return mbScaleObjects; }
 227
 228     void        SetSoundFile(const OUString& rStr)    { maSoundFile = rStr; }
 229     const OUString& GetSoundFile() const                { return maSoundFile; }
 230
 231     void        SetLoopSound( bool bLoopSound ) { mbLoopSound = bLoopSound; }
 232     bool        IsLoopSound() const                 { return mbLoopSound; }
 233
 234     void        SetStopSound( bool bStopSound ) { mbStopSound = bStopSound; }
 235     bool        IsStopSound() const             { return mbStopSound; }
 236
 237     sal_Int16   getTransitionType() const { return mnTransitionType;}
 238     void        setTransitionType( sal_Int16 nTransitionType );
 239
 240     sal_Int16   getTransitionSubtype() const { return mnTransitionSubtype;}
 241     void        setTransitionSubtype( sal_Int16 nTransitionSubtype );
 242
 243     bool    getTransitionDirection() const { return mbTransitionDirection;}
 244     void        setTransitionDirection( bool bTransitionbDirection );
 245
 246     sal_Int32   getTransitionFadeColor() const { return mnTransitionFadeColor;}
 247     void        setTransitionFadeColor( sal_Int32 nTransitionFadeColor );
 248
 249     double      getTransitionDuration() const { return mfTransitionDuration;}
 250     void        setTransitionDuration( double fTransitionDuration );
 251
 252     virtual void Changed(const SdrObject& rObj, SdrUserCallType eType,
 253                          const ::tools::Rectangle& rOldBoundRect) override;
 254
 255     void             SetLayoutName(const OUString& aName);
 256     virtual OUString GetLayoutName() const override       { return maLayoutName; }
 257
 258     void            SetFileName(const OUString& aName) { maFileName = aName; }
 259     const OUString& GetFileName() const       { return maFileName; }
 260     void            SetBookmarkName(const OUString& aName) { maBookmarkName = aName; }
 261     const OUString& GetBookmarkName() const       { return maBookmarkName; }
 262
 263     void            ConnectLink();
 264     void            DisconnectLink();
 265
 266     void            ScaleObjects(const Size& rNewPageSize, const ::tools::Rectangle& rNewBorderRect,
 267                          bool bScaleAllObj);
 268
 269     const OUString& GetName() const;
 270     OUString const & GetRealName() const { return FmFormPage::GetName(); };
 271
 272     void            SetPresentationLayout(std::u16string_view rLayoutName,
 273                                   bool bReplaceStyleSheets = true,
 274                                   bool bSetMasterPage = true,
 275                                   bool bReverseOrder = false);
 276     void            EndListenOutlineText();
 277
 278     void    SetPaperBin(sal_uInt16 nBin) { mnPaperBin = nBin; }
 279     sal_uInt16  GetPaperBin() const { return mnPaperBin; }
 280     virtual void        SetOrientation(Orientation eOrient) override;
 281     virtual Orientation GetOrientation() const override;
 282
 283     virtual SfxStyleSheet* GetTextStyleSheetForObject( SdrObject* pObj ) const override;
 284
 285     bool setAlienAttributes( const css::uno::Any& rAttributes );
 286     void getAlienAttributes( css::uno::Any& rAttributes );
 287
 288     /** @return the main animation node
 289
 290         @throws css::uno::RuntimeException
 291     */
 292     css::uno::Reference< css::animations::XAnimationNode > const & getAnimationNode();
 293
 294     /** sets the main animation node
 295
 296         @throws css::uno::RuntimeException
 297     */
 298     void setAnimationNode( css::uno::Reference< css::animations::XAnimationNode > const & xNode );
 299
 300     /// @return a helper class to manipulate effects inside the main sequence
 301     std::shared_ptr< sd::MainSequence > const & getMainSequence();
 302
 303     /** quick check if this slide has an animation node.
 304         This can be used to have a cost free check if there are no animations ad this slide.
 305         If it returns true this does not mean that there are animations available.
 306     */
 307     bool hasAnimationNode() const;
 308
 309     /// @return the SdPage implementation for the given XDrawPage or 0 if not available
 310     static SdPage* getImplementation( const css::uno::Reference< css::drawing::XDrawPage >& xPage );
 311
 312     /** removes all custom animations for the given shape */
 313     void removeAnimations( const SdrObject* pObj );
 314
 315     /** Notify that the object has been renamed and the animation effects has to update. */
 316     void notifyObjectRenamed(const SdrObject* pObj);
 317
 318     /** Set the name of the page and broadcast a model change.
 319     */
 320     void SetName (const OUString& rName);
 321
 322     const sd::HeaderFooterSettings& getHeaderFooterSettings() const;
 323     void setHeaderFooterSettings( const sd::HeaderFooterSettings& rNewSettings );
 324
 325     /**
 326         @return true if the object from the ViewObjectContact should
 327         be visible on this page while rendering.
 328
 329         bEdit selects if visibility test is for an editing view or a final render,
 330         like printing.
 331     */
 332     virtual bool checkVisibility(
 333         const sdr::contact::ViewObjectContact& rOriginal,
 334         const sdr::contact::DisplayInfo& rDisplayInfo,
 335         bool bEdit ) override;
 336
 337     /** callback from the sd::View when a new paragraph for one object on this page is created */
 338     void onParagraphInserted( const ::Outliner* pOutliner, Paragraph const * pPara, SdrObject* pObj );
 339
 340     /** callback from the sd::View when a paragraph from one object on this page is removed */
 341     void onParagraphRemoving( const ::Outliner* pOutliner, Paragraph const * pPara, SdrObject* pObj );
 342
 343     /** callback from the sd::View when an object just left text edit mode */
 344     void onEndTextEdit( SdrObject* pObj );
 345
 346     /** @return the presentation style with the given helpid from this masterpage or this
 347         slides masterpage */
 348     SdStyleSheet* getPresentationStyle( sal_uInt32 nHelpId ) const;
 349
 350     /** removes all empty presentation objects from this slide */
 351     void RemoveEmptyPresentationObjects();
 352
 353     ::tools::Rectangle   GetTitleRect() const;
 354     ::tools::Rectangle   GetLayoutRect() const;
 355
 356     static void CalculateHandoutAreas( SdDrawDocument& rModel, AutoLayout eLayout, bool bHorizontal, std::vector< ::tools::Rectangle >& rAreas );
 357
 358     /** Set the "precious" flag to the given value.
 359     */
 360     void SetPrecious (const bool bIsPrecious);
 361
 362     /** The "precious" flag is used for master pages to prevent some unused
 363         master pages from being deleted automatically.  For pages
 364         other than master pages this flag can be ignored.
 365         @return
 366             When this method returns <TRUE/> for a master page then this
 367             master page should not be deleted automatically.
 368     */
 369     bool IsPrecious() const { return mbIsPrecious; }
 370
 371     void createAnnotation( rtl::Reference< sd::Annotation >& xAnnotation );
 372     void addAnnotation( const rtl::Reference< sd::Annotation >& xAnnotation, int nIndex );
 373     void removeAnnotation( const rtl::Reference< sd::Annotation >& xAnnotation );
 374     const sd::AnnotationVector& getAnnotations() const { return maAnnotations; }
 375     bool Equals(const SdPage&) const;
 376     virtual void dumpAsXml(xmlTextWriterPtr pWriter) const override;
 377     sal_uInt16 getPageId() const { return mnPageId; }
 378
 379     /**
 380      Returns graphics objects from the page that can be prefetched before it's painted.
 381      The pointers are temporary and should not be kept.
 382     */
 383     void getGraphicsForPrefetch(std::vector<Graphic*>& graphics) const;
 384
 385     static sal_uInt16 mnLastPageId;
 386
 387 private:
 388     bool mbIsPrecious;
 389
 390     // page id of this page
 391     sal_uInt16 mnPageId;
 392
 393     /** clone the animations from this and set them to rTargetPage
 394      *  TTTT: Order is strange, should be the other way around by
 395      *  convention/convenience and makes usage a little dangerous...
 396     */
 397     void cloneAnimations( SdPage& rTargetPage ) const;
 398
 399     /** called before a shape is removed or replaced from this slide */
 400     void onRemoveObject( SdrObject* pObject );
 401 };
 402
 403 #endif // INCLUDED_SD_INC_SDPAGE_HXX
 404
 405 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */