adaptors/integration-api/trigger-event-interface.h

   1 #ifndef __DALI_INTEGRATION_TRIGGER_EVENT_INTERFACE_H__
   2 #define __DALI_INTEGRATION_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 /**
  26  * @brief Interface for a trigger event class.
  27  *
  28  * The trigger event is a way of running a function call back on the main event thread of Dali.
  29  * To create a trigger event use the factory interface.
  30  */
  31 class TriggerEventInterface
  32 {
  33
  34 public:
  35
  36   /**
  37    * @brief trigger event options
  38    */
  39   enum Options
  40   {
  41     KEEP_ALIVE_AFTER_TRIGGER,
  42     DELETE_AFTER_TRIGGER,  // automatically delete the trigger event object, after Trigger() is called.
  43   };
  44
  45   /**
  46    * @brief Triggers the event.
  47    * This method cannot ever block, it needs to return immediately.
  48    * This can be called from one thread in order to wake up another thread.
  49    */
  50   virtual void Trigger() = 0;
  51
  52 protected:
  53
  54   /**
  55    * @brief Constructor
  56    */
  57   TriggerEventInterface( )
  58   {
  59   }
  60
  61 public:
  62   /**
  63    * @brief Virtual destructor
  64    */
  65   virtual ~TriggerEventInterface()
  66   {
  67   }
  68
  69 private:
  70
  71   // Undefined copy constructor.
  72   TriggerEventInterface( const TriggerEventInterface& );
  73
  74   // Undefined assignment operator.
  75   TriggerEventInterface& operator=( const TriggerEventInterface& );
  76
  77
  78 };
  79
  80 } // namespace Dali
  81
  82 #endif // __DALI_INTEGRATION_TRIGGER_EVENT_INTERFACE_H__