dali/devel-api/adaptor-framework/window-devel.h

   1 #ifndef DALI_WINDOW_DEVEL_H
   2 #define DALI_WINDOW_DEVEL_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 // INTERNAL INCLUDES
  22 #include <dali/public-api/adaptor-framework/window.h>
  23
  24 namespace Dali
  25 {
  26 class KeyEvent;
  27 class TouchData;
  28 class WheelEvent;
  29
  30 namespace DevelWindow
  31 {
  32
  33 typedef Signal< void () > EventProcessingFinishedSignalType;       ///< Event Processing finished signal type
  34
  35 typedef Signal< void (const KeyEvent&) > KeyEventSignalType;       ///< Key event signal type
  36
  37 typedef Signal< void (const TouchData&) > TouchSignalType;         ///< Touch signal type
  38
  39 typedef Signal< void (const WheelEvent&) > WheelEventSignalType;   ///< Touched signal type
  40
  41 /**
  42  * @brief Sets position and size of the window. This API guarantees that both moving and resizing of window will appear on the screen at once.
  43  *
  44  * @param[in] window The window instance
  45  * @param[in] positionSize The new window position and size
  46  */
  47 DALI_ADAPTOR_API void SetPositionSize( Window window, PositionSize positionSize );
  48
  49 /**
  50  * @brief Retrieve the window that the given actor is added to.
  51  *
  52  * @param[in] actor The actor
  53  * @return The window the actor is added to or an empty handle if the actor is not added to any window.
  54  */
  55 DALI_ADAPTOR_API Window Get( Actor actor );
  56
  57 /**
  58  * @brief This signal is emitted just after the event processing is finished.
  59  *
  60  * @param[in] window The window instance
  61  * @return The signal to connect to
  62  */
  63 DALI_ADAPTOR_API EventProcessingFinishedSignalType& EventProcessingFinishedSignal( Window window );
  64
  65 /**
  66  * @brief This signal is emitted when key event is received.
  67  *
  68  * A callback of the following type may be connected:
  69  * @code
  70  *   void YourCallbackName(const KeyEvent& event);
  71  * @endcode
  72  * @param[in] window The window instance
  73  * @return The signal to connect to
  74  */
  75 DALI_ADAPTOR_API KeyEventSignalType& KeyEventSignal( Window window );
  76
  77 /**
  78  * @brief This signal is emitted when the screen is touched and when the touch ends
  79  * (i.e. the down & up touch events only).
  80  *
  81  * If there are multiple touch points, then this will be emitted when the first touch occurs and
  82  * then when the last finger is lifted.
  83  * An interrupted event will also be emitted (if it occurs).
  84  * A callback of the following type may be connected:
  85  * @code
  86  *   void YourCallbackName( TouchData event );
  87  * @endcode
  88  *
  89  * @param[in] window The window instance
  90  * @return The touch signal to connect to
  91  * @note Motion events are not emitted.
  92  */
  93 DALI_ADAPTOR_API TouchSignalType& TouchSignal( Window window );
  94
  95 /**
  96  * @brief This signal is emitted when wheel event is received.
  97  *
  98  * A callback of the following type may be connected:
  99  * @code
 100  *   void YourCallbackName(const WheelEvent& event);
 101  * @endcode
 102  * @param[in] window The window instance
 103  * @return The signal to connect to
 104  */
 105 DALI_ADAPTOR_API WheelEventSignalType& WheelEventSignal( Window window );
 106
 107 } // namespace DevelWindow
 108
 109 } // namespace Dali
 110
 111 #endif // DALI_WINDOW_DEVEL_H