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