Handle properties of windows.
Required Header
#include <efl_util.h>
Overview
The EFL UTIL WINDOW PROPERTY API provides functions to set/get properties of windows such as the notification level, the screen mode and the brightness.
Enumeration Type Documentation
Enumeration for EFL UTIL ERROR.
- Since :
- 2.3
- Enumerator:
EFL_UTIL_ERROR_NONE |
Successful
|
EFL_UTIL_ERROR_INVALID_PARAMETER |
Invalid parameter
|
EFL_UTIL_ERROR_OUT_OF_MEMORY |
Out of memory
|
EFL_UTIL_ERROR_PERMISSION_DENIED |
Permission denied
|
EFL_UTIL_ERROR_NO_SUCH_DEVICE |
- Warning:
- This is not for use by third-party applications. No such device or address (Since: 2.4)
|
EFL_UTIL_ERROR_INVALID_OPERATION |
- Warning:
- This is not for use by third-party applications. Function not implemented (Since: 2.4)
|
EFL_UTIL_ERROR_NOT_SUPPORTED |
- Warning:
- This is not for use by third-party applications. Not supported (Since: 2.4)
|
EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE |
Window type not supported
|
EFL_UTIL_ERROR_SCREENSHOT_INIT_FAIL |
- Warning:
- This is not for use by third-party applications. Screenshot initialization fail (Since: 2.4)
|
EFL_UTIL_ERROR_SCREENSHOT_EXECUTION_FAIL |
- Warning:
- This is not for use by third-party applications. Screenshot execution fail (Since: 2.4)
|
EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE |
Resource is not available (Since: 4.0)
|
Enumeration of notification window's priority level.
- Since :
- 2.3
- Enumerator:
EFL_UTIL_NOTIFICATION_LEVEL_NONE |
No (reset) notification level. This value makes the window place in normal layer. (Since: 2.4)
|
EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT |
Default notification level. (Since: 2.4)
|
EFL_UTIL_NOTIFICATION_LEVEL_MEDIUM |
Higher notification level than default. (Since: 2.4)
|
EFL_UTIL_NOTIFICATION_LEVEL_HIGH |
Higher notification level than medium. (Since: 2.4)
|
EFL_UTIL_NOTIFICATION_LEVEL_TOP |
The highest notification level. (Since: 2.4)
|
Enumeration of screen mode.
- Since :
- 2.4
- Enumerator:
EFL_UTIL_SCREEN_MODE_DEFAULT |
The mode which turns the screen off after a timeout.
|
EFL_UTIL_SCREEN_MODE_ALWAYS_ON |
The mode which keeps the screen turned on.
|
Function Documentation
Gets the priority level for the specified notification window.
- Since :
- 2.3
- Parameters:
-
[in] | window | The EFL window |
[out] | level | The notification window level |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Gets the user's preferred brightness of the specified window.
- Since :
- 3.0
- Parameters:
-
[in] | window | The EFL window |
[out] | brightness | The preferred brightness |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- efl_util_set_window_brightness()
Gets the screen mode of the specified window.
- Since :
- 2.4
- Parameters:
-
[in] | window | The EFL window |
[out] | mode | The screen mode |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Sets the priority level for the specified notification window.
- Since :
- 2.3
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/window.priority.set
- Parameters:
-
[in] | window | The EFL window |
[in] | level | The notification window level |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Sets the user's preferred brightness of the specified window.
This API is useful when the application need to change the brightness of the screen when it is appeared on the screen. If the application sets the brightness 0 to 100 to its window and the application window is shown wholly or partially, the window manager requests the display system to change the brightness of the screen using user's preferred brightness. If the window is no longer shown, then the window manger request the display system to go back to default brightness. If the brightness is less than 0, this means to use the default screen brightness.
- Since :
- 3.0
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/display
- Parameters:
-
[in] | window | The EFL window |
[in] | brightness | The preferred brightness |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
- See also:
- efl_util_get_window_brightness()
Sets the alpha window's visual state to opaque state.
This API sets the alpha window's visual state to opaque state. If the alpha window sets the visual state to the opaque, then the window manager could handle it as the opaque window while calculating visibility. This API will have no effect when used by a non-alpha window.
- Since :
- 2.4
- Parameters:
-
[in] | window | The EFL window |
[in] | opaque | The value that indicates whether the window has set a visual state to opaque (0: unset, 1: set) |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-
Sets the window's screen mode.
This API is useful when the application need to keep the display turned on. If the application set the mode to EFL_UTIL_SCREEN_MODE_ALWAYS_ON to its window and the window is shown wholly or partially, the window manager requests the display system to keep the display on as long as the window is shown. If the window is no longer shown, then the window manger request the display system to go back to normal operation. Default screen mode of window is EFL_UTIL_SCREEN_MODE_DEFAULT.
- Since :
- 2.4
- Privilege Level:
- public
- Privilege:
- http://tizen.org/privilege/display
- Parameters:
-
[in] | window | The EFL window |
[in] | mode | The screen mode |
- Returns:
0
on success, otherwise a negative error value
- Return values:
-