sd/inc/drawdoc.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 #pragma once
  21
  22 #include <com/sun/star/text/WritingMode.hpp>
  23 #include <svl/style.hxx>
  24 #include <svx/fmmodel.hxx>
  25 #include <unotools/charclass.hxx>
  26 #include <vcl/prntypes.hxx>
  27 #include <xmloff/autolayout.hxx>
  28
  29 #include <vector>
  30 #include <memory>
  31 #include <optional>
  32 #include <string_view>
  33
  34 #include "sddllapi.h"
  35 #include "pres.hxx"
  36
  37 namespace com::sun::star::xml::dom { class XNode; }
  38 namespace com::sun::star::uno { class XInterface; }
  39 namespace vcl { class Font; }
  40 namespace com::sun::star::presentation { class XPresentation2; }
  41 class SdOutliner;
  42 class Timer;
  43 class SfxObjectShell;
  44 class SdPage;
  45 class SdAnimationInfo;
  46 class SdStyleSheetPool;
  47 class SfxMedium;
  48 class SvxSearchItem;
  49 class EditStatus;
  50 class Point;
  51 class SdTransferable;
  52 struct SpellCallbackInfo;
  53 class SdCustomShowList;
  54 class SdUndoGroup;
  55 class SdrObject;
  56 class Idle;
  57 class ImageMap;
  58 class Outliner;
  59 class SdrModel;
  60 class SdrOutliner;
  61 class SdrPage;
  62 class SdrTextObj;
  63 class SfxItemPool;
  64 class Size;
  65
  66 namespace sd
  67 {
  68 class DrawDocShell;
  69 #ifndef SV_DECL_DRAW_DOC_SHELL_DEFINED
  70 #define SV_DECL_DRAW_DOC_SHELL_DEFINED
  71 typedef ::tools::SvRef<DrawDocShell> DrawDocShellRef;
  72 #endif
  73 class UndoManager;
  74 class ShapeList;
  75 class FrameView;
  76 }
  77
  78 class ImpDrawPageListWatcher;
  79 class ImpMasterPageListWatcher;
  80
  81 struct StyleReplaceData
  82 {
  83     SfxStyleFamily  nFamily;
  84     SfxStyleFamily  nNewFamily;
  85     OUString        aName;
  86     OUString        aNewName;
  87 };
  88
  89 enum class DocCreationMode
  90 {
  91     New,
  92     Loaded
  93 };
  94
  95 namespace sd
  96 {
  97     struct PresentationSettings
  98     {
  99         OUString maPresPage;
 100         bool mbAll;
 101         bool mbEndless;
 102         bool mbCustomShow;
 103         bool mbManual;
 104         bool mbMouseVisible;
 105         bool mbMouseAsPen;
 106         bool mbLockedPages;
 107         bool mbAlwaysOnTop;
 108         bool mbUseNavigation;
 109         bool mbFullScreen;
 110         bool mbAnimationAllowed;
 111         sal_Int32 mnPauseTimeout;
 112         bool mbShowPauseLogo;
 113         bool mbStartCustomShow;
 114
 115         PresentationSettings();
 116     };
 117 }
 118
 119 // SdDrawDocument
 120 class SD_DLLPUBLIC SdDrawDocument final : public FmFormModel
 121 {
 122 public:
 123     SAL_DLLPRIVATE void setDocAccTitle( const OUString& rTitle ) { msDocAccTitle = rTitle; }
 124     SAL_DLLPRIVATE const OUString& getDocAccTitle() const { return msDocAccTitle; }
 125     SAL_DLLPRIVATE bool getDocReadOnly() const { return m_bReadOnly; }
 126 private:
 127     OUString            msDocAccTitle;
 128     std::unique_ptr<SdOutliner>
 129                         mpOutliner;          ///< local outliner for outline mode
 130     std::unique_ptr<SdOutliner>
 131                         mpInternalOutliner;  ///< internal outliner for creation of text objects
 132     std::unique_ptr<Timer> mpWorkStartupTimer;
 133     std::unique_ptr<Idle>
 134                         mpOnlineSpellingIdle;
 135     std::unique_ptr<sd::ShapeList>
 136                         mpOnlineSpellingList;
 137     std::unique_ptr<SvxSearchItem>
 138                         mpOnlineSearchItem;
 139     std::vector<std::unique_ptr<sd::FrameView>>
 140                         maFrameViewList;
 141     std::unique_ptr<SdCustomShowList>   mpCustomShowList;
 142     ::sd::DrawDocShell* mpDocSh;
 143     SdTransferable *    mpCreatingTransferable;
 144     bool                mbHasOnlineSpellErrors;
 145     bool                mbInitialOnlineSpellingEnabled;
 146     OUString            maBookmarkFile;
 147     ::sd::DrawDocShellRef   mxBookmarkDocShRef;
 148
 149     sd::PresentationSettings maPresentationSettings;
 150
 151     css::uno::Reference< css::presentation::XPresentation2 > mxPresentation;
 152
 153     bool                mbNewOrLoadCompleted;
 154
 155     bool                mbOnlineSpell;
 156     bool                mbSummationOfParagraphs;
 157     bool                mbStartWithPresentation;        ///< is set to true when starting with command line parameter -start
 158     bool                mbExitAfterPresenting;         ///< true if mbStartWithPresentation AND Presentation was shown fully
 159     LanguageType        meLanguage;
 160     LanguageType        meLanguageCJK;
 161     LanguageType        meLanguageCTL;
 162     SvxNumType          mePageNumType;
 163     ::sd::DrawDocShellRef   mxAllocedDocShRef;   // => AllocModel()
 164     bool                mbAllocDocSh;       // => AllocModel()
 165     DocumentType        meDocType;
 166     std::optional<CharClass>
 167                         moCharClass;
 168
 169     ::std::unique_ptr<ImpDrawPageListWatcher> mpDrawPageListWatcher;
 170     ::std::unique_ptr<ImpMasterPageListWatcher> mpMasterPageListWatcher;
 171
 172     SAL_DLLPRIVATE void                UpdatePageObjectsInNotes(sal_uInt16 nStartPos);
 173     SAL_DLLPRIVATE void                UpdatePageRelativeURLs(SdPage const * pPage, sal_uInt16 nPos, sal_Int32 nIncrement);
 174     SAL_DLLPRIVATE void                FillOnlineSpellingList(SdPage const * pPage);
 175     SAL_DLLPRIVATE void                SpellObject(SdrTextObj* pObj);
 176
 177                         DECL_DLLPRIVATE_LINK(WorkStartupHdl, Timer *, void);
 178                         DECL_DLLPRIVATE_LINK(OnlineSpellingHdl, Timer *, void);
 179                         DECL_DLLPRIVATE_LINK(OnlineSpellEventHdl, EditStatus&, void);
 180
 181     std::vector< OUString > maAnnotationAuthors;
 182     std::vector<css::uno::Reference< css::xml::dom::XNode> > maLayoutInfo;
 183
 184     std::vector<css::uno::Reference< css::xml::dom::XNode> > maPresObjectInfo;
 185
 186     bool mbEmbedFonts : 1;
 187     bool mbEmbedUsedFontsOnly : 1;
 188     bool mbEmbedFontScriptLatin : 1;
 189     bool mbEmbedFontScriptAsian : 1;
 190     bool mbEmbedFontScriptComplex : 1;
 191
 192     sal_Int32 mnImagePreferredDPI;
 193
 194     SAL_DLLPRIVATE virtual css::uno::Reference< css::uno::XInterface > createUnoModel() override;
 195
 196 public:
 197
 198
 199     SAL_DLLPRIVATE SdDrawDocument(DocumentType eType, SfxObjectShell* pDocSh);
 200     SAL_DLLPRIVATE virtual ~SdDrawDocument() override;
 201
 202     // Adapt to given Size and Borders scaling all contained data, maybe
 203     // including PresObj's in higher derivations
 204     virtual void adaptSizeAndBorderForAllPages(
 205         const Size& rNewSize,
 206         tools::Long nLeft = 0,
 207         tools::Long nRight = 0,
 208         tools::Long nUpper = 0,
 209         tools::Long nLower = 0) override;
 210
 211     // Adapt PageSize for all Pages of PageKind ePageKind. Also
 212     // set Borders to left/right/upper/lower, ScaleAll, Orientation,
 213     // PaperBin and BackgroundFullSize. Create Undo-Actions when
 214     // a SdUndoGroup is given (then used from the View probably)
 215     void AdaptPageSizeForAllPages(
 216         const Size& rNewSize,
 217         PageKind ePageKind,
 218         SdUndoGroup* pUndoGroup = nullptr,
 219         tools::Long nLeft = 0,
 220         tools::Long nRight = 0,
 221         tools::Long nUpper = 0,
 222         tools::Long nLower = 0,
 223         bool bScaleAll = false,
 224         Orientation eOrientation = Orientation::Landscape,
 225         sal_uInt16 nPaperBin = 0,
 226         bool bBackgroundFullSize = false);
 227
 228     SAL_DLLPRIVATE SdDrawDocument*     AllocSdDrawDocument() const;
 229     SAL_DLLPRIVATE virtual SdrModel*   AllocModel() const override; //forwards to AllocSdDrawDocument
 230
 231     SAL_DLLPRIVATE rtl::Reference<SdPage>          AllocSdPage(bool bMasterPage);
 232     SAL_DLLPRIVATE virtual rtl::Reference<SdrPage> AllocPage(bool bMasterPage) override; //forwards to AllocSdPage
 233
 234     SAL_DLLPRIVATE virtual bool        IsReadOnly() const override;
 235     SAL_DLLPRIVATE virtual void        SetChanged(bool bFlag = true) override;
 236
 237     SAL_DLLPRIVATE SfxItemPool&        GetPool() { return( *m_pItemPool ); }
 238
 239     SAL_DLLPRIVATE SdOutliner* GetOutliner(bool bCreateOutliner=true);
 240     SdOutliner* GetInternalOutliner(bool bCreateOutliner=true);
 241
 242     SAL_DLLPRIVATE ::sd::DrawDocShell*     GetDocSh() const { return mpDocSh; }
 243
 244     SAL_DLLPRIVATE LanguageType        GetLanguage( const sal_uInt16 nId ) const;
 245     SAL_DLLPRIVATE void                SetLanguage( const LanguageType eLang, const sal_uInt16 nId );
 246
 247     SAL_DLLPRIVATE SvxNumType          GetPageNumType() const override;
 248     SAL_DLLPRIVATE void                SetPageNumType(SvxNumType eType) { mePageNumType = eType; }
 249     OUString CreatePageNumValue(sal_uInt16 nNum) const;
 250
 251     SAL_DLLPRIVATE DocumentType        GetDocumentType() const { return meDocType; }
 252
 253     SAL_DLLPRIVATE void                SetAllocDocSh(bool bAlloc);
 254
 255     SAL_DLLPRIVATE void                CreatingDataObj( SdTransferable* pTransferable ) { mpCreatingTransferable = pTransferable; }
 256     SAL_DLLPRIVATE virtual bool        IsCreatingDataObj() const override { return mpCreatingTransferable != nullptr; }
 257
 258     /** if the document does not contain at least one handout, one slide and one notes page with
 259         at least one master each this methods creates them.
 260         If a reference document is given, the sizes and border settings of that document are used
 261         for newly created slides.
 262     */
 263     void   CreateFirstPages( SdDrawDocument const * pRefDocument = nullptr );
 264     bool                CreateMissingNotesAndHandoutPages();
 265
 266     SAL_DLLPRIVATE void                MovePage(sal_uInt16 nPgNum, sal_uInt16 nNewPos) override;
 267     SAL_DLLPRIVATE void                InsertPage(SdrPage* pPage, sal_uInt16 nPos=0xFFFF) override;
 268     SAL_DLLPRIVATE void                DeletePage(sal_uInt16 nPgNum) override;
 269     SAL_DLLPRIVATE rtl::Reference<SdrPage> RemovePage(sal_uInt16 nPgNum) override;
 270
 271     SAL_DLLPRIVATE virtual void     InsertMasterPage(SdrPage* pPage, sal_uInt16 nPos=0xFFFF) override;
 272     SAL_DLLPRIVATE virtual rtl::Reference<SdrPage> RemoveMasterPage(sal_uInt16 nPgNum) override;
 273
 274     SAL_DLLPRIVATE void                RemoveUnnecessaryMasterPages( SdPage* pMaster=nullptr, bool bOnlyDuplicatePages=false, bool bUndo=true );
 275     void   SetMasterPage(sal_uInt16 nSdPageNum, std::u16string_view rLayoutName,
 276                                       SdDrawDocument* pSourceDoc, bool bMaster, bool bCheckMasters);
 277
 278     SdDrawDocument* OpenBookmarkDoc(const OUString& rBookmarkFile);
 279     SAL_DLLPRIVATE SdDrawDocument* OpenBookmarkDoc(SfxMedium* pMedium);
 280
 281     SAL_DLLPRIVATE void InsertBookmark(const std::vector<OUString> &rBookmarkList,
 282                             std::vector<OUString> &rExchangeList, bool bLink,
 283                             sal_uInt16 nPgPos,
 284                             ::sd::DrawDocShell* pBookmarkDocSh,
 285                             Point const * pObjPos);
 286
 287     SAL_DLLPRIVATE bool IsStartWithPresentation() const { return mbStartWithPresentation;}
 288     SAL_DLLPRIVATE void SetStartWithPresentation( bool bStartWithPresentation );
 289
 290     SAL_DLLPRIVATE bool IsExitAfterPresenting() const { return mbExitAfterPresenting;}
 291     SAL_DLLPRIVATE void SetExitAfterPresenting( bool bExitAfterPresenting );
 292
 293     /// load xml-based impress layout definitions into document
 294     SAL_DLLPRIVATE void InitLayoutVector();
 295     /// return reference to vector of Impress layout definitions
 296     SAL_DLLPRIVATE const std::vector<css::uno::Reference< css::xml::dom::XNode> >& GetLayoutVector() const
 297     { return maLayoutInfo; }
 298
 299    /// load xml-based impress master presentation object definitions into document
 300     SAL_DLLPRIVATE void InitObjectVector();
 301     /// return reference to vector of master presentation object definitions
 302     SAL_DLLPRIVATE const std::vector<css::uno::Reference<css::xml::dom::XNode> >& GetObjectVector() const { return maPresObjectInfo; }
 303     /** Insert pages into this document
 304
 305         This method inserts whole pages into this document, either
 306         selected ones (specified via pBookmarkList/pExchangeList), or
 307         all from the source document.
 308
 309         @attention Beware! This method in its current state does not
 310         handle all combinations of their input parameters
 311         correctly. For example, for pBookmarkList=NULL, bReplace=true
 312         is ignored (no replace happens).
 313
 314         @param pBookmarkList
 315         A list of strings, denoting the names of the pages to be copied
 316
 317         @param pExchangeList
 318         A list of strings, denoting the names of the pages to be renamed
 319
 320         @param bLink
 321         Whether the inserted pages should be linked to the bookmark document
 322
 323         @param bReplace
 324         Whether the pages should not be inserted, but replace the pages in
 325         the destination document
 326
 327         @param nPgPos
 328         Insertion point/start of replacement
 329
 330         @param bNoDialogs
 331         Whether query dialogs are allowed (e.g. for page scaling)
 332
 333         @param pBookmarkDocSh
 334         DocShell of the source document (used e.g. to extract the filename
 335         for linked pages)
 336
 337         @param bCopy
 338         Whether the source document should be treated as immutable (i.e.
 339         inserted pages are not removed from it, but cloned)
 340
 341         @param bMergeMasterPages
 342         Whether the source document's master pages should be copied, too.
 343
 344         @param bPreservePageNames
 345         Whether the replace operation should take the name from the new
 346         page, or preserve the old name
 347      */
 348
 349     SAL_DLLPRIVATE bool InsertBookmarkAsPage(const std::vector<OUString> &rBookmarkList,
 350                                   std::vector<OUString> *pExchangeList,
 351                               bool bLink, bool bReplace, sal_uInt16 nPgPos,
 352                               bool bNoDialogs, ::sd::DrawDocShell* pBookmarkDocSh,
 353                               bool bCopy, bool bMergeMasterPages,
 354                               bool bPreservePageNames);
 355
 356     SAL_DLLPRIVATE bool InsertBookmarkAsObject(const std::vector<OUString> &rBookmarkList,
 357                                     const std::vector<OUString> &rExchangeList,
 358                                     ::sd::DrawDocShell* pBookmarkDocSh,
 359                                     Point const * pObjPos, bool bCalcObjCount);
 360
 361     void   CloseBookmarkDoc();
 362
 363     SAL_DLLPRIVATE SdrObject*          GetObj(std::u16string_view rObjName) const;
 364
 365     /** Return the first page that has the given name.  Regular pages and
 366         notes pages are searched first.  When not found then the master
 367         pages are searched.
 368         @param rPgName
 369             Name of the page to return.
 370         @param rbIsMasterPage
 371             Is set by the method to indicate whether the returned index
 372             belongs to a master page (<TRUE/>) or a regular or notes page
 373             (<FALSE/>). The given value is ignored.
 374         @return
 375             Returns the index of the page with the given name or
 376             SDRPAGE_NOTFOUND (=0xffff) when such a page does not exist.
 377     */
 378     SAL_DLLPRIVATE sal_uInt16 GetPageByName(std::u16string_view rPgName, bool& rbIsMasterPage ) const;
 379     /** checks, if the given name is a *unique* name for an *existing* slide
 380
 381         @param rPageName the name of an existing slide
 382
 383         @return true, if the name is unique and the slide exists
 384     */
 385     bool IsPageNameUnique( std::u16string_view rPageName ) const;
 386     SdPage*GetSdPage(sal_uInt16 nPgNum, PageKind ePgKind) const;
 387     sal_uInt16 GetSdPageCount(PageKind ePgKind) const;
 388
 389     SAL_DLLPRIVATE void                SetSelected(SdPage* pPage, bool bSelect);
 390     SAL_DLLPRIVATE void                UnselectAllPages();
 391     SAL_DLLPRIVATE bool                MovePages(sal_uInt16 nTargetPage);
 392
 393     SdPage*GetMasterSdPage(sal_uInt16 nPgNum, PageKind ePgKind);
 394     sal_uInt16 GetMasterSdPageCount(PageKind ePgKind) const;
 395
 396     sal_uInt16 GetActiveSdPageCount() const;
 397
 398     SAL_DLLPRIVATE sal_uInt16              GetMasterPageUserCount(SdrPage const * pMaster) const;
 399
 400     SAL_DLLPRIVATE const sd::PresentationSettings& getPresentationSettings() const { return maPresentationSettings; }
 401     SAL_DLLPRIVATE sd::PresentationSettings& getPresentationSettings() { return maPresentationSettings; }
 402
 403     SAL_DLLPRIVATE const css::uno::Reference< css::presentation::XPresentation2 >& getPresentation() const;
 404
 405     SAL_DLLPRIVATE void                SetSummationOfParagraphs( bool bOn = true ) { mbSummationOfParagraphs = bOn; }
 406     SAL_DLLPRIVATE bool            IsSummationOfParagraphs() const { return mbSummationOfParagraphs; }
 407
 408     /** Set the mode that controls whether (and later how) the formatting of the document
 409         depends on the current printer metrics.
 410         @param nMode
 411             Use <const
 412             scope="css::document::PrinterIndependentLayout">ENABLED</const>
 413             to make formatting printer-independent and <const
 414             scope="css::document::PrinterIndependentLayout">DISABLED</const>
 415             to make formatting depend on the current printer metrics.
 416     */
 417     SAL_DLLPRIVATE void SetPrinterIndependentLayout (sal_Int32 nMode);
 418
 419     /** Get the flag that controls whether the formatting of the document
 420         depends on the current printer metrics.
 421         @return
 422             Use <const
 423             scope="css::document::PrinterIndependentLayout">ENABLED</const>
 424             when formatting is printer-independent and <const
 425             scope="css::document::PrinterIndependentLayout">DISABLED</const>
 426             when formatting depends on the current printer metrics.
 427     */
 428     SAL_DLLPRIVATE sal_Int32 GetPrinterIndependentLayout() const { return mnPrinterIndependentLayout;}
 429
 430     SAL_DLLPRIVATE void                SetOnlineSpell( bool bIn );
 431     SAL_DLLPRIVATE bool                GetOnlineSpell() const { return mbOnlineSpell; }
 432     SAL_DLLPRIVATE void                StopOnlineSpelling();
 433     SAL_DLLPRIVATE void                StartOnlineSpelling(bool bForceSpelling=true);
 434
 435     SAL_DLLPRIVATE void                ImpOnlineSpellCallback(SpellCallbackInfo const * pInfo, SdrObject* pObj, SdrOutliner const * pOutl);
 436
 437     SAL_DLLPRIVATE void                InsertObject(SdrObject* pObj);
 438     SAL_DLLPRIVATE void                RemoveObject(SdrObject* pObj);
 439
 440     SAL_DLLPRIVATE sal_uLong           GetLinkCount() const;
 441
 442     SAL_DLLPRIVATE std::vector<std::unique_ptr<sd::FrameView>>& GetFrameViewList() { return maFrameViewList; }
 443     SdCustomShowList* GetCustomShowList(bool bCreate = false);
 444
 445     SAL_DLLPRIVATE void                NbcSetChanged(bool bFlag);
 446
 447     SAL_DLLPRIVATE void                SetTextDefaults() const;
 448
 449     SAL_DLLPRIVATE void                CreateLayoutTemplates();
 450     SAL_DLLPRIVATE void                RenameLayoutTemplate(const OUString& rOldLayoutName, const OUString& rNewName);
 451
 452     SAL_DLLPRIVATE void                CreateDefaultCellStyles();
 453
 454     void   StopWorkStartupDelay();
 455
 456     SAL_DLLPRIVATE void                NewOrLoadCompleted(DocCreationMode eMode);
 457     SAL_DLLPRIVATE void                NewOrLoadCompleted( SdPage* pPage, SdStyleSheetPool* pSPool );
 458     SAL_DLLPRIVATE bool                IsNewOrLoadCompleted() const {return mbNewOrLoadCompleted; }
 459
 460     SAL_DLLPRIVATE ::sd::FrameView* GetFrameView(sal_uLong nPos) {
 461         return nPos < maFrameViewList.size() ? maFrameViewList[nPos].get() : nullptr; }
 462
 463     /** deprecated*/
 464     SAL_DLLPRIVATE static SdAnimationInfo* GetAnimationInfo(SdrObject* pObject);
 465
 466     static     SdAnimationInfo* GetShapeUserData(SdrObject& rObject, bool bCreate = false );
 467
 468     SAL_DLLPRIVATE const std::optional<CharClass>& GetCharClass() const { return moCharClass; }
 469
 470     SAL_DLLPRIVATE void                UpdateAllLinks();
 471
 472     SAL_DLLPRIVATE void                CheckMasterPages();
 473
 474     SAL_DLLPRIVATE void                Merge(SdrModel& rSourceModel,
 475                                 sal_uInt16 nFirstPageNum, sal_uInt16 nLastPageNum,
 476                                 sal_uInt16 nDestPos,
 477                                 bool bMergeMasterPages, bool bAllMasterPages,
 478                                 bool bUndo = true, bool bTreadSourceAsConst = false) override;
 479
 480     css::text::WritingMode GetDefaultWritingMode() const;
 481     SAL_DLLPRIVATE void SetDefaultWritingMode( css::text::WritingMode eMode );
 482
 483     /** replacespOldPage from all custom shows with pNewPage or removes pOldPage from
 484         all custom shows if pNewPage is 0.
 485     */
 486     SAL_DLLPRIVATE void ReplacePageInCustomShows( const SdPage* pOldPage, const SdPage* pNewPage );
 487
 488 public:
 489
 490     /// static to prevent recursions while resolving links
 491     SAL_DLLPRIVATE static SdDrawDocument* s_pDocLockedInsertingLinks;
 492
 493     /** Create and insert a set of two new pages: a standard (draw) page and
 494         the associated notes page.  The new pages are inserted directly
 495         after the specified page set.
 496         @param pCurrentPage
 497             This page is used to retrieve the layout for the page to
 498             create.
 499         @param ePageKind
 500             This specifies whether <argument>pCurrentPage</argument> is a
 501             standard (draw) page or a notes page.
 502         @param sStandardPageName
 503             Name of the standard page.  An empty string leads to using an
 504             automatically created name.
 505         @param sNotesPageName
 506             Name of the standard page.  An empty string leads to using an
 507             automatically created name.
 508         @param eStandardLayout
 509             Layout to use for the new standard page.  Note that this layout
 510             is not used when the given <argument>pCurrentPage</argument> is
 511             not a standard page.  In this case the layout is taken from the
 512             standard page associated with <argument>pCurrentPage</argument>.
 513         @param eNotesLayout
 514             Layout to use for the new notes page.  Note that this layout
 515             is not used when the given <argument>pCurrentPage</argument> is
 516             not a notes page.  In this case the layout is taken from the
 517             notes page associated with <argument>pCurrentPage</argument>.
 518         @param bIsPageBack
 519             This flag indicates whether to show the background shape.
 520         @param bIsPageObj
 521             This flag indicates whether to show the shapes on the master page.
 522         @param nInsertPosition
 523             Position where to insert the standard page.  When -1 then the
 524             new page set is inserted after the current page.
 525
 526         @return
 527             Returns an index of the inserted pages that can be used with the
 528             <member>GetSdPage()</member> method.
 529     */
 530     SAL_DLLPRIVATE sal_uInt16 CreatePage (
 531         SdPage* pCurrentPage,
 532         PageKind ePageKind,
 533         const OUString& sStandardPageName,
 534         const OUString& sNotesPageName,
 535         AutoLayout eStandardLayout,
 536         AutoLayout eNotesLayout,
 537         bool bIsPageBack,
 538         bool bIsPageObj,
 539         const sal_Int32 nInsertPosition);
 540
 541     /** This method acts as a simplified front end for the more complex
 542         <member>DuplicatePage()</member> method.
 543         @param nPageNum
 544             The page number as passed to the <member>GetSdPage()</member>
 545             method for which the standard page and the notes page are to be
 546             copied.
 547         @return
 548             Returns an index of the inserted pages that can be used with the
 549             <member>GetSdPage()</member> method.
 550     */
 551     SAL_DLLPRIVATE sal_uInt16 DuplicatePage (sal_uInt16 nPageNum);
 552
 553     /** Create and insert a set of two new pages that are copies of the
 554         given <argument>pCurrentPage</argument> and its associated notes
 555         resp. standard page.  The copies are inserted directly after the
 556         specified page set.
 557         @param pCurrentPage
 558             This page and its associated notes/standard page is copied.
 559         @param ePageKind
 560             This specifies whether <argument>pCurrentPage</argument> is a
 561             standard (draw) page or a notes page.
 562         @param sStandardPageName
 563             Name of the standard page.  An empty string leads to using an
 564             automatically created name.
 565         @param sNotesPageName
 566             Name of the standard page.  An empty string leads to using an
 567             automatically created name.
 568         @param bIsPageBack
 569             This flag indicates whether to show the background shape.
 570         @param bIsPageObj
 571             This flag indicates whether to show the shapes on the master page.
 572         @param nInsertPosition
 573             Position where to insert the standard page.  When -1 then the
 574             new page set is inserted after the current page.
 575
 576         @return
 577             Returns an index of the inserted pages that can be used with the
 578             <member>GetSdPage()</member> method.
 579     */
 580     SAL_DLLPRIVATE sal_uInt16 DuplicatePage (
 581         SdPage* pCurrentPage,
 582         PageKind ePageKind,
 583         const OUString& sStandardPageName,
 584         const OUString& sNotesPageName,
 585         bool bIsPageBack,
 586         bool bIsPageObj,
 587         const sal_Int32 nInsertPosition);
 588
 589     /** return the document fonts for latin, cjk and ctl according to the current
 590         languages set at this document */
 591     SAL_DLLPRIVATE void getDefaultFonts( vcl::Font& rLatinFont, vcl::Font& rCJKFont, vcl::Font& rCTLFont );
 592
 593     sd::UndoManager* GetUndoManager() const;
 594
 595     /** converts the given western font height to a corresponding ctl font height, depending on the system language */
 596     SAL_DLLPRIVATE static sal_uInt32 convertFontHeightToCTL( sal_uInt32 nWesternFontHeight );
 597
 598     /** Get the style sheet pool if it was a SdStyleSheetPool.
 599      */
 600     SdStyleSheetPool* GetSdStyleSheetPool() const;
 601
 602     SAL_DLLPRIVATE void UpdatePageRelativeURLs(
 603         std::u16string_view aOldName, std::u16string_view aNewName);
 604
 605     SAL_DLLPRIVATE static void SetCalcFieldValueHdl( ::Outliner* pOutliner);
 606
 607     SAL_DLLPRIVATE sal_uInt16 GetAnnotationAuthorIndex( const OUString& rAuthor );
 608
 609     SAL_DLLPRIVATE bool IsEmbedFonts() const { return mbEmbedFonts; }
 610     SAL_DLLPRIVATE bool IsEmbedUsedFontsOnly() const { return mbEmbedUsedFontsOnly; }
 611     SAL_DLLPRIVATE bool IsEmbedFontScriptLatin() const { return mbEmbedFontScriptLatin; }
 612     SAL_DLLPRIVATE bool IsEmbedFontScriptAsian() const { return mbEmbedFontScriptAsian; }
 613     SAL_DLLPRIVATE bool IsEmbedFontScriptComplex() const { return mbEmbedFontScriptComplex; }
 614
 615     SAL_DLLPRIVATE void SetEmbedFonts(bool bUse) { mbEmbedFonts = bUse; }
 616     SAL_DLLPRIVATE void SetEmbedUsedFontsOnly(bool bUse) { mbEmbedUsedFontsOnly = bUse; }
 617     SAL_DLLPRIVATE void SetEmbedFontScriptLatin(bool bUse) { mbEmbedFontScriptLatin = bUse; }
 618     SAL_DLLPRIVATE void SetEmbedFontScriptAsian(bool bUse) { mbEmbedFontScriptAsian = bUse; }
 619     SAL_DLLPRIVATE void SetEmbedFontScriptComplex(bool bUse) { mbEmbedFontScriptComplex = bUse; }
 620
 621     sal_Int32 getImagePreferredDPI() const override { return mnImagePreferredDPI; }
 622     void setImagePreferredDPI(sal_Int32 nValue) { mnImagePreferredDPI = nValue; }
 623
 624     void dumpAsXml(xmlTextWriterPtr pWriter) const override;
 625
 626 private:
 627     /** This member stores the printer independent layout mode.  Please
 628         refer to <member>SetPrinterIndependentLayout()</member> for its
 629         values.
 630     */
 631     sal_Int32 mnPrinterIndependentLayout;
 632
 633     /** Insert a given set of standard and notes page after the given <argument>pCurrentPage</argument>.
 634         @param pCurrentPage
 635             This page and its associated notes/standard page is copied.
 636         @param ePageKind
 637             This specifies whether <argument>pCurrentPage</argument> is a
 638             standard (draw) page or a notes page.
 639         @param sStandardPageName
 640             Name of the standard page.  An empty string leads to using an
 641             automatically created name.
 642         @param sNotesPageName
 643             Name of the standard page.  An empty string leads to using an
 644             automatically created name.
 645         @param bIsPageBack
 646             This flag indicates whether to show the background shape.
 647         @param bIsPageObj
 648             This flag indicates whether to show the shapes on the master page.
 649         @param pStandardPage
 650             The standard page to insert.
 651         @param pNotesPage
 652             The notes page to insert.
 653         @param nInsertPosition
 654             Position where to insert the standard page.  When -1 then the
 655             new page set is inserted after the current page.
 656
 657         @return
 658             Returns an index of the inserted pages that can be used with the
 659             <member>GetSdPage()</member> method.
 660     */
 661     SAL_DLLPRIVATE sal_uInt16 InsertPageSet (
 662         SdPage* pCurrentPage,
 663         PageKind ePageKind,
 664         const OUString& sStandardPageName,
 665         const OUString& sNotesPageName,
 666         bool bIsPageBack,
 667         bool bIsPageObj,
 668         SdPage* pStandardPage,
 669         SdPage* pNotesPage,
 670         sal_Int32 nInsertPosition);
 671
 672     /** Set up a newly created page and insert it into the list of pages.
 673         @param pPreviousPage
 674             A page to take the size and border geometry from.
 675         @param pPage
 676             This is the page to set up and insert.
 677         @param sPageName
 678             The name of the new page.
 679         @param nInsertionPoint
 680             Index of the page before which the new page will be inserted.
 681         @param bIsPageBack
 682             This flag indicates whether to show the background shape.
 683         @param bIsPageObj
 684             This flag indicates whether to show the shapes on the master
 685             page.
 686     */
 687     SAL_DLLPRIVATE void SetupNewPage (
 688         SdPage const * pPreviousPage,
 689         SdPage* pPage,
 690         const OUString& sPageName,
 691         sal_uInt16 nInsertionPoint,
 692         bool bIsPageBack,
 693         bool bIsPageObj);
 694
 695     SAL_DLLPRIVATE virtual void PageListChanged() override;
 696     SAL_DLLPRIVATE virtual void MasterPageListChanged() override;
 697 };
 698
 699 namespace sd
 700 {
 701
 702 /**an instance of this guard disables modification of a document
 703  during its lifetime*/
 704 class ModifyGuard
 705 {
 706 public:
 707     ModifyGuard( SdDrawDocument* pDoc );
 708     ~ModifyGuard();
 709
 710 private:
 711     void init();
 712
 713     DrawDocShell* mpDocShell;
 714     SdDrawDocument* mpDoc;
 715     bool mbIsEnableSetModified;
 716     bool mbIsDocumentChanged;
 717 };
 718
 719 }
 720
 721 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */