AOO410/main/sd/source/ui/slidesorter/inc/model/SlsPageEnumerationProvider.hxx

/**************************************************************
 * 
 * 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
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef SD_SLIDESORTER_PAGE_ENUMERATION_PROVIDER_HXX
#define SD_SLIDESORTER_PAGE_ENUMERATION_PROVIDER_HXX

#include "model/SlsPageEnumeration.hxx"

namespace sd { namespace slidesorter { namespace 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

#endif