sd/source/ui/slidesorter/inc/model/SlsPageEnumerationProvider.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_SLSPAGEENUMERATIONPROVIDER_HXX
  21 #define INCLUDED_SD_SOURCE_UI_SLIDESORTER_INC_MODEL_SLSPAGEENUMERATIONPROVIDER_HXX
  22
  23 #include "model/SlsPageEnumeration.hxx"
  24
  25 namespace sd { namespace slidesorter { namespace model {
  26
  27 class SlideSorterModel;
  28
  29 /** Collection of methods that create enumeration of slides.
  30 */
  31 class PageEnumerationProvider
  32 {
  33 public:
  34     /** The returned enumeration of slides iterates over all slides of the
  35         given model.
  36     */
  37     static PageEnumeration CreateAllPagesEnumeration (const SlideSorterModel& rModel);
  38
  39     /** The returned enumeration of slides iterates over the currently
  40         selected slides of the given model.
  41     */
  42     static PageEnumeration CreateSelectedPagesEnumeration (const SlideSorterModel& rModel);
  43
  44     /** The returned enumeration of slides iterates over the slides
  45         (partially) inside the visible area.
  46     */
  47     static PageEnumeration CreateVisiblePagesEnumeration (const SlideSorterModel& rModel);
  48 };
  49
  50 } } } // end of namespace ::sd::slidesorter::model
  51
  52 #endif
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */