sd/source/ui/slidesorter/inc/model/SlsPageEnumeration.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 #ifndef INCLUDED_SD_SOURCE_UI_SLIDESORTER_INC_MODEL_SLSPAGEENUMERATION_HXX
  21 #define INCLUDED_SD_SOURCE_UI_SLIDESORTER_INC_MODEL_SLSPAGEENUMERATION_HXX
  22
  23 #include <sal/types.h>
  24
  25 #include "pres.hxx"
  26
  27 #include "model/SlsEnumeration.hxx"
  28 #include "model/SlsSharedPageDescriptor.hxx"
  29
  30 #include <boost/function.hpp>
  31 #include <memory>
  32
  33 namespace sd { namespace slidesorter { namespace model {
  34
  35 class SlideSorterModel;
  36
  37 /** Public class of page enumerations that delegates its calls to an
  38     implementation object that can filter pages by using a given predicate.
  39
  40     @see PageEnumerationProvider
  41         The PageEnumerationProvider has methods for creating different types
  42         of page enumerations.
  43 */
  44 class PageEnumeration
  45     : public Enumeration<SharedPageDescriptor>
  46 {
  47 public:
  48     /** Create a new page enumeration that enumerates a subset of the pages
  49         of the given model.
  50         @param rModel
  51             The new page enumeration enumerates the pages of this model.
  52         @param rPredicate
  53             This predicate determines which pages to include in the
  54             enumeration.  Pages for which rPredicate returns <FALSE/> are
  55             exclude.
  56     */
  57     typedef ::boost::function<bool(const SharedPageDescriptor&)> PagePredicate;
  58     static PageEnumeration Create (
  59         const SlideSorterModel& rModel,
  60         const PagePredicate& rPredicate);
  61
  62     /** This copy constructor creates a copy of the given enumeration.
  63     */
  64     PageEnumeration (const PageEnumeration& rEnumeration);
  65
  66     virtual ~PageEnumeration();
  67
  68     /** Create a new enumeration object.  The ownership of the
  69         implementation object goes to the new object.  Use this copy
  70         constructor only when you know what you are doing.  When in doubt,
  71         use the one argument version.
  72         @param bCloneImpl
  73             When <TRUE/> is given this constructor behaves exactly like its
  74             one argument version.  When <FALSE/> is given then the
  75             implementation object is not copied but moved from the given
  76             enumeration to the newly created one.  The given enumeration
  77             thus becomes empty.
  78     */
  79     PageEnumeration (PageEnumeration& rEnumeration, bool bCloneImpl);
  80
  81     /** Create and return an exact copy of the called object.
  82     */
  83     virtual ::std::unique_ptr<Enumeration<SharedPageDescriptor> > Clone() SAL_OVERRIDE;
  84
  85     PageEnumeration& operator= (const PageEnumeration& rEnumeration);
  86
  87     /** Return <TRUE/> when the enumeration has more elements, i.e. it is
  88         save to call GetNextElement() at least one more time.
  89     */
  90     virtual bool HasMoreElements() const SAL_OVERRIDE;
  91
  92     /** Return the next element of the enumeration.  Call the
  93         HasMoreElements() before to make sure that there exists at least one
  94         more element.  Calling this method with HasMoreElements() returning
  95         <FALSE/> is an error.
  96     */
  97     virtual SharedPageDescriptor GetNextElement() SAL_OVERRIDE;
  98
  99     /** Rewind the enumeration so that the next call to GetNextElement()
 100         will return its first element.
 101     */
 102     virtual void Rewind() SAL_OVERRIDE;
 103
 104 private:
 105     /// Implementation object.
 106     ::std::unique_ptr<Enumeration<SharedPageDescriptor> > mpImpl;
 107
 108     /** This constructor expects an implementation object that holds
 109         the predicate that filters the pages.
 110     */
 111     PageEnumeration (::std::unique_ptr<Enumeration<SharedPageDescriptor> > && pImpl);
 112
 113     // Default constructor not implemented.
 114     PageEnumeration();
 115 };
 116
 117 } } } // end of namespace ::sd::slidesorter::model
 118
 119 #endif
 120
 121 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */