dali/devel-api/events/wheel-event-devel.h

   1 #ifndef DALI_WHEEL_EVENT_DEVEL_H\r
   2 #define DALI_WHEEL_EVENT_DEVEL_H\r
   3 \r
   4 /*\r
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.\r
   6  *\r
   7  * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * you may not use this file except in compliance with the License.\r
   9  * You may obtain a copy of the License at\r
  10  *\r
  11  * http://www.apache.org/licenses/LICENSE-2.0\r
  12  *\r
  13  * Unless required by applicable law or agreed to in writing, software\r
  14  * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * See the License for the specific language governing permissions and\r
  17  * limitations under the License.\r
  18  *\r
  19  */\r
  20 \r
  21 // INTERNAL INCLUDES\r
  22 #include <dali/public-api/events/wheel-event.h>\r
  23 \r
  24 namespace Dali\r
  25 {\r
  26 namespace DevelWheelEvent\r
  27 {\r
  28 /**\r
  29  * @brief Creates an initialized WheelEvent.\r
  30  *\r
  31  * @SINCE_1_9.26\r
  32  * @param[in] type      The type of the wheel event\r
  33  * @param[in] direction The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel)\r
  34  * @param[in] modifiers Modifier keys pressed during the event (such as shift, alt and control)\r
  35  * @param[in] point     The co-ordinates of the cursor relative to the top-left of the screen\r
  36  * @param[in] delta     The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise)\r
  37  * @param[in] timeStamp The time the wheel is being rolled\r
  38  * @return A handle to a newly allocated Dali resource\r
  39  */\r
  40 DALI_CORE_API WheelEvent New(WheelEvent::Type type, int32_t direction, uint32_t modifiers, Vector2 point, int32_t delta, uint32_t timeStamp);\r
  41 \r
  42 } // namespace DevelWheelEvent\r
  43 \r
  44 } // namespace Dali\r
  45 \r
  46 #endif // DALI_WHEEL_EVENT_DEVEL_H\r