slideshow/source/inc/event.hxx

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