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.
25 #include <dali/public-api/common/vector-wrapper.h>
26 #include <dali/public-api/adaptor-framework/window.h>
38 * @brief Enumeration for transition effect's state.
40 enum class EffectState
42 NONE = 0, ///< None state
43 START, ///< Transition effect is started.
44 END ///< Transition effect is ended.
48 * @brief Enumeration for transition effect's type.
52 NONE = 0, ///< None type
53 SHOW, ///< Window show effect.
54 HIDE, ///< Window hide effect.
57 typedef Signal< void () > EventProcessingFinishedSignalType; ///< Event Processing finished signal type
59 typedef Signal< void (const KeyEvent&) > KeyEventSignalType; ///< Key event signal type
61 typedef Signal< void (const TouchData&) > TouchSignalType; ///< Touch signal type
63 typedef Signal< void (const WheelEvent&) > WheelEventSignalType; ///< Touched signal type
65 typedef Signal< void ( Window, bool ) > VisibilityChangedSignalType; ///< Visibility changed signal type
67 typedef Signal< void (Window, EffectState, EffectType) > TransitionEffectEventSignalType; ///< Effect signal type and state
70 * @brief Creates an initialized handle to a new Window.
72 * @param[in] surface Can be a window or pixmap.
73 * @param[in] windowPosition The position and size of the Window
74 * @param[in] name The Window title
75 * @param[in] isTransparent Whether Window is transparent
76 * @return A new window
77 * @note This creates an extra window in addition to the default main window
79 DALI_ADAPTOR_API Window New(Any surface, PositionSize windowPosition, const std::string& name, bool isTransparent = false);
82 * @brief Creates an initialized handle to a new Window.
84 * @param[in] surface Can be a window or pixmap.
85 * @param[in] windowPosition The position and size of the Window
86 * @param[in] name The Window title
87 * @param[in] className The Window class name
88 * @param[in] isTransparent Whether Window is transparent
89 * @note This creates an extra window in addition to the default main window
90 * @return A new Window
92 DALI_ADAPTOR_API Window New(Any surface, PositionSize windowPosition, const std::string& name, const std::string& className, bool isTransparent = false);
95 * @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.
97 * @param[in] window The window instance
98 * @param[in] positionSize The new window position and size
100 DALI_ADAPTOR_API void SetPositionSize( Window window, PositionSize positionSize );
103 * @brief Retrieve the window that the given actor is added to.
105 * @param[in] actor The actor
106 * @return The window the actor is added to or an empty handle if the actor is not added to any window.
108 DALI_ADAPTOR_API Window Get( Actor actor );
111 * @brief This signal is emitted just after the event processing is finished.
113 * @param[in] window The window instance
114 * @return The signal to connect to
116 DALI_ADAPTOR_API EventProcessingFinishedSignalType& EventProcessingFinishedSignal( Window window );
119 * @brief This signal is emitted when wheel event is received.
121 * A callback of the following type may be connected:
123 * void YourCallbackName(const WheelEvent& event);
125 * @param[in] window The window instance
126 * @return The signal to connect to
128 DALI_ADAPTOR_API WheelEventSignalType& WheelEventSignal( Window window );
131 * @brief This signal is emitted when the window is shown or hidden.
133 * A callback of the following type may be connected:
135 * void YourCallbackName( Window window, bool visible );
137 * @param[in] window The window instance
138 * @return The signal to connect to
140 DALI_ADAPTOR_API VisibilityChangedSignalType& VisibilityChangedSignal( Window window );
143 * @brief This signal is emitted for transition effect.
145 * The transition animation is appeared when the window is shown/hidden.
146 * When the animation is started, START signal is emitted.
147 * Then the animation is ended, END signal is emitted, too.
148 * A callback of the following type may be connected:
150 * void YourCallbackName( Window window, EffectState state, EffectType type );
152 * @param[in] window The window instance
153 * @return The signal to connect to
155 DALI_ADAPTOR_API TransitionEffectEventSignalType& TransitionEffectEventSignal( Window window );
158 * @brief Sets parent window of the window.
160 * After setting that, these windows do together when raise-up, lower and iconified/deiconified.
161 * Initially, the window is located on top of the parent. The window can go below parent by calling Lower().
162 * If parent's window stack is changed by calling Raise() or Lower(), child windows are located on top of the parent again.
164 * @param[in] window The window instance
165 * @param[in] parent The parent window instance
167 DALI_ADAPTOR_API void SetParent( Window window, Window parent );
170 * @brief Unsets parent window of the window.
172 * After unsetting, the window is disconnected his parent window.
174 * @param[in] window The window instance
176 DALI_ADAPTOR_API void Unparent( Window window );
179 * @brief Gets parent window of the window.
181 * @param[in] window The window instance
182 * @return The parent window of the window
184 DALI_ADAPTOR_API Window GetParent( Window window );
187 * @brief Downcast sceneHolder to window
189 * @param[in] handle The handle need to downcast
190 * @return The window cast from SceneHolder
192 DALI_ADAPTOR_API Window DownCast( BaseHandle handle );
195 * @brief Gets current orientation of the window.
197 * @param[in] window The window instance
198 * @return The current window orientation if previously set, or none
200 DALI_ADAPTOR_API Dali::Window::WindowOrientation GetCurrentOrientation( Window window );
203 * @brief Sets available orientations of the window.
205 * This API is for setting several orientations one time.
207 * @param[in] window The window instance
208 * @param[in] orientations The available orientation list to add
210 DALI_ADAPTOR_API void SetAvailableOrientations( Window window, const Dali::Vector<Dali::Window::WindowOrientation>& orientations );
213 * @brief Gets current window ID.
215 * @param[in] window The window instance
217 DALI_ADAPTOR_API int32_t GetNativeId( Window window );
220 * @brief Sets damaged areas of the window.
222 * This API is for setting static damaged areas of the window for partial update.
224 * @param[in] window The window instance
225 * @param[in] areas The damaged areas list to set
227 DALI_ADAPTOR_API void SetDamagedAreas(Window window, std::vector<Dali::Rect<int>>& areas);
230 * @brief Adds a callback that is called when the frame rendering is done by the graphics driver.
232 * @param[in] window The window instance
233 * @param[in] callback The function to call
234 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
236 * @note A callback of the following type may be used:
238 * void MyFunction( int frameId );
240 * This callback will be deleted once it is called.
242 * @note Ownership of the callback is passed onto this class.
244 DALI_ADAPTOR_API void AddFrameRenderedCallback( Window window, std::unique_ptr< CallbackBase > callback, int32_t frameId );
247 * @brief Adds a callback that is called when the frame is displayed on the display.
249 * @param[in] window The window instance
250 * @param[in] callback The function to call
251 * @param[in] frameId The Id to specify the frame. It will be passed when the callback is called.
253 * @note A callback of the following type may be used:
255 * void MyFunction( int frameId );
257 * This callback will be deleted once it is called.
259 * @note Ownership of the callback is passed onto this class.
261 DALI_ADAPTOR_API void AddFramePresentedCallback( Window window, std::unique_ptr< CallbackBase > callback, int32_t frameId );
263 } // namespace DevelWindow
267 #endif // DALI_WINDOW_DEVEL_H