1 #ifndef DALI_WINDOW_DEVEL_H
2 #define DALI_WINDOW_DEVEL_H
5 * Copyright (c) 2017 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.
23 #include <dali/public-api/math/rect.h>
26 #ifdef DALI_ADAPTOR_COMPILATION // full path doesn't exist until adaptor is installed so we have to use relative
29 #include <dali/public-api/adaptor-framework/window.h>
38 namespace NotificationLevel
42 * @brief An enum of notification window's priority level.
46 NONE = -1, ///< No notification level. Default level. This value makes the notification window place in the layer of the normal window.
47 BASE = 10, ///< Base notification level.
48 MEDIUM = 20, ///< Higher notification level than base.
49 HIGH = 30, ///< Higher notification level than medium.
50 TOP = 40 ///< The highest notification level.
53 } // namespace NotificationLevel
59 * @brief An enum of screen mode.
63 DEFAULT, ///< The mode which turns the screen off after a timeout.
64 ALWAYS_ON ///< The mode which keeps the screen turned on.
67 } // namespace ScreenMode
70 * @brief An enum of Window types.
74 NORMAL, ///< A default window type. Indicates a normal, top-level window. Almost every window will be created with this type.
75 NOTIFICATION, ///< A notification window, like a warning about battery life or a new E-Mail received.
76 UTILITY, ///< A persistent utility window, like a toolbox or palette.
77 DIALOG ///< Used for simple dialog windows.
80 typedef Signal< void (bool) > FocusSignalType; ///< Window focus signal type
83 * @brief The user should connect to this signal to get a timing when window gains focus or loses focus.
85 * A callback of the following type may be connected:
87 * void YourCallbackName( bool focusIn );
89 * The parameter is true if window gains focus, otherwise false.
91 * @param[in] window The window to get a signal
92 * @return The signal to connect to
94 DALI_IMPORT_API FocusSignalType& FocusChangedSignal( Window window );
97 * @brief Sets whether window accepts focus or not.
99 * @param[in] window The window to accept focus
100 * @param[in] accept If focus is accepted or not. Default is true.
102 DALI_IMPORT_API void SetAcceptFocus( Window window, bool accept );
105 * @brief Returns whether window accepts focus or not.
107 * @param[in] window The window to accept focus
108 * @return True if the window accept focus, false otherwise
110 DALI_IMPORT_API bool IsFocusAcceptable( Window window );
113 * @brief Shows the window if it is hidden.
114 * @param[in] window The window to show
116 DALI_IMPORT_API void Show( Window window );
119 * @brief Hides the window if it is showing.
120 * @param[in] window The window to hide
122 DALI_IMPORT_API void Hide( Window window );
125 * @brief Returns whether the window is visible or not.
126 * @param[in] window The window to query
127 * @return True if the window is visible, false otherwise.
129 DALI_IMPORT_API bool IsVisible( Window window );
132 * @brief Gets the count of supported auxiliary hints of the window.
133 * @param[in] window The window to get the hint count
134 * @return The number of supported auxiliary hints.
136 * @note The window auxiliary hint is the value which is used to decide which actions should be made available to the user by the window manager.
137 * If you want to set specific hint to your window, then you should check whether it exists in the supported auxiliary hints.
139 DALI_IMPORT_API unsigned int GetSupportedAuxiliaryHintCount( Window window );
142 * @brief Gets the supported auxiliary hint string of the window.
143 * @param[in] window The window to get the hint
144 * @param[in] index The index of the supported auxiliary hint lists
145 * @return The auxiliary hint string of the index.
147 * @note The window auxiliary hint is the value which is used to decide which actions should be made available to the user by the window manager.
148 * If you want to set specific hint to your window, then you should check whether it exists in the supported auxiliary hints.
150 DALI_IMPORT_API std::string GetSupportedAuxiliaryHint( Window window, unsigned int index );
153 * @brief Creates an auxiliary hint of the window.
154 * @param[in] window The window to create a hint
155 * @param[in] hint The auxiliary hint string.
156 * @param[in] value The value string.
157 * @return The ID of created auxiliary hint, or @c 0 on failure.
159 DALI_IMPORT_API unsigned int AddAuxiliaryHint( Window window, const std::string& hint, const std::string& value );
162 * @brief Removes an auxiliary hint of the window.
163 * @param[in] window The window to remove a hint
164 * @param[in] id The ID of the auxiliary hint.
165 * @return True if no error occurred, false otherwise.
167 DALI_IMPORT_API bool RemoveAuxiliaryHint( Window window, unsigned int id );
170 * @brief Changes a value of the auxiliary hint.
171 * @param[in] window The window to set a value
172 * @param[in] id The auxiliary hint ID.
173 * @param[in] value The value string to be set.
174 * @return True if no error occurred, false otherwise.
176 DALI_IMPORT_API bool SetAuxiliaryHintValue( Window window, unsigned int id, const std::string& value );
179 * @brief Gets a value of the auxiliary hint.
180 * @param[in] window The window to get a value
181 * @param[in] id The auxiliary hint ID.
182 * @return The string value of the auxiliary hint ID, or an empty string if none exists.
184 DALI_IMPORT_API std::string GetAuxiliaryHintValue( Window window, unsigned int id );
187 * @brief Gets a ID of the auxiliary hint string.
188 * @param[in] window The window to get an ID
189 * @param[in] hint The auxiliary hint string.
190 * @return The ID of the auxiliary hint string, or @c 0 if none exists.
192 DALI_IMPORT_API unsigned int GetAuxiliaryHintId( Window window, const std::string& hint );
195 * @brief Sets a region to accept input events.
196 * @param[in] window The window to set a region
197 * @param[in] inputRegion The region to accept input events.
199 DALI_IMPORT_API void SetInputRegion( Window window, const Rect< int >& inputRegion );
202 * @brief Sets a window type.
203 * @param[in] window The window to set a type
204 * @param[in] type The window type.
205 * @remarks The default window type is NORMAL.
207 DALI_IMPORT_API void SetType( Window window, Type type );
210 * @brief Gets a window type.
211 * @param[in] window The window to get a type
212 * @return A window type.
214 DALI_IMPORT_API Type GetType( Window window );
217 * @brief Sets a priority level for the specified notification window.
218 * @param[in] window The window to set a notification level
219 * @param[in] level The notification window level.
220 * @return True if no error occurred, false otherwise.
222 * @PRIVILEGE_WINDOW_PRIORITY
223 * @remarks This can be used for a notification type window only. The default level is NotificationLevel::NONE.
225 DALI_IMPORT_API bool SetNotificationLevel( Window window, NotificationLevel::Type level );
228 * @brief Gets a priority level for the specified notification window.
229 * @param[in] window The window to get a notification level
230 * @return The notification window level.
231 * @remarks This can be used for a notification type window only.
233 DALI_IMPORT_API NotificationLevel::Type GetNotificationLevel( Window window );
236 * @brief Sets a transparent window's visual state to opaque.
237 * @details If a visual state of a transparent window is opaque,
238 * then the window manager could handle it as an opaque window when calculating visibility.
239 * @param[in] window The window to set a state
240 * @param[in] opaque Whether the window's visual state is opaque.
241 * @remarks This will have no effect on an opaque window.
242 * It doesn't change transparent window to opaque window but lets the window manager know the visual state of the window.
244 DALI_IMPORT_API void SetOpaqueState( Window window, bool opaque );
247 * @brief Returns whether a transparent window's visual state is opaque or not.
248 * @param[in] window The window to get a state
249 * @return True if the window's visual state is opaque, false otherwise.
250 * @remarks The return value has no meaning on an opaque window.
252 DALI_IMPORT_API bool IsOpaqueState( Window window );
255 * @brief Sets a window's screen mode.
256 * @details This API is useful when the application needs to keep the display turned on.
257 * If the application sets the screen mode to #ScreenMode::ALWAYS_ON to its window and the window is shown,
258 * the window manager requests the display system to keep the display on as long as the window is shown.
259 * If the window is no longer shown, then the window manager requests the display system to go back to normal operation.
260 * @param[in] window The window to set a screen mode
261 * @param[in] screenMode The screen mode.
262 * @return True if no error occurred, false otherwise.
266 DALI_IMPORT_API bool SetScreenMode( Window window, ScreenMode::Type screenMode );
269 * @brief Gets a screen mode of the window.
270 * @param[in] window The window to get a screen mode
271 * @return The screen mode.
273 DALI_IMPORT_API ScreenMode::Type GetScreenMode( Window window );
276 * @brief Sets preferred brightness of the window.
277 * @details This API is useful when the application needs to change the brightness of the screen when it is appeared on the screen.
278 * If the brightness has been set and the window is shown, the window manager requests the display system to change the brightness to the provided value.
279 * If the window is no longer shown, then the window manager requests the display system to go back to default brightness.
280 * A value less than 0 results in default brightness and a value greater than 100 results in maximum brightness.
281 * @param[in] window The window to set a brightness
282 * @param[in] brightness The preferred brightness (0 to 100).
283 * @return True if no error occurred, false otherwise.
287 DALI_IMPORT_API bool SetBrightness( Window window, int brightness );
290 * @brief Gets preffered brightness of the window.
291 * @param[in] window The window to get brightness
292 * @return The preffered brightness.
294 DALI_IMPORT_API int GetBrightness( Window window );
296 } // namespace DevelWindow
300 #endif // DALI_WINDOW_DEVEL_H