1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef INCLUDED_SLIDESHOW_STATE_HXX 29*cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_STATE_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir #include <sal/types.h> 32*cdf0e10cSrcweir #include <boost/shared_ptr.hpp> 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir /* Definition of State interface */ 36*cdf0e10cSrcweir 37*cdf0e10cSrcweir namespace slideshow 38*cdf0e10cSrcweir { 39*cdf0e10cSrcweir namespace internal 40*cdf0e10cSrcweir { 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir /** This interface represents a stateful object. 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir The state ID returned by the getStateId() method 45*cdf0e10cSrcweir abstractly encodes the object's state. When this ID 46*cdf0e10cSrcweir changes, clients can assume that the object's state has 47*cdf0e10cSrcweir changed. 48*cdf0e10cSrcweir */ 49*cdf0e10cSrcweir class State 50*cdf0e10cSrcweir { 51*cdf0e10cSrcweir public: 52*cdf0e10cSrcweir virtual ~State() {} 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir /// Abstract, numerically encoded state ID 55*cdf0e10cSrcweir typedef ::std::size_t StateId; 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir /** This method returns a numerical state identifier. 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir The state ID returned by this method abstractly 60*cdf0e10cSrcweir encodes the object's state. When this ID changes, 61*cdf0e10cSrcweir clients can assume that the object's state has 62*cdf0e10cSrcweir changed. 63*cdf0e10cSrcweir 64*cdf0e10cSrcweir @return an abstract, numerical state ID. 65*cdf0e10cSrcweir */ 66*cdf0e10cSrcweir virtual StateId getStateId() const = 0; 67*cdf0e10cSrcweir }; 68*cdf0e10cSrcweir 69*cdf0e10cSrcweir typedef ::boost::shared_ptr< State > StateSharedPtr; 70*cdf0e10cSrcweir } 71*cdf0e10cSrcweir } 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_STATE_HXX */ 74