include/svx/sdr/event/eventhandler.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
  20 #ifndef _SDR_EVENT_EVENTHANDLER_HXX
  21 #define _SDR_EVENT_EVENTHANDLER_HXX
  22
  23 #include <sal/types.h>
  24
  25 #include <vector>
  26 #include <vcl/timer.hxx>
  27
  28 //////////////////////////////////////////////////////////////////////////////
  29 // predeclarations
  30
  31 namespace sdr
  32 {
  33     namespace event
  34     {
  35         class BaseEvent;
  36         class EventHandler;
  37
  38         // typedefs for a list of BaseEvents
  39         typedef ::std::vector< BaseEvent* > BaseEventVector;
  40     } // end of namespace event
  41 } // end of namespace sdr
  42
  43 //////////////////////////////////////////////////////////////////////////////
  44
  45 namespace sdr
  46 {
  47     namespace event
  48     {
  49         class BaseEvent
  50         {
  51             // the EventHandler this event is registered at
  52             EventHandler&                                   mrEventHandler;
  53
  54         public:
  55             // basic constructor.
  56             BaseEvent(EventHandler& rEventHandler);
  57
  58             // destructor
  59             virtual ~BaseEvent();
  60
  61             // the called method if the event is triggered
  62             virtual void ExecuteEvent() = 0;
  63         };
  64     } // end of namespace event
  65 } // end of namespace sdr
  66
  67 //////////////////////////////////////////////////////////////////////////////
  68
  69 namespace sdr
  70 {
  71     namespace event
  72     {
  73         class EventHandler
  74         {
  75             BaseEventVector                                 maVector;
  76
  77             // to allow BaseEvents to use the add/remove functionality
  78             friend class BaseEvent;
  79
  80             // methods to add/remove events. These are private since
  81             // they are used from BaseEvent only.
  82             void AddEvent(BaseEvent& rBaseEvent);
  83             void RemoveEvent(BaseEvent& rBaseEvent);
  84
  85             // access to a event, 0L when no more events
  86             BaseEvent* GetEvent();
  87
  88         public:
  89             // basic constructor.
  90             EventHandler();
  91
  92             // destructor
  93             virtual ~EventHandler();
  94
  95             // Trigger and consume the events
  96             virtual void ExecuteEvents();
  97
  98             // for control
  99             bool IsEmpty() const;
 100         };
 101     } // end of namespace event
 102 } // end of namespace sdr
 103
 104 //////////////////////////////////////////////////////////////////////////////
 105
 106 namespace sdr
 107 {
 108     namespace event
 109     {
 110         class TimerEventHandler : public EventHandler, public Timer
 111         {
 112         public:
 113             // basic constructor.
 114             TimerEventHandler(sal_uInt32 nTimeout = 1L);
 115
 116             // destructor
 117             virtual ~TimerEventHandler();
 118
 119             // The timer when it is triggered; from class Timer
 120             virtual void Timeout();
 121
 122             // reset the timer
 123             void Restart();
 124         };
 125     } // end of namespace event
 126 } // end of namespace sdr
 127
 128 //////////////////////////////////////////////////////////////////////////////
 129
 130 #endif //_SDR_EVENT_EVENTHANDLER_HXX
 131
 132 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */