Branch data     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                 :            : #ifndef INCLUDED_SLIDESHOW_EVENT_HXX
      20                 :            : #define INCLUDED_SLIDESHOW_EVENT_HXX
      21                 :            : 
      22                 :            : #include "disposable.hxx"
      23                 :            : #include <rtl/ustring.hxx>
      24                 :            : #include <boost/shared_ptr.hpp>
      25                 :            : #include <vector>
      26                 :            : 
      27                 :            : namespace slideshow {
      28                 :            : namespace internal {
      29                 :            : 
      30                 :            : /** Definition of Event interface
      31                 :            :  */
      32                 :          0 : class Event : public Disposable
      33                 :            : {
      34                 :            : public:
      35                 :            : #if OSL_DEBUG_LEVEL > 1
      36                 :            :     Event (const ::rtl::OUString& rsDescription) : msDescription(rsDescription) {};
      37                 :            : #endif
      38                 :            : 
      39                 :            :     /** Execute the event.
      40                 :            : 
      41                 :            :         @return true, if event was successfully executed.
      42                 :            :     */
      43                 :            :     virtual bool fire() = 0;
      44                 :            : 
      45                 :            :     /** Query whether this event is still charged, i.e. able
      46                 :            :         to fire.
      47                 :            : 
      48                 :            :         Inactive events are ignored by the normal event
      49                 :            :         containers (EventQueue, UserEventQueue etc.), and no
      50                 :            :         explicit fire() is called upon them.
      51                 :            : 
      52                 :            :         @return true, if this event has already been fired.
      53                 :            :     */
      54                 :            :     virtual bool isCharged() const = 0;
      55                 :            : 
      56                 :            :     /** Query the activation time instant this event shall be
      57                 :            :         fired, if it was inserted at instant nCurrentTime into
      58                 :            :         the queue.
      59                 :            : 
      60                 :            :         @param nCurrentTime
      61                 :            :         The time from which the activation time is to be
      62                 :            :         calculated from.
      63                 :            : 
      64                 :            :         @return the time instant in seconds, on which this
      65                 :            :         event is to be fired.
      66                 :            :     */
      67                 :            :     virtual double getActivationTime( double nCurrentTime ) const = 0;
      68                 :            : 
      69                 :            : #if OSL_DEBUG_LEVEL > 1
      70                 :            :     ::rtl::OUString GetDescription (void) const { return msDescription; }
      71                 :            : 
      72                 :            : private:
      73                 :            :     const ::rtl::OUString msDescription;
      74                 :            : #endif
      75                 :            : };
      76                 :            : 
      77                 :            : typedef ::boost::shared_ptr< Event > EventSharedPtr;
      78                 :            : typedef ::std::vector< EventSharedPtr > VectorOfEvents;
      79                 :            : 
      80                 :            : } // namespace internal
      81                 :            : } // namespace presentation
      82                 :            : 
      83                 :            : #endif /* INCLUDED_SLIDESHOW_EVENT_HXX */
      84                 :            : 
      85                 :            : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */