INTEGRATION: CWS impress2 (1.1.2); FILE ADDED

2004/05/05 12:41:47 af 1.1.2.3: #i22705# (last commit was an accident) Added a factory for the different types of page objects.
2004/05/05 11:04:05 af 1.1.2.2: #i22705#lidesorter\controller\SlideSorterController.cxx
2004/02/13 12:14:52 af 1.1.2.1: #i22705# Initial revision.

1 files changed, 210 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 000000000000..00eb6b34cd5a
--- /dev/null
+++ b/sd/source/ui/slidesorter/inc/model/SlideSorterModel.hxx
@@ -0,0 +1,210 @@
+/*************************************************************************
+ *
+ *  $RCSfile: SlideSorterModel.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2004-07-13 14:21:26 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef SD_SLIDESORTER_SLIDE_SORTER_MODEL_HXX
+#define SD_SLIDESORTER_SLIDE_SORTER_MODEL_HXX
+
+class SdDrawDocument;
+
+#include "SlsPageEnumeration.hxx"
+
+#ifndef _PRESENTATION_HXX
+#include "pres.hxx"
+#endif
+#ifndef _COM_SUN_STAR_DRAWING_XDRAWPAGE_HPP_
+#include <com/sun/star/drawing/XDrawPage.hpp>
+#endif
+#include <osl/mutex.hxx>
+
+#include <memory>
+#include <vector>
+#include <functional>
+
+namespace sd { namespace slidesorter { namespace controller {
+class PageObjectFactory;
+} } }
+
+namespace sd { namespace slidesorter { namespace model {
+
+class DocumentPageContainer;
+class PageDescriptor;
+class PageEnumeration;
+
+class SlideSorterModel
+{
+public:
+    typedef PageEnumeration Enumeration;
+
+    SlideSorterModel (SdDrawDocument& rDocument,
+        PageKind ePageKind = PK_STANDARD,
+        EditMode eEditMode= EM_PAGE);
+
+    virtual ~SlideSorterModel (void);
+
+    /** This method is present to let the view create a ShowView for
+        displaying slides.
+    */
+    SdDrawDocument* GetDocument (void);
+
+    /** 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 (void) const;
+    PageKind GetPageType (void) const;
+
+    int GetPageCount (void) 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.
+        @return
+            When the given index is not valid, i.e. lower then zero or
+            larger than or equal to the number of pages as returned by
+            GetPageCount() then NULL is returned. Note that the page count
+            may change between subsequent calls to GetPageCount() and
+            GetPageDescriptor().
+    */
+    PageDescriptor* GetPageDescriptor (int nPageIndex) const;
+
+    /** Return the page descriptor for the page with the specified index.
+        In contrast to GetPageDescriptor() this method does not create a
+        page descriptor when not already present.  This method exists mainly
+        for debugging so use it only when you know what you are doing.
+    */
+    PageDescriptor* GetRawPageDescriptor (int nPageIndex) const;
+
+    /** Return the page descriptor whose page has the given object as UNO
+        wrapper.  This method takes linear time (in the number of pages).
+        @return
+            Returns NULL when no page descriptor is found with the given UNO
+            wrapper.
+    */
+    PageDescriptor* FindPageDescriptor (
+        const ::com::sun::star::uno::Reference<
+            ::com::sun::star::drawing::XDrawPage>& rxPage) const;
+
+    Enumeration GetAllPagesEnumeration (void) const;
+    Enumeration GetSelectedPagesEnumeration (void) const;
+    Enumeration GetVisiblePagesEnumeration (void) 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 to much information already gathered.  This
+        is especially important for previews of complex pages that take some
+        time to create.
+    */
+    void Resync (void);
+
+    /** Set the selection of the document to exactly that of the called model.
+    */
+    void SynchronizeDocumentSelection (void);
+
+    /** Set the selection of the called model to exactly that of the document.
+    */
+    void SynchronizeModelSelection (void);
+
+    /** Replace the factory for the creation of the page objects and
+        contacts with the given object.  The old factory is destroyed.
+    */
+    void SetPageObjectFactory(
+        ::std::auto_ptr<controller::PageObjectFactory> pPageObjectFactory);
+
+    /** Return the page object factory.  It none has been set so far or it
+        has been reset, then a new one is created.
+    */
+    const controller::PageObjectFactory& GetPageObjectFactory (void) const;
+
+    /** Return the mutex so that the caller can lock it and then safely
+        access the model.
+    */
+    ::osl::Mutex& GetMutex (void);
+
+private:
+    mutable ::osl::Mutex maMutex;
+    typedef ::std::vector<PageDescriptor*> DescriptorContainer;
+    SdDrawDocument& mrDocument;
+    PageKind mePageKind;
+    EditMode meEditMode;
+    mutable DescriptorContainer maPageDescriptors;
+    mutable ::std::auto_ptr<controller::PageObjectFactory> mpPageObjectFactory;
+
+    /** Resize the descriptor container according to current values of
+        page kind and edit mode.
+    */
+    void AdaptSize (void);
+
+    /** 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 (void);
+};
+
+} } } // end of namespace ::sd::slidesorter::model
+
+#endif