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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: SlsPageEnumerationProvider.hxx,v $
  10  *
  11  * $Revision: 1.3 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #ifndef SD_SLIDESORTER_PAGE_ENUMERATION_PROVIDER_HXX
  33 #define SD_SLIDESORTER_PAGE_ENUMERATION_PROVIDER_HXX
  34
  35 #include "model/SlsPageEnumeration.hxx"
  36
  37 namespace sd { namespace slidesorter { namespace model {
  38
  39 class SlideSorterModel;
  40
  41 /** Collection of methods that create enumeration of slides.
  42 */
  43 class PageEnumerationProvider
  44 {
  45 public:
  46     /** The returned enumeration of slides iterates over all slides of the
  47         given model.
  48     */
  49     static PageEnumeration CreateAllPagesEnumeration (const SlideSorterModel& rModel);
  50
  51     /** The returned enumeration of slides iterates over the currently
  52         selected slides of the given model.
  53     */
  54     static PageEnumeration CreateSelectedPagesEnumeration (const SlideSorterModel& rModel);
  55
  56     /** The returned enumeration of slides iterates over the slides
  57         (partially) inside the visible area.
  58     */
  59     static PageEnumeration CreateVisiblePagesEnumeration (const SlideSorterModel& rModel);
  60 };
  61
  62 } } } // end of namespace ::sd::slidesorter::model
  63
  64 #endif