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