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) 2021 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 namespace Integration
  26 {
  27 struct WheelEvent;
  28 }
  29
  30 namespace Internal
  31 {
  32 class Scene;
  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    * Create a wheel event processor.
  47    */
  48   WheelEventProcessor(Scene& scenes);
  49
  50   /**
  51    * Non-virtual destructor; WheelEventProcessor is not a base class
  52    */
  53   ~WheelEventProcessor();
  54
  55   /**
  56    * This function is called by the event processor whenever a nouse wheel event occurs.
  57    * @param[in] event The wheel event that has occurred.
  58    */
  59   void ProcessWheelEvent(const Integration::WheelEvent& event);
  60
  61 private:
  62   // Undefined
  63   WheelEventProcessor(const WheelEventProcessor&);
  64
  65   // Undefined
  66   WheelEventProcessor& operator=(const WheelEventProcessor& rhs);
  67
  68 private:
  69   Scene& mScene; ///< Used to deliver the wheel events
  70 };
  71
  72 } // namespace Internal
  73
  74 } // namespace Dali
  75
  76 #endif // DALI_INTERNAL_WHEEL_EVENT_PROCESSOR_H