adaptors/base/interfaces/trigger-event-interface.h

   1 #ifndef __DALI_INTERNAL_ADAPTOR_BASE_TRIGGER_EVENT_INTERFACE_H__
   2 #define __DALI_INTERNAL_ADAPTOR_BASE_TRIGGER_EVENT_INTERFACE_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21
  22 namespace Dali
  23 {
  24
  25 namespace Internal
  26 {
  27
  28 namespace Adaptor
  29 {
  30
  31 /**
  32  * @brief Interface for a trigger event class.
  33  *
  34  * The trigger event is a way of running a function call back on the main event thread of Dali.
  35  * To create a trigger event use the factory interface.
  36  */
  37 class TriggerEventInterface
  38 {
  39
  40 public:
  41
  42   /**
  43    * @brief trigger event options
  44    */
  45   enum Options
  46   {
  47     NONE,
  48     DELETE_AFTER_TRIGGER,  // automatically delete the trigger event object, after Trigger() is called.
  49   };
  50
  51   /**
  52    * @brief Triggers the event.
  53    * This method cannot ever block, it needs to return immediately.
  54    * This can be called from one thread in order to wake up another thread.
  55    */
  56   virtual void Trigger() = 0;
  57
  58 protected:
  59
  60   /**
  61    * @brief Constructor
  62    */
  63   TriggerEventInterface( )
  64   {
  65   }
  66
  67   /**
  68    * @brief Virtual destructor
  69    */
  70   virtual ~TriggerEventInterface()
  71   {
  72   }
  73
  74 private:
  75
  76   // Undefined copy constructor.
  77   TriggerEventInterface( const TriggerEventInterface& );
  78
  79   // Undefined assignment operator.
  80   TriggerEventInterface& operator=( const TriggerEventInterface& );
  81
  82
  83 };
  84
  85 } // namespace Adaptor
  86
  87 } // namespace Internal
  88
  89 } // namespace Dali
  90
  91 #endif // __DALI_INTERNAL_ADAPTOR_BASE_TRIGGER_EVENT_INTERFACE_H__