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