1 files changed, 130 insertions, 0 deletions
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 000000000000..36a49f720589
--- /dev/null
+++ b/sd/source/ui/slidesorter/inc/model/SlsPageEnumeration.hxx
@@ -0,0 +1,130 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org 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 version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#ifndef SD_SLIDESORTER_PAGE_ENUMERATION_HXX
+#define SD_SLIDESORTER_PAGE_ENUMERATION_HXX
+
+#include "pres.hxx"
+
+
+#include "model/SlsEnumeration.hxx"
+#include "model/SlsSharedPageDescriptor.hxx"
+
+#include <boost/function.hpp>
+#include <memory>
+
+namespace sd { namespace slidesorter { namespace 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
+    : 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 ::boost::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();
+
+    /** Create a new enumeration object.  The ownership of the
+        implementation object goes to the new object.  Use this copy
+        constructor only when you know what you are doing.  When in doubt,
+        use the one argument version.
+        @param bCloneImpl
+            When <TRUE/> is given this constructor behaves exactly like its
+            one argument version.  When <FALSE/> is given then the
+            implementation object is not copied but moved from the given
+            enumeration to the newly created one.  The given enumeration
+            thus becomes empty.
+    */
+    PageEnumeration (PageEnumeration& rEnumeration, bool bCloneImpl);
+
+    /** Create and return an exact copy of the called object.
+    */
+    virtual ::std::auto_ptr<Enumeration<SharedPageDescriptor> > Clone (void);
+
+    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 (void) const;
+
+    /** 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 (void);
+
+    /** Rewind the enumeration so that the next call to GetNextElement()
+        will return its first element.
+    */
+    virtual void Rewind (void);
+
+private:
+    /// Implementation object.
+    ::std::auto_ptr<Enumeration<SharedPageDescriptor> > mpImpl;
+
+    /** This constructor expects an implementation object that holds
+        the predicate that filters the pages.
+    */
+    PageEnumeration (::std::auto_ptr<Enumeration<SharedPageDescriptor> > pImpl);
+
+    // Default constructor not implemented.
+    PageEnumeration (void);
+};
+
+} } } // end of namespace ::sd::slidesorter::model
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */