dali/internal/event/events/wheel-event-processor.h

   1 #ifndef __DALI_INTERNAL_WHEEL_EVENT_PROCESSOR_H__
   2 #define __DALI_INTERNAL_WHEEL_EVENT_PROCESSOR_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 namespace Dali
  22 {
  23
  24 namespace Integration
  25 {
  26 struct WheelEvent;
  27 }
  28
  29 namespace Internal
  30 {
  31
  32 class Stage;
  33
  34 /**
  35  *  WheelEventProcessor receives the wheel events from the Dali Event processor.
  36  *
  37  *  When a wheel event is received the WheelEvent Processor emits the Wheeled signal
  38  *  on the hit actor (and its parents).
  39  *
  40  * - Hit Testing is described in Dali::Actor.
  41  */
  42 class WheelEventProcessor
  43 {
  44 public:
  45
  46   /**
  47    * Create a wheel event processor.
  48    */
  49   WheelEventProcessor(Stage& stage);
  50
  51   /**
  52    * Non-virtual destructor; WheelEventProcessor is not a base class
  53    */
  54   ~WheelEventProcessor();
  55
  56   /**
  57    * This function is called by the event processor whenever a nouse wheel event occurs.
  58    * @param[in] event The wheel event that has occurred.
  59    */
  60   void ProcessWheelEvent(const Integration::WheelEvent& event);
  61
  62 private:
  63
  64   // Undefined
  65   WheelEventProcessor(const WheelEventProcessor&);
  66
  67   // Undefined
  68   WheelEventProcessor& operator=(const WheelEventProcessor& rhs);
  69
  70 private:
  71
  72   Stage& mStage;               ///< Used to deliver the wheel events
  73 };
  74
  75 } // namespace Internal
  76
  77 } // namespace Dali
  78
  79 #endif // __DALI_INTERNAL_WHEEL_EVENT_PROCESSOR_H__