1 #ifndef DALI_WINDOW_DEVEL_H
2 #define DALI_WINDOW_DEVEL_H
5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
24 #include <dali/public-api/common/vector-wrapper.h>
25 #include <dali/public-api/adaptor-framework/window.h>
37 * @brief Enumeration for transition effect's state.
39 enum class EffectState
41 NONE = 0, ///< None state
42 START, ///< Transition effect is started.
43 END ///< Transition effect is ended.
47 * @brief Enumeration for transition effect's type.
51 NONE = 0, ///< None type
52 SHOW, ///< Window show effect.
53 HIDE, ///< Window hide effect.
56 typedef Signal< void () > EventProcessingFinishedSignalType; ///< Event Processing finished signal type
58 typedef Signal< void (const KeyEvent&) > KeyEventSignalType; ///< Key event signal type
60 typedef Signal< void (const TouchData&) > TouchSignalType; ///< Touch signal type
62 typedef Signal< void (const WheelEvent&) > WheelEventSignalType; ///< Touched signal type
64 typedef Signal< void ( Window, bool ) > VisibilityChangedSignalType; ///< Visibility changed signal type
66 typedef Signal< void (Window, EffectState, EffectType) > TransitionEffectEventSignalType; ///< Effect signal type and state
69 * @brief Creates an initialized handle to a new Window.
71 * @param[in] surface Can be a window or pixmap.
72 * @param[in] windowPosition The position and size of the Window
73 * @param[in] name The Window title
74 * @param[in] isTransparent Whether Window is transparent
75 * @return A new window
76 * @note This creates an extra window in addition to the default main window
78 DALI_ADAPTOR_API Window New(Any surface, PositionSize windowPosition, const std::string& name, bool isTransparent = false);
81 * @brief Creates an initialized handle to a new Window.
83 * @param[in] surface Can be a window or pixmap.
84 * @param[in] windowPosition The position and size of the Window
85 * @param[in] name The Window title
86 * @param[in] className The Window class name
87 * @param[in] isTransparent Whether Window is transparent
88 * @note This creates an extra window in addition to the default main window
89 * @return A new Window
91 DALI_ADAPTOR_API Window New(Any surface, PositionSize windowPosition, const std::string& name, const std::string& className, bool isTransparent = false);
94 * @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.
96 * @param[in] window The window instance
97 * @param[in] positionSize The new window position and size
99 DALI_ADAPTOR_API void SetPositionSize( Window window, PositionSize positionSize );
102 * @brief Retrieves the list of render-tasks in the window.
104 * @param[in] window The window instance
105 * @return A valid handle to a RenderTaskList
107 DALI_ADAPTOR_API Dali::RenderTaskList GetRenderTaskList( Window window );
110 * @brief Retrieve the window that the given actor is added to.
112 * @param[in] actor The actor
113 * @return The window the actor is added to or an empty handle if the actor is not added to any window.
115 DALI_ADAPTOR_API Window Get( Actor actor );
118 * @brief This signal is emitted just after the event processing is finished.
120 * @param[in] window The window instance
121 * @return The signal to connect to
123 DALI_ADAPTOR_API EventProcessingFinishedSignalType& EventProcessingFinishedSignal( Window window );
126 * @brief This signal is emitted when key event is received.
128 * A callback of the following type may be connected:
130 * void YourCallbackName(const KeyEvent& event);
132 * @param[in] window The window instance
133 * @return The signal to connect to
135 DALI_ADAPTOR_API KeyEventSignalType& KeyEventSignal( Window window );
138 * @brief This signal is emitted when the screen is touched and when the touch ends
139 * (i.e. the down & up touch events only).
141 * If there are multiple touch points, then this will be emitted when the first touch occurs and
142 * then when the last finger is lifted.
143 * An interrupted event will also be emitted (if it occurs).
144 * A callback of the following type may be connected:
146 * void YourCallbackName( TouchData event );
149 * @param[in] window The window instance
150 * @return The touch signal to connect to
151 * @note Motion events are not emitted.
153 DALI_ADAPTOR_API TouchSignalType& TouchSignal( Window window );
156 * @brief This signal is emitted when wheel event is received.
158 * A callback of the following type may be connected:
160 * void YourCallbackName(const WheelEvent& event);
162 * @param[in] window The window instance
163 * @return The signal to connect to
165 DALI_ADAPTOR_API WheelEventSignalType& WheelEventSignal( Window window );
168 * @brief This signal is emitted when the window is shown or hidden.
170 * A callback of the following type may be connected:
172 * void YourCallbackName( Window window, bool visible );
174 * @param[in] window The window instance
175 * @return The signal to connect to
177 DALI_ADAPTOR_API VisibilityChangedSignalType& VisibilityChangedSignal( Window window );
180 * @brief This signal is emitted for transition effect.
182 * The transition animation is appeared when the window is shown/hidden.
183 * When the animation is started, START signal is emitted.
184 * Then the animation is ended, END signal is emitted, too.
185 * A callback of the following type may be connected:
187 * void YourCallbackName( Window window, EffectState state, EffectType type );
189 * @param[in] window The window instance
190 * @return The signal to connect to
192 DALI_ADAPTOR_API TransitionEffectEventSignalType& TransitionEffectEventSignal( Window window );
195 * @brief Sets parent window of the window.
197 * After setting that, these windows do together when raise-up, lower and iconified/deiconified.
198 * Initially, the window is located on top of the parent. The window can go below parent by calling Lower().
199 * If parent's window stack is changed by calling Raise() or Lower(), child windows are located on top of the parent again.
201 * @param[in] window The window instance
202 * @param[in] parent The parent window instance
204 DALI_ADAPTOR_API void SetParent( Window window, Window parent );
207 * @brief Unsets parent window of the window.
209 * After unsetting, the window is disconnected his parent window.
211 * @param[in] window The window instance
213 DALI_ADAPTOR_API void Unparent( Window window );
216 * @brief Gets parent window of the window.
218 * @param[in] window The window instance
219 * @return The parent window of the window
221 DALI_ADAPTOR_API Window GetParent( Window window );
224 * @brief Downcast sceneHolder to window
226 * @param[in] handle The handle need to downcast
227 * @return The window cast from SceneHolder
229 DALI_ADAPTOR_API Window DownCast( BaseHandle handle );
232 * @brief Gets current orientation of the window.
234 * @param[in] window The window instance
235 * @return The current window orientation if previously set, or none
237 DALI_ADAPTOR_API Dali::Window::WindowOrientation GetCurrentOrientation( Window window );
240 * @brief Sets available orientations of the window.
242 * This API is for setting several orientations one time.
244 * @param[in] window The window instance
245 * @param[in] orientations The available orientation list to add
247 DALI_ADAPTOR_API void SetAvailableOrientations( Window window, const Dali::Vector<Dali::Window::WindowOrientation>& orientations );
250 * @brief Gets current window ID.
252 * @param[in] window The window instance
254 DALI_ADAPTOR_API int32_t GetNativeId( Window window );
257 * @brief Sets damaged areas of the window.
259 * This API is for setting static damaged areas of the window for partial update.
261 * @param[in] window The window instance
262 * @param[in] areas The damaged areas list to set
264 DALI_ADAPTOR_API void SetDamagedAreas(Window window, std::vector<Dali::Rect<int>>& areas);
266 } // namespace DevelWindow
270 #endif // DALI_WINDOW_DEVEL_H