dali/integration-api/events/event.h

   1 #ifndef __DALI_INTEGRATION_EVENT_H__
   2 #define __DALI_INTEGRATION_EVENT_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 // INTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-common.h>
  23
  24 namespace Dali DALI_IMPORT_API
  25 {
  26
  27 namespace Integration
  28 {
  29
  30 /**
  31  * Base structure for events passed to Dali::Integration::Core::QueueEvent()
  32  * An instance of this class cannot be created.
  33  */
  34 struct Event
  35 {
  36   // Destruction
  37
  38   /**
  39    * Virtual destructor.
  40    */
  41   virtual ~Event();
  42
  43   // Enumerations
  44
  45   enum Type
  46   {
  47     Touch,         ///< A touch event, when the user interacts with the screen.
  48     Key,           ///< A key pressed event, from the virtual or external keyboard.
  49     Gesture,       ///< A Gesture event has been detected.
  50     Wheel,         ///< A wheel event, when the wheel is being rolled from an external mouse.
  51     Hover          ///< A hover event, when the user hovers above the screen.
  52   };
  53
  54   // Data
  55
  56   /**
  57    * The event type.
  58    */
  59   Type type;
  60
  61 protected: // Constructors only to be used by derived structures.
  62
  63   /**
  64    * This constructor is only used by derived classes.
  65    * @param[in] eventType The type of event.
  66    */
  67   Event(Type eventType);
  68 };
  69
  70 } // namespace Integration
  71
  72 } // namespace Dali
  73
  74 #endif // __DALI_INTEGRATION_EVENT_H__