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