adaptors/base/core-event-interface.h

   1 #ifndef __DALI_INTERNAL_ADAPTOR_CORE_EVENT_INTERFACE_H__
   2 #define __DALI_INTERNAL_ADAPTOR_CORE_EVENT_INTERFACE_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 namespace Dali
  21 {
  22
  23 namespace Integration
  24 {
  25 struct Event;
  26 }
  27
  28 namespace Internal
  29 {
  30
  31 namespace Adaptor
  32 {
  33
  34 /**
  35  * This interface should be used by adaptor components to send events to Core.
  36  * This is preferable to using Core directly i.e. so there is a common place for measuring performance.
  37  */
  38 class CoreEventInterface
  39 {
  40 public:
  41
  42   /**
  43    * Queue an event with Core.
  44    * @param[in] event The new event.
  45    */
  46   virtual void QueueCoreEvent(const Dali::Integration::Event& event) = 0;
  47
  48   /**
  49    * Process the events queued with QueueEvent().
  50    */
  51   virtual void ProcessCoreEvents() = 0;
  52
  53 protected:
  54
  55   /**
  56    * Protected virtual destructor
  57    */
  58   virtual ~CoreEventInterface() {}
  59 };
  60
  61 } // namespace Internal
  62
  63 } // namespace Adaptor
  64
  65 } // namespace Dali
  66
  67 #endif // __DALI_INTERNAL_ADAPTOR_CORE_EVENT_INTERFACE_H__