sd/source/ui/slidesorter/inc/model/SlsEnumeration.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_SLSENUMERATION_HXX
  21 #define INCLUDED_SD_SOURCE_UI_SLIDESORTER_INC_MODEL_SLSENUMERATION_HXX
  22
  23 #include <memory>
  24
  25 namespace sd { namespace slidesorter { namespace model {
  26
  27 /** Interface to generic enumerations.  Designed to operate on shared
  28     pointers.  Therefore GetNextElement() returns T and not T&.
  29 */
  30 template <class T>
  31 class Enumeration
  32 {
  33 public:
  34     virtual ~Enumeration() {}
  35
  36     virtual bool HasMoreElements() const = 0;
  37     /** Returns T instead of T& so that it can handle shared pointers.
  38     */
  39     virtual T GetNextElement() = 0;
  40     virtual void Rewind() = 0;
  41     virtual ::std::unique_ptr<Enumeration<T> > Clone() = 0;
  42 };
  43
  44 } } } // end of namespace ::sd::slidesorter::model
  45
  46 #endif
  47
  48 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */