1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef SD_SLIDESORTER_PAGE_ENUMERATION_PROVIDER_HXX
25 #define SD_SLIDESORTER_PAGE_ENUMERATION_PROVIDER_HXX
26 
27 #include "model/SlsPageEnumeration.hxx"
28 
29 namespace sd { namespace slidesorter { namespace model {
30 
31 class SlideSorterModel;
32 
33 /** Collection of methods that create enumeration of slides.
34 */
35 class PageEnumerationProvider
36 {
37 public:
38     /** The returned enumeration of slides iterates over all slides of the
39         given model.
40     */
41     static PageEnumeration CreateAllPagesEnumeration (const SlideSorterModel& rModel);
42 
43     /** The returned enumeration of slides iterates over the currently
44         selected slides of the given model.
45     */
46     static PageEnumeration CreateSelectedPagesEnumeration (const SlideSorterModel& rModel);
47 
48     /** The returned enumeration of slides iterates over the slides
49         (partially) inside the visible area.
50     */
51     static PageEnumeration CreateVisiblePagesEnumeration (const SlideSorterModel& rModel);
52 };
53 
54 } } } // end of namespace ::sd::slidesorter::model
55 
56 #endif
57