ODFstudio/odfstudio
2
0
Fork 0
Code Issues Packages Activity
Files
main
odfstudio/sd/inc/sdpage.hxx
T
Andrea Gelmini 6410690a38 Fix typos in code and comments. 
Change-Id: I8f1419c60c8aec0784e6de685ba7f630ae99638d
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/210571
Tested-by: Julien Nabet <serval2412@yahoo.fr>
Reviewed-by: Julien Nabet <serval2412@yahoo.fr>
2026-09-10 14:00:17 +02:00

454 lines
19 KiB
C++
Raw Permalink Blame History

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SD_INC_SDPAGE_HXX
#define INCLUDED_SD_INC_SDPAGE_HXX
#include <com/sun/star/drawing/XDrawPage.hpp>
#include <com/sun/star/presentation/FadeEffect.hpp>
#include <com/sun/star/office/XAnnotation.hpp>
#include <memory>
#include <string_view>
#include <vector>
#include <editeng/flditem.hxx>
#include <svx/svdobj.hxx>
#include <svx/fmpage.hxx>
#include <vcl/checksum.hxx>
#include <xmloff/autolayout.hxx>
#include "diadef.h"
#include "pres.hxx"
#include "SdSoundLink.hxx"
#include "shapelist.hxx"
#include "misc/scopelock.hxx"
#include "sddllapi.h"
#include <tools/json_writer.hxx>
namespace com::sun::star::animations {
class XAnimationNode;
}
class SfxStyleSheet;
class SdDrawDocument;
class SdrOutliner;
class SdrTextObj;
class SdPageLink;
class SfxItemSet;
class Paragraph;
class Outliner;
class SdStyleSheet;
class Graphic;
namespace sd
{
class MainSequence;
}
namespace sd {
struct SD_DLLPUBLIC HeaderFooterSettings
{
bool mbHeaderVisible;
OUString maHeaderText;
bool mbFooterVisible;
OUString maFooterText;
bool mbSlideNumberVisible;
bool mbDateTimeVisible;
bool mbDateTimeIsFixed;
OUString maDateTimeText;
SvxDateFormat meDateFormat;
SvxTimeFormat meTimeFormat;
HeaderFooterSettings();
bool operator==( const HeaderFooterSettings& rSettings ) const;
};
}
namespace sd {
class UndoAnimation;
class UndoTransition;
class UndoGeoObject;
class UndoAttrObject;
}
class SAL_DLLPUBLIC_RTTI SdPage final : public FmFormPage, public SdrObjUserCall
{
SdPage& operator=(const SdPage&) = delete;
SdPage(const SdPage&) = delete;
friend class SdGenericDrawPage;
friend class SdDrawPage;
friend class sd::UndoAnimation;
friend class sd::UndoTransition;
friend class ModifyPageUndoAction;
friend class sd::UndoGeoObject;
friend class sd::UndoAttrObject;
PageKind mePageKind; ///< page type
AutoLayout meAutoLayout; ///< AutoLayout
sd::ShapeList maPresentationShapeList;///< presentation objects
sd::ScopeLock maLockAutoLayoutArrangement;
bool mbSelected; ///< selection identifier
PresChange mePresChange; ///< manual / automatic / semi automatic
double mfTime; ///< Display time in seconds
bool mbSoundOn; ///< with / without sound.
bool mbExcluded; ///< will (not) be displayed during show.
OUString maLayoutName; ///< Name of the layout
SdSoundLink maSoundLink; ///< transition sound source
bool mbLoopSound;
bool mbStopSound;
OUString maCreatedPageName; ///< generated page name by GetPageName.
OUString maFileName; ///< file name.
OUString maBookmarkName; ///< Bookmark name.
bool mbScaleObjects; ///< Objects should be scaled
rtl_TextEncoding meCharSet; ///< Text encoding
sal_uInt16 mnPaperBin; ///< PaperBin
SdPageLink* mpPageLink; ///< Page link (at left sides only)
bool mbIsCanvasPage; ///< whether the page is a canvas page
bool mbIsCanvasMasterPage; ///< whether it is the master page of the canvas page
// PDF link annotations for read-only pdfium
std::vector<std::pair<basegfx::B2DRectangle, OUString>> maLinkAnnotations;
/** holds the smil animation sequences for this page */
css::uno::Reference< css::animations::XAnimationNode > mxAnimationNode;
/** a helper class to manipulate effects inside the main sequence */
std::shared_ptr< sd::MainSequence > mpMainSequence;
virtual css::uno::Reference< css::uno::XInterface > createUnoPage() override;
std::unique_ptr<SfxItemSet> mpItems;
SfxItemSet* getOrCreateItems();
sd::HeaderFooterSettings maHeaderFooterSettings;
// new transition settings
sal_Int16 mnTransitionType;
sal_Int16 mnTransitionSubtype;
bool mbTransitionDirection;
sal_Int32 mnTransitionFadeColor;
double mfTransitionDuration;
void lateInit(const SdPage& rSrcPage);
public:
SdPage(SdDrawDocument& rNewDoc, bool bMasterPage);
virtual ~SdPage() override;
virtual rtl::Reference<SdrPage> CloneSdrPage(SdrModel& rTargetModel) const override;
virtual void SetSize(const Size& aSize) override;
virtual void SetBorder(sal_Int32 nLft, sal_Int32 nUpp, sal_Int32 nRgt, sal_Int32 Lwr) override;
virtual void SetLeftBorder(sal_Int32 nBorder) override;
virtual void SetRightBorder(sal_Int32 nBorder) override;
virtual void SetUpperBorder(sal_Int32 nBorder) override;
virtual void SetLowerBorder(sal_Int32 nBorder) override;
virtual bool IsReadOnly() const override;
sd::ShapeList& GetPresentationShapeList() { return maPresentationShapeList; }
void EnsureMasterPageDefaultBackground();
SD_DLLPUBLIC SdrObject* CreatePresObj(PresObjKind eObjKind, bool bVertical, const ::tools::Rectangle& rRect, const OUString& rCustomPrompt = OUString(), const sal_uInt16 nPagePreviewNum = 0xffff);
SD_DLLPUBLIC rtl::Reference<SdrObject> CreateDefaultPresObj(PresObjKind eObjKind);
SD_DLLPUBLIC void DestroyDefaultPresObj(PresObjKind eObjKind);
SD_DLLPUBLIC SdrObject* GetPresObj(PresObjKind eObjKind, int nIndex = 1, bool bFuzzySearch = false );
PresObjKind GetPresObjKind(SdrObject* pObj) const;
OUString GetPresObjText(PresObjKind eObjKind) const;
SfxStyleSheet* GetStyleSheetForMasterPageBackground() const;
SfxStyleSheet* GetStyleSheetForPresObj(PresObjKind eObjKind) const;
void GetPageInfo(::tools::JsonWriter& jsonWriter);
void NotifyPagePropertyChanges();
bool RestoreDefaultText( SdrObject* pObj, const OUString& rStr ) override;
void onEmptyPresObjFilled(SdrObject& rObj) override;
/** @return true if the given SdrObject is inside the presentation object list */
bool IsPresObj(const SdrObject* pObj);
/** removes the given SdrObject from the presentation object list */
void RemovePresObj(const SdrObject* pObj);
/** inserts the given SdrObject into the presentation object list */
void InsertPresObj(SdrObject* pObj, PresObjKind eKind );
/** The checksum of the art a picture placeholder is created holding. Loading and decoding it
is what answers for the theme in force, so a walk over many objects asks once. */
static BitmapChecksum GetPlaceholderStandInChecksum();
/** Whether the object shows nothing but the art that stands in for what a placeholder waits
for. A picture placeholder is created holding that art, so holding a graphic does not mean
the author put a picture there. */
static bool HoldsPlaceholderStandIn(const SdrObject& rObj, BitmapChecksum nStandIn);
/** What represents a placeholder that holds text: an outliner object, the way a graphic object
represents one holding a picture. It carries the placeholder's identity but belongs to no
page yet, so the caller decides how it takes the old object's place. */
rtl::Reference<SdrObject> MakePresObjText(SdrObject& rObj);
/** The reverse: what represents the given placeholder once its text is gone - for a picture one
the icon standing in for the image it waits for. It carries the placeholder's identity but
belongs to no page yet, so the caller decides how it takes the old object's place. */
rtl::Reference<SdrObject> MakePresObjPlaceholder(SdrObject& rObj);
SD_DLLPUBLIC void SetAutoLayout(AutoLayout eLayout, bool bInit=false, bool bCreate=false);
AutoLayout GetAutoLayout() const { return meAutoLayout; }
void CreateTitleAndLayout(bool bInit=false, bool bCreate=false);
SdrObject* InsertAutoLayoutShape(SdrObject* pObj, PresObjKind eObjKind, bool bVertical, const ::tools::Rectangle& rRect, const OUString& rCustomPrompt, bool bInit);
SD_DLLPUBLIC virtual void NbcInsertObject(SdrObject* pObj, size_t nPos=SAL_MAX_SIZE) override;
virtual rtl::Reference<SdrObject> NbcRemoveObject(size_t nObjNum) override;
virtual rtl::Reference<SdrObject> RemoveObject(size_t nObjNum) override;
/** Also override ReplaceObject methods to realize when
objects are removed with this mechanism instead of RemoveObject */
virtual rtl::Reference<SdrObject> ReplaceObject(SdrObject* pNewObj, size_t nObjNum) override;
void SetObjText(SdrTextObj* pObj, SdrOutliner* pOutliner, PresObjKind eObjKind, std::u16string_view rStr );
void SetPageKind(PageKind ePgType) { mePageKind = ePgType; }
PageKind GetPageKind() const { return mePageKind; }
void SetSelected(bool bSel) { mbSelected = bSel; }
bool IsSelected() const { return mbSelected; }
void SetFadeEffect(css::presentation::FadeEffect eNewEffect);
css::presentation::FadeEffect GetFadeEffect() const;
void SetPresChange(PresChange eChange) { mePresChange = eChange; }
PresChange GetPresChange() const { return mePresChange; }
void SetTime(double fNewTime) { mfTime = fNewTime; }
double GetTime() const { return mfTime; }
void SetSound(bool bNewSoundOn) { mbSoundOn = bNewSoundOn; }
bool IsSoundOn() const { return mbSoundOn; }
void SetExcluded(bool bNewExcluded) { mbExcluded = bNewExcluded; }
bool IsExcluded() const { return mbExcluded; }
bool IsScaleObjects() const { return mbScaleObjects; }
void SetSoundFile(const OUString& rStr, bool bAllowed = false);
const OUString& GetSoundFile() const { return maSoundLink.getURL(); }
const SdSoundLink& GetSoundLink() const { return maSoundLink; }
void SetSoundAllowed(bool bAllowed) { maSoundLink.setAllowed(bAllowed); }
void SetLoopSound( bool bLoopSound ) { mbLoopSound = bLoopSound; }
bool IsLoopSound() const { return mbLoopSound; }
void SetStopSound( bool bStopSound ) { mbStopSound = bStopSound; }
bool IsStopSound() const { return mbStopSound; }
sal_Int16 getTransitionType() const { return mnTransitionType;}
void setTransitionType( sal_Int16 nTransitionType );
sal_Int16 getTransitionSubtype() const { return mnTransitionSubtype;}
void setTransitionSubtype( sal_Int16 nTransitionSubtype );
bool getTransitionDirection() const { return mbTransitionDirection;}
void setTransitionDirection( bool bTransitionbDirection );
sal_Int32 getTransitionFadeColor() const { return mnTransitionFadeColor;}
void setTransitionFadeColor( sal_Int32 nTransitionFadeColor );
double getTransitionDuration() const { return mfTransitionDuration;}
void setTransitionDuration( double fTransitionDuration );
virtual void Changed(const SdrObject& rObj, SdrUserCallType eType,
const ::tools::Rectangle& rOldBoundRect) override;
void SetLayoutName(const OUString& aName);
const OUString& GetLayoutName() const { return maLayoutName; }
void SetFileName(const OUString& aName) { maFileName = aName; }
const OUString& GetFileName() const { return maFileName; }
void SetBookmarkName(const OUString& aName) { maBookmarkName = aName; }
const OUString& GetBookmarkName() const { return maBookmarkName; }
void ConnectLink();
void DisconnectLink();
void ScaleObjects(const Size& rNewPageSize, const ::tools::Rectangle& rNewBorderRect,
bool bScaleAllObj);
SD_DLLPUBLIC const OUString& GetName() const;
OUString const & GetRealName() const { return FmFormPage::GetName(); };
void SetPresentationLayout(std::u16string_view rLayoutName,
bool bReplaceStyleSheets = true,
bool bSetMasterPage = true,
bool bReverseOrder = false);
void EndListenOutlineText();
void SetPaperBin(sal_uInt16 nBin) { mnPaperBin = nBin; }
sal_uInt16 GetPaperBin() const { return mnPaperBin; }
virtual void SetOrientation(Orientation eOrient) override;
virtual Orientation GetOrientation() const override;
virtual SfxStyleSheet* GetTextStyleSheetForObject( SdrObject* pObj ) const override;
bool setAlienAttributes( const css::uno::Any& rAttributes );
void getAlienAttributes( css::uno::Any& rAttributes );
/** @return the main animation node
@throws css::uno::RuntimeException
*/
css::uno::Reference< css::animations::XAnimationNode > const & getAnimationNode();
/** sets the main animation node
@throws css::uno::RuntimeException
*/
void setAnimationNode( css::uno::Reference< css::animations::XAnimationNode > const & xNode );
/// @return a helper class to manipulate effects inside the main sequence
SD_DLLPUBLIC std::shared_ptr< sd::MainSequence > const & getMainSequence();
/** quick check if this slide has an animation node.
This can be used to have a cost free check if there are no animations ad this slide.
If it returns true this does not mean that there are animations available.
*/
bool hasAnimationNode() const;
/// @return the SdPage implementation for the given XDrawPage or 0 if not available
static SdPage* getImplementation( const css::uno::Reference< css::drawing::XDrawPage >& xPage );
/** removes all custom animations for the given shape */
void removeAnimations( const SdrObject* pObj );
/** Notify that the object has been renamed and the animation effects have to be updated. */
void notifyObjectRenamed(const SdrObject* pObj);
/** Set the name of the page and broadcast a model change.
*/
SD_DLLPUBLIC void SetName(const OUString& rName, bool bUpdatePageRelativeURLs = true);
SD_DLLPUBLIC const sd::HeaderFooterSettings& getHeaderFooterSettings() const;
SD_DLLPUBLIC void setHeaderFooterSettings( const sd::HeaderFooterSettings& rNewSettings );
/**
@return true if the object from the ViewObjectContact should
be visible on this page while rendering.
bEdit selects if visibility test is for an editing view or a final render,
like printing.
*/
virtual bool checkVisibility(
const sdr::contact::ViewObjectContact& rOriginal,
const sdr::contact::DisplayInfo& rDisplayInfo,
bool bEdit ) override;
/** callback from the sd::View when a new paragraph for one object on this page is created */
void onParagraphInserted( const ::Outliner* pOutliner, Paragraph const * pPara, SdrObject* pObj );
/** callback from the sd::View when a paragraph from one object on this page is removed */
void onParagraphRemoving( const ::Outliner* pOutliner, Paragraph const * pPara, SdrObject* pObj );
/** callback from the sd::View when an object just left text edit mode */
void onEndTextEdit( SdrObject* pObj );
/** @return the presentation style with the given helpid from this masterpage or this
slide's masterpage */
SD_DLLPUBLIC SdStyleSheet* getPresentationStyle( sal_uInt32 nHelpId ) const;
/** removes all empty presentation objects from this slide */
void RemoveEmptyPresentationObjects();
::tools::Rectangle GetTitleRect() const;
::tools::Rectangle GetLayoutRect() const;
static void CalculateHandoutAreas( SdDrawDocument& rModel, AutoLayout eLayout, bool bHorizontal, std::vector< ::tools::Rectangle >& rAreas, Orientation eOrient );
/** Set the "precious" flag to the given value.
*/
void SetPrecious (const bool bIsPrecious);
/** The "precious" flag is used for master pages to prevent some unused
master pages from being deleted automatically. For pages
other than master pages this flag can be ignored.
@return
When this method returns <TRUE/> for a master page then this
master page should not be deleted automatically.
*/
bool IsPrecious() const { return mbIsPrecious; }
SD_DLLPUBLIC rtl::Reference<sdr::annotation::Annotation> createAnnotation() override;
SD_DLLPUBLIC void addAnnotation(rtl::Reference<sdr::annotation::Annotation> const& xAnnotation, int nIndex = -1) override;
void addAnnotationNoNotify(rtl::Reference<sdr::annotation::Annotation> const& xAnnotation, int nIndex = -1) override;
SD_DLLPUBLIC void removeAnnotation(rtl::Reference<sdr::annotation::Annotation> const& xAnnotation) override;
void removeAnnotationNoNotify(rtl::Reference<sdr::annotation::Annotation> const& xAnnotation) override;
void setLinkAnnotations(const std::vector<std::pair<basegfx::B2DRectangle, OUString>>& rLinks)
{
maLinkAnnotations = rLinks;
}
const std::vector<std::pair<basegfx::B2DRectangle, OUString>>& getLinkAnnotations() const
{
return maLinkAnnotations;
}
bool Equals(const SdPage&) const;
virtual void dumpAsXml(xmlTextWriterPtr pWriter) const override;
sal_uInt16 getPageId() const { return mnPageId; }
/**
Returns graphics objects from the page that can be prefetched before it's painted.
The pointers are temporary and should not be kept.
*/
void getGraphicsForPrefetch(std::vector<Graphic*>& graphics) const;
static AutoLayout stringToAutoLayout(std::u16string_view rLayoutName);
static OUString autoLayoutToString(AutoLayout nLayoutId);
static sal_uInt16 mnLastPageId;
bool IsCanvasPage() const { return mbIsCanvasPage; }
void SetCanvasPage();
bool IsCanvasMasterPage() const { return mbIsCanvasMasterPage; }
void SetCanvasMasterPage() { mbIsCanvasMasterPage = true; }
private:
bool mbIsPrecious;
// page id of this page
sal_uInt16 mnPageId;
/** clone the animations from this and set them to rTargetPage
* TTTT: Order is strange, should be the other way around by
* convention/convenience and makes usage a little dangerous...
*/
void cloneAnimations( SdPage& rTargetPage ) const;
/** called before a shape is removed or replaced from this slide */
void onRemoveObject( SdrObject* pObject );
};
#endif // INCLUDED_SD_INC_SDPAGE_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in New Issue View Git Blame Copy Permalink