Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

7 files changed, 640 insertions, 0 deletions

diff --git a/sd/source/ui/slidesorter/inc/model/SlideSorterModel.hxx b/sd/source/ui/slidesorter/inc/model/SlideSorterModel.hxx
new file mode 100644
index 000000000..90223a1bc
--- /dev/null
+++ b/sd/source/ui/slidesorter/inc/model/SlideSorterModel.hxx
@@ -0,0 +1,227 @@
+/* -*- 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 .
+ */
+
+#pragma once
+
+#include <model/SlsSharedPageDescriptor.hxx>
+#include <pres.hxx>
+#include <osl/mutex.hxx>
+#include <vcl/region.hxx>
+#include <com/sun/star/uno/Reference.hxx>
+#include <vector>
+
+class SdDrawDocument;
+class SdrPage;
+class SdPage;
+namespace sd::slidesorter
+{
+class SlideSorter;
+}
+namespace com::sun::star::container
+{
+class XIndexAccess;
+}
+namespace com::sun::star::drawing
+{
+class XDrawPage;
+}
+
+namespace sd::slidesorter::model
+{
+inline sal_Int32 FromCoreIndex(const sal_uInt16 nCoreIndex) { return (nCoreIndex - 1) / 2; }
+
+/** The model of the slide sorter gives access to the slides that are to be
+    displayed in the slide sorter view.  Via the SetDocumentSlides() method
+    this set of slides can be modified (but do not call it directly, use
+    SlideSorterController::SetDocumentSlides() instead.)
+*/
+class SlideSorterModel final
+{
+public:
+    SlideSorterModel(SlideSorter& rSlideSorter);
+
+    ~SlideSorterModel();
+    void Dispose();
+
+    /** This method is present to let the view create a ShowView for
+        displaying slides.
+    */
+    SdDrawDocument* GetDocument();
+
+    /** Set a new edit mode and return whether the edit mode really
+        has been changed.  When the edit mode is changed then the
+        previous page descriptor list is replaced by a new one which
+        has to be repainted.
+        @return
+            A return value of <TRUE/> indicates that the edit mode has
+            changed and thus the page descriptor list has been set up
+            to reflect that change.  A repaint is necessary.
+    */
+    bool SetEditMode(EditMode eEditMode);
+
+    EditMode GetEditMode() const { return meEditMode; }
+
+    /** Return the number of slides in the document regardless of whether
+        they are visible or not or whether they are hidden or not.
+        The number of slides depends on the set of slides available through
+        the XIndexAccess given to SetDocumentSlides().
+    */
+    sal_Int32 GetPageCount() const;
+
+    /** Return a page descriptor for the page with the specified index.
+        Page descriptors are created on demand.  The page descriptor is
+        found (or not found) in constant time.
+        @param nPageIndex
+            The index of the requested slide.  The valid values
+            are 0 to GetPageCount()-1.
+        @param bCreate
+            When <TRUE/> and the requested page descriptor is missing then
+            it is created.  When <FALSE/> then an empty reference is
+            returned for missing descriptors.
+        @return
+            When the given index is not valid, i.e. lower than zero or
+            larger than or equal to the number of pages then an empty
+            reference is returned. Note that the page count may change
+            between calls to GetPageCount() and GetPageDescriptor().
+    */
+    SharedPageDescriptor GetPageDescriptor(const sal_Int32 nPageIndex,
+                                           const bool bCreate = true) const;
+
+    /** Return a page descriptor for the given XDrawPage.  Page descriptors
+        are created on demand.  The page descriptor is found (or not found)
+        in (at most) linear time.  Note that all page descriptors in front of
+        the one associated with the given XDrawPage are created when not yet
+        present. When the XDrawPage is not found then all descriptors are
+        created.
+        @return
+            Returns the index to the requested page descriptor or -1 when
+            there is no such page descriptor.
+    */
+    sal_Int32 GetIndex(const css::uno::Reference<css::drawing::XDrawPage>& rxSlide) const;
+
+    /** Return a page descriptor for the given SdrPage.  Page descriptors
+        are created on demand.  The page descriptor is found (or not found)
+        in (at most) linear time.  Note that all page descriptors in front of
+        the one associated with the given XDrawPage are created when not yet
+        present. When the SdrPage is not found then all descriptors are
+        created.
+        @return
+            Returns the index to the requested page descriptor or -1 when
+            there is no such page descriptor.
+    */
+    sal_Int32 GetIndex(const SdrPage* pPage) const;
+
+    /** Return an index for accessing an SdrModel that corresponds to the
+        given SlideSorterModel index.  In many cases we just have to apply
+        the n*2+1 magic.  Only when a special model is set, like a custom
+        slide show, then the returned value is different.
+    */
+    sal_uInt16 GetCoreIndex(const sal_Int32 nIndex) const;
+
+    /** Call this method after the document has changed its structure.  This
+        will get the model in sync with the SdDrawDocument.  This method
+        tries not to throw away too much information already gathered.  This
+        is especially important for previews of complex pages that take some
+        time to create.
+    */
+    void Resync();
+
+    /** Delete all descriptors that currently are in the container.  The size
+        of the container, however, is not altered.  Use the AdaptSize
+        method for that.
+    */
+    void ClearDescriptorList();
+
+    /** Set the selection of the document to exactly that of the called model.
+    */
+    void SynchronizeDocumentSelection();
+
+    /** Set the selection of the called model to exactly that of the document.
+    */
+    void SynchronizeModelSelection();
+
+    /** Return the mutex so that the caller can lock it and then safely
+        access the model.
+    */
+    ::osl::Mutex& GetMutex() { return maMutex; }
+
+    /** Set the XIndexAccess from which the called SlideSorterModel takes
+        its pages.
+        @param rxSlides
+            The set of slides accessible through this XIndexAccess are not
+            necessarily the same as the ones of the XModel of the
+            XController (although it typically is a subset).
+    */
+    void SetDocumentSlides(const css::uno::Reference<css::container::XIndexAccess>& rxSlides);
+
+    /** Return the set of pages that is currently displayed by the slide sorter.
+    */
+    css::uno::Reference<css::container::XIndexAccess> GetDocumentSlides() const;
+
+    /** This method is called when the edit mode has changed.  It calls
+        SetDocumentSlides() with the set of slides or master pages obtained
+        from the model of the XController.
+    */
+    void UpdatePageList();
+
+    bool IsReadOnly() const;
+
+    /** The current selection is saved by copying the ST_Selected state into
+        ST_WasSelected for slides.
+    */
+    void SaveCurrentSelection();
+
+    /** The current selection is restored from the ST_WasSelected state from
+        the slides.
+        @returns
+            The returned region has to be repainted to reflect the updated
+            selection states.
+    */
+    vcl::Region RestoreSelection();
+
+    /** Typically called from controller::Listener this method handles the
+        insertion and deletion of single pages.
+        @return
+            Returns <TRUE/> when the given page is relevant for the current
+            page kind and edit mode.
+    */
+    bool NotifyPageEvent(const SdrPage* pPage);
+
+private:
+    mutable ::osl::Mutex maMutex;
+    SlideSorter& mrSlideSorter;
+    css::uno::Reference<css::container::XIndexAccess> mxSlides;
+    EditMode meEditMode;
+    mutable ::std::vector<SharedPageDescriptor> maPageDescriptors;
+
+    /** Resize the descriptor container according to current values of
+        page kind and edit mode.
+    */
+    void AdaptSize();
+
+    SdPage* GetPage(const sal_Int32 nCoreIndex) const;
+    void InsertSlide(SdPage* pPage, bool bMarkSelected);
+    // return if this page was marked as selected before being removed
+    bool DeleteSlide(const SdPage* pPage);
+    void UpdateIndices(const sal_Int32 nFirstIndex);
+};
+
+} // end of namespace ::sd::slidesorter::model
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sd/source/ui/slidesorter/inc/model/SlsEnumeration.hxx b/sd/source/ui/slidesorter/inc/model/SlsEnumeration.hxx
new file mode 100644
index 000000000..289f85911
--- /dev/null
+++ b/sd/source/ui/slidesorter/inc/model/SlsEnumeration.hxx
@@ -0,0 +1,44 @@
+/* -*- 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 .
+ */
+
+#pragma once
+
+#include <memory>
+
+namespace sd::slidesorter::model
+{
+/** Interface to generic enumerations.  Designed to operate on shared
+    pointers.  Therefore GetNextElement() returns T and not T&.
+*/
+template <class T> class Enumeration
+{
+public:
+    virtual ~Enumeration() {}
+
+    virtual bool HasMoreElements() const = 0;
+    /** Returns T instead of T& so that it can handle shared pointers.
+    */
+    virtual T GetNextElement() = 0;
+    virtual void Rewind() = 0;
+    virtual ::std::unique_ptr<Enumeration<T>> Clone() = 0;
+};
+
+} // end of namespace ::sd::slidesorter::model
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sd/source/ui/slidesorter/inc/model/SlsPageDescriptor.hxx b/sd/source/ui/slidesorter/inc/model/SlsPageDescriptor.hxx
new file mode 100644
index 000000000..4f3be3b42
--- /dev/null
+++ b/sd/source/ui/slidesorter/inc/model/SlsPageDescriptor.hxx
@@ -0,0 +1,144 @@
+/* -*- 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 .
+ */
+
+#pragma once
+
+#include <model/SlsVisualState.hxx>
+#include <tools/gen.hxx>
+#include <com/sun/star/uno/Reference.hxx>
+
+#include <memory>
+
+namespace com::sun::star::drawing { class XDrawPage; }
+
+class SdPage;
+class SdrPage;
+
+namespace sd::slidesorter::model {
+
+/** Each PageDescriptor object represents the preview of one draw page,
+    slide, or master page of a Draw or Impress document as they are displayed
+    in the slide sorter.  This class gives access to some associated
+    information like prerendered preview or position on the screen.
+
+    <p>Bounding boxes of page objects come in four varieties:
+    Model and screen/pixel coordinates and the bounding boxes of the actual
+    page objects and the larger bounding boxes that include page names and
+    fade symbol.</p>
+*/
+class PageDescriptor
+    : public ::std::enable_shared_from_this<PageDescriptor>
+{
+public:
+    /** Create a PageDescriptor for the given SdPage object.
+        @param rxPage
+            The page that is represented by the new PageDescriptor object.
+        @param pPage
+            The page pointer can in some situations not be detected from
+            rxPage, e.g. after undo of page deletion.  Therefore supply it
+            separately.
+        @param nIndex
+            This index is displayed in the view as page number.  It is not
+            necessarily the page index (not even when you add or subtract 1
+            or use (x-1)/2 magic).
+    */
+    PageDescriptor (
+        const css::uno::Reference<css::drawing::XDrawPage>& rxPage,
+        SdPage* pPage,
+        const sal_Int32 nIndex);
+
+    ~PageDescriptor();
+
+    /** Return the page that is represented by the descriptor as SdPage pointer .
+    */
+    SdPage* GetPage() const { return mpPage;}
+
+    /** Return the page that is represented by the descriptor as XDrawPage reference.
+    */
+    const css::uno::Reference<css::drawing::XDrawPage>& GetXDrawPage() const { return mxPage;}
+
+    /** Returns the index of the page as it is displayed in the view as page
+        number.  The value may differ from the index returned by the
+        XDrawPage when there are hidden slides and the XIndexAccess used to
+        access the model filters them out.
+    */
+    sal_Int32 GetPageIndex() const { return mnIndex;}
+    void SetPageIndex (const sal_Int32 nIndex);
+
+    bool UpdateMasterPage();
+    bool UpdateTransitionFlag();
+
+    enum State { ST_Visible, ST_Selected, ST_WasSelected,
+                 ST_Focused, ST_MouseOver, ST_Current, ST_Excluded };
+
+    bool HasState (const State eState) const;
+
+    bool SetState (const State eState, const bool bStateValue);
+
+    /** Set the internal mbIsSelected flag to the selection state of the
+        page.  Use this method to synchronize a page descriptor with the
+        page it describes and determine whether a redraw to update the
+        selection indicator is necessary.
+        @return
+            When the two selection states were different <TRUE/> is
+            returned.  When they were the same this method returns
+            <FALSE/>.
+    */
+    bool GetCoreSelection();
+
+    /** Set the selection flags of the SdPage objects to the corresponding
+        selection states of the page descriptors.
+    */
+    void SetCoreSelection();
+
+    VisualState& GetVisualState() { return maVisualState;}
+
+    ::tools::Rectangle GetBoundingBox() const;
+    Point GetLocation (const bool bIgnoreLocation) const;
+    void SetBoundingBox (const ::tools::Rectangle& rBoundingBox);
+
+private:
+    SdPage* mpPage;
+    css::uno::Reference<css::drawing::XDrawPage> mxPage;
+    SdrPage const* mpMasterPage;
+
+    /** This index is displayed as page number in the view.  It may or may
+        not be the actual page index.
+    */
+    sal_Int32 mnIndex;
+
+    ::tools::Rectangle maBoundingBox;
+    VisualState maVisualState;
+
+    bool mbIsSelected : 1;
+    bool mbWasSelected : 1;
+    bool mbIsVisible : 1;
+    bool mbIsFocused : 1;
+    bool mbIsCurrent : 1;
+    bool mbIsMouseOver : 1;
+    bool mbHasTransition : 1;
+
+    PageDescriptor (const PageDescriptor& rDescriptor) = delete;
+
+    PageDescriptor& operator= (const PageDescriptor& rDescriptor) = delete;
+};
+
+} // end of namespace ::sd::slidesorter::model
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sd/source/ui/slidesorter/inc/model/SlsPageEnumeration.hxx b/sd/source/ui/slidesorter/inc/model/SlsPageEnumeration.hxx
new file mode 100644
index 000000000..6901a9ff1
--- /dev/null
+++ b/sd/source/ui/slidesorter/inc/model/SlsPageEnumeration.hxx
@@ -0,0 +1,95 @@
+/* -*- 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 .
+ */
+
+#pragma once
+
+#include <model/SlsEnumeration.hxx>
+#include <model/SlsSharedPageDescriptor.hxx>
+
+#include <functional>
+#include <memory>
+
+namespace sd::slidesorter::model
+{
+class SlideSorterModel;
+
+/** Public class of page enumerations that delegates its calls to an
+    implementation object that can filter pages by using a given predicate.
+
+    @see PageEnumerationProvider
+        The PageEnumerationProvider has methods for creating different types
+        of page enumerations.
+*/
+class PageEnumeration final : public Enumeration<SharedPageDescriptor>
+{
+public:
+    /** Create a new page enumeration that enumerates a subset of the pages
+        of the given model.
+        @param rModel
+            The new page enumeration enumerates the pages of this model.
+        @param rPredicate
+            This predicate determines which pages to include in the
+            enumeration.  Pages for which rPredicate returns <FALSE/> are
+            exclude.
+    */
+    typedef ::std::function<bool(const SharedPageDescriptor&)> PagePredicate;
+    static PageEnumeration Create(const SlideSorterModel& rModel, const PagePredicate& rPredicate);
+
+    /** This copy constructor creates a copy of the given enumeration.
+    */
+    PageEnumeration(const PageEnumeration& rEnumeration);
+
+    virtual ~PageEnumeration() override;
+
+    /** Create and return an exact copy of the called object.
+    */
+    virtual ::std::unique_ptr<Enumeration<SharedPageDescriptor>> Clone() override;
+
+    PageEnumeration& operator=(const PageEnumeration& rEnumeration);
+
+    /** Return <TRUE/> when the enumeration has more elements, i.e. it is
+        save to call GetNextElement() at least one more time.
+    */
+    virtual bool HasMoreElements() const override;
+
+    /** Return the next element of the enumeration.  Call the
+        HasMoreElements() before to make sure that there exists at least one
+        more element.  Calling this method with HasMoreElements() returning
+        <FALSE/> is an error.
+    */
+    virtual SharedPageDescriptor GetNextElement() override;
+
+    /** Rewind the enumeration so that the next call to GetNextElement()
+        will return its first element.
+    */
+    virtual void Rewind() override;
+
+private:
+    /// Implementation object.
+    ::std::unique_ptr<Enumeration<SharedPageDescriptor>> mpImpl;
+
+    /** This constructor expects an implementation object that holds
+        the predicate that filters the pages.
+    */
+    PageEnumeration(::std::unique_ptr<Enumeration<SharedPageDescriptor>>&& pImpl);
+};
+
+} // end of namespace ::sd::slidesorter::model
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sd/source/ui/slidesorter/inc/model/SlsPageEnumerationProvider.hxx b/sd/source/ui/slidesorter/inc/model/SlsPageEnumerationProvider.hxx
new file mode 100644
index 000000000..b6de98d13
--- /dev/null
+++ b/sd/source/ui/slidesorter/inc/model/SlsPageEnumerationProvider.hxx
@@ -0,0 +1,51 @@
+/* -*- 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 .
+ */
+
+#pragma once
+
+#include <model/SlsPageEnumeration.hxx>
+
+namespace sd::slidesorter::model
+{
+class SlideSorterModel;
+
+/** Collection of methods that create enumeration of slides.
+*/
+class PageEnumerationProvider
+{
+public:
+    /** The returned enumeration of slides iterates over all slides of the
+        given model.
+    */
+    static PageEnumeration CreateAllPagesEnumeration(const SlideSorterModel& rModel);
+
+    /** The returned enumeration of slides iterates over the currently
+        selected slides of the given model.
+    */
+    static PageEnumeration CreateSelectedPagesEnumeration(const SlideSorterModel& rModel);
+
+    /** The returned enumeration of slides iterates over the slides
+        (partially) inside the visible area.
+    */
+    static PageEnumeration CreateVisiblePagesEnumeration(const SlideSorterModel& rModel);
+};
+
+} // end of namespace ::sd::slidesorter::model
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sd/source/ui/slidesorter/inc/model/SlsSharedPageDescriptor.hxx b/sd/source/ui/slidesorter/inc/model/SlsSharedPageDescriptor.hxx
new file mode 100644
index 000000000..6ee1e2b22
--- /dev/null
+++ b/sd/source/ui/slidesorter/inc/model/SlsSharedPageDescriptor.hxx
@@ -0,0 +1,32 @@
+/* -*- 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 .
+ */
+
+#pragma once
+
+#include <memory>
+
+namespace sd::slidesorter::model
+{
+class PageDescriptor;
+
+typedef std::shared_ptr<PageDescriptor> SharedPageDescriptor;
+
+} // end of namespace ::sd::slidesorter::model
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/sd/source/ui/slidesorter/inc/model/SlsVisualState.hxx b/sd/source/ui/slidesorter/inc/model/SlsVisualState.hxx
new file mode 100644
index 000000000..89eae16ca
--- /dev/null
+++ b/sd/source/ui/slidesorter/inc/model/SlsVisualState.hxx
@@ -0,0 +1,47 @@
+/* -*- 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 .
+ */
+
+#pragma once
+
+#include <sal/types.h>
+#include <tools/gen.hxx>
+
+namespace sd::slidesorter::model
+{
+/** This class gives access to values related to the visualization of page
+    objects.  This includes animation state when blending from one state to
+    another.
+*/
+class VisualState
+{
+public:
+    VisualState(const sal_Int32 nPageId);
+
+    const Point& GetLocationOffset() const { return maLocationOffset; }
+    void SetLocationOffset(const Point& rPoint);
+
+    sal_Int32 mnPageId; // For debugging
+
+private:
+    Point maLocationOffset;
+};
+
+} // end of namespace ::sd::slidesorter::model
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */