slideshow/source/inc/state.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: state.hxx,v $
  10  * $Revision: 1.6 $
  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 INCLUDED_SLIDESHOW_STATE_HXX
  32 #define INCLUDED_SLIDESHOW_STATE_HXX
  33
  34 #include <sal/types.h>
  35 #include <boost/shared_ptr.hpp>
  36
  37
  38 /* Definition of State interface */
  39
  40 namespace slideshow
  41 {
  42     namespace internal
  43     {
  44
  45         /** This interface represents a stateful object.
  46
  47             The state ID returned by the getStateId() method
  48             abstractly encodes the object's state. When this ID
  49             changes, clients can assume that the object's state has
  50             changed.
  51          */
  52         class State
  53         {
  54         public:
  55             virtual ~State() {}
  56
  57             /// Abstract, numerically encoded state ID
  58             typedef ::std::size_t StateId;
  59
  60             /** This method returns a numerical state identifier.
  61
  62                 The state ID returned by this method abstractly
  63                 encodes the object's state. When this ID changes,
  64                 clients can assume that the object's state has
  65                 changed.
  66
  67                 @return an abstract, numerical state ID.
  68              */
  69             virtual StateId getStateId() const = 0;
  70         };
  71
  72         typedef ::boost::shared_ptr< State > StateSharedPtr;
  73     }
  74 }
  75
  76 #endif /* INCLUDED_SLIDESHOW_STATE_HXX */