Line data    Source code

       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             : #ifndef INCLUDED_SLIDESHOW_STATE_HXX
      21             : #define INCLUDED_SLIDESHOW_STATE_HXX
      22             : 
      23             : #include <sal/types.h>
      24             : #include <boost/shared_ptr.hpp>
      25             : 
      26             : 
      27             : /* Definition of State interface */
      28             : 
      29             : namespace slideshow
      30             : {
      31             :     namespace internal
      32             :     {
      33             : 
      34             :         /** This interface represents a stateful object.
      35             : 
      36             :             The state ID returned by the getStateId() method
      37             :             abstractly encodes the object's state. When this ID
      38             :             changes, clients can assume that the object's state has
      39             :             changed.
      40             :          */
      41             :         class State
      42             :         {
      43             :         public:
      44           0 :             virtual ~State() {}
      45             : 
      46             :             /// Abstract, numerically encoded state ID
      47             :             typedef ::std::size_t StateId;
      48             : 
      49             :             /** This method returns a numerical state identifier.
      50             : 
      51             :                 The state ID returned by this method abstractly
      52             :                 encodes the object's state. When this ID changes,
      53             :                 clients can assume that the object's state has
      54             :                 changed.
      55             : 
      56             :                 @return an abstract, numerical state ID.
      57             :              */
      58             :             virtual StateId getStateId() const = 0;
      59             :         };
      60             : 
      61             :         typedef ::boost::shared_ptr< State > StateSharedPtr;
      62             :     }
      63             : }
      64             : 
      65             : #endif /* INCLUDED_SLIDESHOW_STATE_HXX */
      66             : 
      67             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */