sd/source/ui/slidesorter/inc/model/SlsEnumeration.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: SlsEnumeration.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SD_SLIDESORTER_ENUMERATION_HXX
  32 #define SD_SLIDESORTER_ENUMERATION_HXX
  33
  34 #include <memory>
  35
  36 namespace sd { namespace slidesorter { namespace model {
  37
  38
  39 /** Interface to generic enumerations.  Designed to operate on shared
  40     pointers.  Therefore GetNextElement() returns T and not T&.
  41 */
  42 template <class T>
  43 class Enumeration
  44 {
  45 public:
  46     virtual bool HasMoreElements (void) const = 0;
  47     /** Returns T instead of T& so that it can handle shared pointers.
  48     */
  49     virtual T GetNextElement (void) = 0;
  50     virtual void Rewind (void) = 0;
  51     virtual ::std::auto_ptr<Enumeration<T> > Clone (void) = 0;
  52 };
  53
  54 } } } // end of namespace ::sd::slidesorter::model
  55
  56 #endif