Tizen extension
tizen_surface
The tizen_surface provides tizen-specific functionalities for the given surface.
get_tizen_resource(id: new_id<tizen_resource>, surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| id | new_id<tizen_resource> | the new tizen_resource object |
| surface | object<wl_surface> | the surface object |
Create a tizen_resource interface for the given surface.
destroy()
Destroy this tizen_surface object.
tizen_resource
This tizen_resource provides a global resource id. It is a unique id which is provided by the display server.
destroy()
Destroy this tizen_resource object.
tizen_policy
The tizen_policy provides tizen-specific requests and events for window management at Tizen Platform.
[TODO] Explain the window layer at the display server. Need to explain the window layer to understand the requests and the events at tizen_policy interface.
get_visibility(id: new_id<tizen_visibility>, surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| id | new_id<tizen_visibility> | the new visibility object |
| surface | object<wl_surface> | the surface object |
Create a visibility interface for the given surface.
get_position(id: new_id<tizen_position>, surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| id | new_id<tizen_position> | the new position object |
| surface | object<wl_surface> | the surface object |
Create a position interface for the given surface. [TODO]: need to explain the relationship with zxdg_positioner_v6
activate(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Activate the given surface. A client requests this when a client wants to raise at the top of the windows stack in the window's layer at the display server and also wants to get a keyboard focus from the display server. However the display server does not always set the focus on the reqested surface. It depends on the focus policy of the display server. A client just demands a keyboard focus via this request.
activate_below_by_res_id(res_id: uint, below_res_id: uint)
Argument | Type | Description |
|---|---|---|
| res_id | uint | the global resource id |
| below_res_id | uint | the global resource id |
Activate the surface associated with the given res_id and position it below the surface associated with the below_res_id. A client uses this reuquest when it want to change the order of the window stack with the gloal resource ids which are the surfaces belonging to different processes. However, this requestit does not work when the surface associated with the below_res_id is a parent of the surface assicated with the res_id.
raise(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
This request raises the given surface to the top of the window stack in a window layer. A client can decide the window layer with the window_type for the given surface through the set_type request of tizen_policy interface. The surface positions at the top in the window layer.
lower(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
This request lowers the given surface to the bottom of the window stack in a window layer. The surface positions at the bottom in the window layer.
lower_by_res_id(res_id: uint)
Argument | Type | Description |
|---|---|---|
| res_id | uint | the global resource id |
This request lowers the surface associated with the given res_id to the bottom of the window stack in a window layer. The surface positions at the bottom in the window layer.
set_focus_skip(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
This request makes the given surface unable to be the focused surface. The display server must not give the focus to the surface.
unset_focus_skip(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
This request makes the given surface enable to be the focused surface.
set_role(surface: object<wl_surface>, role: string)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| role | string | the name of the role |
Give the role to the given surface. A client set the tizen-specific role of the surface except for the role of xdg_surface interface, xdg_top_level, xdg_popup and so on.
set_type(surface: object<wl_surface>, win_type: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| win_type | uint | the window type |
Set the type of the given surface. The display server use the window type for the policy of the window management which are focus management, visibility management, stack management and so on.
set_conformant(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Set the conformant surface. The conformant surface can get the event through which the display server notifies the area covered by the compormant_part that is the surface in another client.
unset_conformant(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Unset the conformant surface.
get_conformant(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Ask if the given surface is the conformant surface or not. The display server sents the result via the confirmant event.
set_notification_level(surface: object<wl_surface>, level: int)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| level | int | the z-order value |
This request sets the level in the notification layer. The display server decides the z-order with the given level in the notification layer.
Argument | Type | Description |
|---|---|---|
| child_id | uint | the global resource id for the child surface |
| parent_id | uint | the globacl resource is for the parent surface |
This request sets the transient parent for the surface associated with the parent_id. The surface associated with the given child_id becomes a transient children for the surface associated with the parent_id.
unset_transient_for(child_id: uint)
Argument | Type | Description |
|---|---|---|
| child_id | uint | the global resource id for the child surface |
This reuqest unsets the transient parent on the surface associated with the child_id.
set_window_screen_mode(surface: object<wl_surface>, mode: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| mode | uint | the screen mode |
A client sets the screen mode which it wants the screen to be as long as the given surface is shown on the screen.
place_subsurface_below_parent(subsurface: object<wl_subsurface>)
Argument | Type | Description |
|---|---|---|
| subsurface | object<wl_subsurface> | the subsurface object |
This request places the surface of the subsurface below its' parent surface.
set_subsurface_stand_alone(subsurface: object<wl_subsurface>)
Argument | Type | Description |
|---|---|---|
| subsurface | object<wl_subsurface> | the subsurface object |
This request makes the surface associated with the given subsurface not follow the policy of the window managment triggered by the parent surface. The window policy of the surface associated with the given subsurface is not affected by its parent surface.
get_subsurface(id: new_id<wl_subsurface>, surface: object<wl_surface>, parent_id: uint)
Argument | Type | Description |
|---|---|---|
| id | new_id<wl_subsurface> | the new subsurface object |
| surface | object<wl_surface> | the surface object |
| parent_id | uint | the global reosurce id |
Get the subsurface of the given surface with the global resource parent_id.
set_opaque_state(surface: object<wl_surface>, state: int)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| state | int |
Set the opaque state to the given surface. The display server makes this surface be opaque even if the color depth of the buffer attached to the surface is 32 depth.
iconify(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Set the iconified state to the given surface. The iconfied state is the window state in which the surface is not showing on the screen.
uniconify(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Set the uniconified state to the given surface. The uniconfied state is the window state in which the iconified surface is showing on the screen.
add_aux_hint(surface: object<wl_surface>, id: int, name: string, value: string)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| id | int | the id of the auxiliary hint |
| name | string | the name of the auxiliary hint |
| value | string | the vaule of the auxiliary hint |
Add the information of the auxiliary hint to the given surface. The name and the value are changed when the display server already has the same id with which the client sends this request.
change_aux_hint(surface: object<wl_surface>, id: int, value: string)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| id | int | the id of the auxiliary hint |
| value | string | the vaule of the auxiliary hint |
Change the value of the auxiliary hint id which the surface has.
del_aux_hint(surface: object<wl_surface>, id: int)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| id | int | the id of the auxiliary hint |
Delete the information of the auxiliary hint associated the hint id which the given surface has.
get_supported_aux_hints(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Get the ids of the aux hints which the given surface supports. The display server send the supported_aux_hints events as the reply of this requrest.
set_background_state(pid: uint)
Argument | Type | Description |
|---|---|---|
| pid | uint | the process id |
Set the all surfaces associated with the given pid to be the background state. The surfaces set to be the hide state and cannot show on a screen even if the client send the show request and the activate request.
unset_background_state(pid: uint)
Argument | Type | Description |
|---|---|---|
| pid | uint | the process id |
Set the all surfaces associated with the given pid not to be the background state. The sufaces can allow to be showed and to be activated by the client's request.
set_floating_mode(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Set the floating mode to the given surface. The surface which sets to be floating mode can be a partial window and can position over other top-level windows.
unset_floating_mode(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Unset the floating mode to the given surface. The geometry of the surface does not change and the z-order of it can be the same as the top-level windows.
set_stack_mode(surface: object<wl_surface>, mode: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| mode | uint | the stack mode |
Set the stack mode to the given surface. The surface can changes the z-order in the same layer by the stack mode.
activate_above_by_res_id(res_id: uint, above_res_id: uint)
Argument | Type | Description |
|---|---|---|
| res_id | uint | the global resource id |
| above_res_id | uint | the globacl resource id |
Activate the surface associated with the given res_id which is the global resource id and set to position over the surface assoicated with the above_res_id.
get_subsurface_watcher(id: new_id<tizen_subsurface_watcher>, surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| id | new_id<tizen_subsurface_watcher> | new tizen_subsurface_watcher object |
| surface | object<wl_surface> | the surface object |
Get the subsurface watcher associated with the given surface. A client can get the information about the subsurface associated with the surface.
set_parent(child: object<wl_surface>, parent: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| child | object<wl_surface> | the surface object |
| parent | object<wl_surface> | the surface object |
Set the parent/client relationship. The child surface position over the parent surface.
ack_conformant_region(surface: object<wl_surface>, serial: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| serial | uint | serial number |
A client can refresh its surface for applying new conformant region which is from tizen_policy@conformant_region event. The client has to ack after complete of its updates by this request.
destroy()
Destroy this tizen_policy object.
has_video(surface: object<wl_surface>, has: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| has | uint | 1 is the tizen_video_object, or 0 |
A cleint sends the information that it has the tizen_video_object to the display server.
Set the application id associated with the given pid.
show(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Notify showing the given surface. This request means that a client is going to attach the buffer to the given surface. There is nothing to do at the display server when a client sends this request.
hide(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Notify hiding the given surface. This request means that a client is going to attach the null buffer to the given surface. There is nothing to do at the display server when a client sends this request.
This makes a relationship between parent and child. A child is always placed under a parent.
set_parent_with_below(child: object<wl_surface>, parent: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| child | object<wl_surface> | the surface object |
| parent | object<wl_surface>allow null |
This makes a relationship between parent and child. A child is always placed under a parent. Setting a null parent for a child window removes any parent-child relationship for the child.
set_maximize_direction(surface: object<wl_surface>, direction: uint<tizen_policy.maximize_direction>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| direction | uint<tizen_policy.maximize_direction> | maximize direction |
Set the maximize direction of the surface.
set_pin_mode(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Set the pin mode of the surface.
unset_pin_mode(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Unset the pin mode of the surface.
set_layout(surface: object<wl_surface>, num_cols: uint, num_rows: uint, column: uint, row: uint, cols_span: uint, rows_span: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| num_cols | uint | the total number of columns |
| num_rows | uint | the total number of rows |
| column | uint | the column number to be positioned |
| row | uint | the row number to be positioned |
| cols_span | uint | the columns span |
| rows_span | uint | the rows span |
Set the layout of the surface with the coordinates passed.
set_modal(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Set the modal state of the surface.
unset_modal(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
Unset the modal state of the surface.
conformant(surface: object<wl_surface>, is_conformant: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| is_conformant | uint | if the surface is conformant or not, 0 or 1 |
Notify the client when a client sends the get_conformant request.
conformant_area(surface: object<wl_surface>, conformant_part: uint, state: uint, x: int, y: int, w: int, h: int)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| conformant_part | uint | the name of the conformant part |
| state | uint | visible(1) or not(0) |
| x | int | x position of the hiding area by conformant part |
| y | int | y position of the hiding area by conformant part |
| w | int | width of the hiding area by conformant part |
| h | int | height of the hiding area by conformant part |
Notify a client when the conformant area is caclulated by the another surface as the conformnat_part. This event does NOT guarantee the perfect composition of the conformant surface and the surface of the conformant part.
notification_done(surface: object<wl_surface>, level: int, error_state: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| level | int | the z-order value |
| error_state | uint | the error type |
Notify a client when the surface is located in the z-order which has been reuqested via the set_notification_level request.
transient_for_done(child_id: uint)
Argument | Type | Description |
|---|---|---|
| child_id | uint | the global resource id for the child surface |
Notify a client when the surface associated with the child_id is to set the transient parent or when it is to unset the transient parent.
window_screen_mode_done(surface: object<wl_surface>, mode: uint, error_state: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| mode | uint | the screen mode |
| error_state | uint | the error type |
Notify a client when the screen_mode from the client's request activates in the display server.
iconify_state_changed(surface: object<wl_surface>, iconified: uint, force: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| iconified | uint | the iconfied or uniconified state, 1 or 0 |
| force | uint | the iconfied is forced or not, 1 or 0 |
Notify a client when the iconfied state of the surface is changed. The iconfied state is not only changed when the client requets the iconify and uniconify but also changed when the iconfied state is decided by the display server.
supported_aux_hints(surface: object<wl_surface>, hints: array, num_hints: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| hints | array | the id array of the auxiliary hints |
| num_hints | uint | the number of hints |
Notify a client when the display server get the get_supported_aux_hints request. The display server send the id array of the suxiliary hints which the surface supports.
allowed_aux_hint(surface: object<wl_surface>, id: int)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| id | int | the id of the auxiliary hint |
Notify a client when the auxiliary hint which the given surface has is added and changed.
aux_message(surface: object<wl_surface>, key: string, value: string, options: array)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| key | string | the key string |
| value | string | the vaule of the key |
| options | array | the array of option information |
Notify a client when the display server sends the auxiliary message. The display server can use this event when it notifies an additional information to the client.
conformant_region(surface: object<wl_surface>, conformant_part: uint, state: uint, x: int, y: int, w: int, h: int, serial: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| conformant_part | uint | the name of the conformant part |
| state | uint | visible(1) or not(0) |
| x | int | x position of the hiding area by conformant part |
| y | int | y position of the hiding area by conformant part |
| w | int | width of the hiding area by conformant part |
| h | int | height of the hiding area by conformant part |
| serial | uint | serail number |
The server can notify of conformant region(area) using this event. If client is received this event, client should ack for it using tizen_policy@ack_conformant_region request.
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| x | int | x-position after move |
| y | int | y-position after move |
| w | uint | width after move |
| h | uint | height after move |
| angle | int | current angle of surface |
This event is sent when the display server finishes interactive moving the window. The changed geometry of the window is sent together.
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| x | int | x-position after resize |
| y | int | y-position after resize |
| w | uint | width after resize |
| h | uint | height after resize |
| angle | int | current angle of surface |
This event is sent when the display server finishes interactive resizing the window. The changed geometry of the window is sent together.
win_type { none, toplevel, fullscreen, maximized, transient, menu, dnd, custom, notification, utility, dialog, dock, splash, desktop }
Argument | Value | Description |
|---|---|---|
| none | 0 | none |
| toplevel | 1 | the toplevel |
| fullscreen | 2 | the fullscreen state |
| maximized | 3 | the maximize state |
| transient | 4 | the transient relation state |
| menu | 5 | the menu |
| dnd | 6 | the dnd |
| custom | 7 | the custom |
| notification | 8 | the notification |
| utility | 9 | the utility |
| dialog | 10 | the dialog |
| dock | 11 | the dock |
| splash | 12 | the splash |
| desktopsince 11 | 13 | the desktop |
A client can set the window type through the set_type request with win_type values. The value gives the surface the window_state, the z-order at the window stack in the window layer and other types in the display server.
The following values are window types with z-order values in descending order. Those are notification, dnd, dock, splash, fullscreen, toplevel or maximized and desktop. The menu, dnd, notification, utility, dialog, dock, splash and desktop are the window type which is defined in netwm spefification. https://specifications.freedesktop.org/wm-spec/wm-spec-1.4.html#idm46148902270160
Argument | Value | Description |
|---|---|---|
| indicator | 0 | the indicator surface |
| keyboard | 1 | the keyboard surface |
| clipboard | 2 | the clipboard surface |
This value indicates the surface name at Tizen Platform.
error_state { none, permission_denied }
Argument | Value | Description |
|---|---|---|
| none | 0 | success |
| permission_denied | 1 | the permission denied |
This describes the state of error.
Argument | Value | Description |
|---|---|---|
| 1 | 0 | the bottom default z-order |
| 2 | 1 | the bottom midium z-order |
| 3 | 2 | the bottom high z-order |
| none | -1 | the bottom lowest z-order |
| default | 10 | the default z-order |
| medium | 20 | the medium z-order |
| high | 30 | the high z-order |
| top | 40 | the top z-order |
This is the level of the notification type. This level stands for the z-order in the notification layer at the display server. The none, 1, 2, 3, default, medium, high and top is z-order in ascending order. The lower number value means the lower z-order.
This value means how the screen is to operate.
The set_stack_mode request uses this mode values.
tizen_visibility
A client wants to know the visiblity information of the surface.
destroy()
Destroy this tizen_visiblity object.
notify(visibility: uint)
Argument | Type | Description |
|---|---|---|
| visibility | uint | visiblity type |
Notify a client when the visibility of the surface is changed.
changed(type: uint<tizen_visibility.visibility>, option: uint)
Argument | Type | Description |
|---|---|---|
| type | uint<tizen_visibility.visibility> | changed visibility type |
| option | uint | extra value |
Notify a client when the visibility of the surface is changed with the extra vaule.
visibility { unobscured, partially_obscured, fully_obscured, pre_unobscured }
Argument | Value | Description |
|---|---|---|
| unobscured | 0 | fully showing on a screen |
| partially_obscured | 1 | partially showing on a screen |
| fully_obscured | 2 | not showing on a screen |
| pre_unobscuredsince 5 | 3 | ready to be unobscured |
These are the visibilty types which tells how the surface assoicated with the tizen_visibility resource is showing on a screen or not.
tizen_position
A client can set the position information of the surface.
destroy()
Destroy this tizen_position object.
Set the position.
Notify a client when the posion is changed.
tizen_move_resize
destroy()
geometry_done(surface: object<wl_surface>, serial: uint, x: int, y: int, w: int, h: int, error_state: uint<tizen_move_resize.error_state>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| serial | uint | |
| x | int | |
| y | int | |
| w | int | |
| h | int | |
| error_state | uint<tizen_move_resize.error_state> |
error_state { none, invalid_buffer, not_supported }
Argument | Value | Description |
|---|---|---|
| none | 0 | |
| invalid_buffer | 1 | |
| not_supported | 2 |
tizen_gesture
grab_edge_swipe(fingers: uint, edge: uint<tizen_gesture.edge>, edge_size: uint<tizen_gesture.edge_size>, start_point: uint, end_point: uint)
Argument | Type | Description |
|---|---|---|
| fingers | uint | |
| edge | uint<tizen_gesture.edge> | |
| edge_size | uint<tizen_gesture.edge_size> | |
| start_point | uint | |
| end_point | uint |
ungrab_edge_swipe(fingers: uint, edge: uint<tizen_gesture.edge>, edge_size: uint<tizen_gesture.edge_size>, start_point: uint, end_point: uint)
Argument | Type | Description |
|---|---|---|
| fingers | uint | |
| edge | uint<tizen_gesture.edge> | |
| edge_size | uint<tizen_gesture.edge_size> | |
| start_point | uint | |
| end_point | uint |
grab_edge_drag(fingers: uint, edge: uint<tizen_gesture.edge>, edge_size: uint<tizen_gesture.edge_size>, start_point: uint, end_point: uint)
Argument | Type | Description |
|---|---|---|
| fingers | uint | |
| edge | uint<tizen_gesture.edge> | |
| edge_size | uint<tizen_gesture.edge_size> | |
| start_point | uint | |
| end_point | uint |
ungrab_edge_drag(fingers: uint, edge: uint<tizen_gesture.edge>, edge_size: uint<tizen_gesture.edge_size>, start_point: uint, end_point: uint)
Argument | Type | Description |
|---|---|---|
| fingers | uint | |
| edge | uint<tizen_gesture.edge> | |
| edge_size | uint<tizen_gesture.edge_size> | |
| start_point | uint | |
| end_point | uint |
grab_palm_cover()
ungrab_palm_cover()
select_palm_cover(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
deselect_palm_cover(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
activate_set(surface: object<wl_surface>, type: uint<tizen_gesture.type>, active: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| type | uint<tizen_gesture.type> | |
| active | uint |
destroy()
Destroy the tizen_gesture.
grab_edge_swipe_notify(fingers: uint, edge: uint<tizen_gesture.edge>, edge_size: uint<tizen_gesture.edge_size>, start_point: uint, end_point: uint, error: uint)
Argument | Type | Description |
|---|---|---|
| fingers | uint | |
| edge | uint<tizen_gesture.edge> | |
| edge_size | uint<tizen_gesture.edge_size> | |
| start_point | uint | |
| end_point | uint | |
| error | uint |
edge_swipe(mode: uint<tizen_gesture.mode>, fingers: uint, sx: int, sy: int, edge: uint<tizen_gesture.edge>)
Argument | Type | Description |
|---|---|---|
| mode | uint<tizen_gesture.mode> | |
| fingers | uint | |
| sx | int | x coordinate of touch down point |
| sy | int | y coordinate of touch down point |
| edge | uint<tizen_gesture.edge> |
edge_drag_notify(fingers: uint, edge: uint<tizen_gesture.edge>, edge_size: uint<tizen_gesture.edge_size>, start_point: uint, end_point: uint, error: uint)
Argument | Type | Description |
|---|---|---|
| fingers | uint | |
| edge | uint<tizen_gesture.edge> | |
| edge_size | uint<tizen_gesture.edge_size> | |
| start_point | uint | |
| end_point | uint | |
| error | uint |
edge_drag(mode: uint<tizen_gesture.mode>, fingers: uint, cx: int, cy: int, edge: uint<tizen_gesture.edge>)
Argument | Type | Description |
|---|---|---|
| mode | uint<tizen_gesture.mode> | |
| fingers | uint | |
| cx | int | x coordinate of center touch point |
| cy | int | y coordinate of center touch point |
| edge | uint<tizen_gesture.edge> |
tap(mode: uint<tizen_gesture.mode>, fingers: uint, repeats: uint)
Argument | Type | Description |
|---|---|---|
| mode | uint<tizen_gesture.mode> | |
| fingers | uint | |
| repeats | uint |
palm_cover_notify(surface: object<wl_surface>, error: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| error | uint |
palm_cover(surface: object<wl_surface>, mode: uint<tizen_gesture.mode>, duration: uint, cx: int, cy: int, size: uint, pressure: fixed)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| mode | uint<tizen_gesture.mode> | |
| duration | uint | |
| cx | int | x coordinate of center touch point |
| cy | int | y coordinate of center touch point |
| size | uint | |
| pressure | fixed |
activate_notify(surface: object<wl_surface>, type: uint<tizen_gesture.type>, active: uint, error: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| type | uint<tizen_gesture.type> | |
| active | uint | |
| error | uint |
error { none, invalid_data, no_permission, no_system_resources, grabbed_already, not_supported }
Argument | Value | Description |
|---|---|---|
| none | 0 | |
| invalid_data | 1 | |
| no_permission | 2 | |
| no_system_resources | 3 | |
| grabbed_already | 4 | |
| not_supported | 5 |
type { edge_swipe, edge_drag, tap, palm_cover, pan, pinch, palm_swipe }
Argument | Value | Description |
|---|---|---|
| edge_swipe | 1 | |
| edge_dragsince 2 | 2 | |
| tapsince 2 | 4 | |
| palm_coversince 2 | 8 | |
| pansince 2 | 16 | |
| pinchsince 2 | 32 | |
| palm_swipesince 2 | 64 |
tizen_keyrouter
In tradition, all the keys in a keyboard and a device on which some keys are attached will be sent to focus surface by default. Currently it's possible to set up each focus for each key in a keyboard and a device. Therefore, by setting a key grab for a surface, the owner of the surface will get the key event when it has the key grab for the key.
set_keygrab(surface: object<wl_surface>, key: uint, mode: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| key | uint | |
| mode | uint |
unset_keygrab(surface: object<wl_surface>, key: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| key | uint |
get_keygrab_status(surface: object<wl_surface>, key: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| key | uint |
set_keygrab_list(surface: object<wl_surface>, grab_list: array)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| grab_list | array | array of two integer variables pairs each pairs consist of keycode and keygrab mode |
unset_keygrab_list(surface: object<wl_surface>, ungrab_list: array)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| ungrab_list | array | array of integer variables meaning keycode wanted to ungrab |
get_keygrab_list(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null |
set_register_none_key(surface: object<wl_surface>, data: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| data | uint |
set_input_config(surface: object<wl_surface>, config_mode: uint, value: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| config_mode | uint | |
| value | uint |
destroy()
Destroy the tizen_keyrouter.
keygrab_notify(surface: object<wl_surface>, key: uint, mode: uint, error: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| key | uint | |
| mode | uint | |
| error | uint |
keygrab_notify_list(surface: object<wl_surface>, grab_result: array)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| grab_result | array | array of three integer variables pairs each pairs consist of keycode, keygrab mode and keygrab result |
getgrab_notify_list(surface: object<wl_surface>, grab_result: array)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| grab_result | array | array of two integer variables pairs each pairs consist of keycode, keygrab mode |
set_register_none_key_notify(surface: object<wl_surface>, mode: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface>allow null | |
| mode | uint |
event_surface(surface: object<wl_surface>, key: uint, mode: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| key | uint | |
| mode | uint |
error { none, invalid_surface, invalid_key, invalid_mode, grabbed_already, no_permission, no_system_resources, invalid_array }
Argument | Value | Description |
|---|---|---|
| none | 0 | no error |
| invalid_surface | 1 | Given surface is invalid. |
| invalid_key | 2 | Given key is invalid. |
| invalid_mode | 3 | Given mode is invalid. |
| grabbed_already | 4 | The key has been grabbed already. |
| no_permission | 5 | The wl client has no permission to grab the key. |
| no_system_resources | 6 | System resources are insufficient. |
| invalid_array | 7 | Given array has invalid pairs or data type. |
mode { none, shared, topmost, overridable_exclusive, exclusive, registered }
Argument | Value | Description |
|---|---|---|
| none | 0 | none |
| shared | 1 | mode to get a key grab with the other client surfaces when the focused client surface gets the key |
| topmost | 2 | mode to get a key grab when the client surface is the top most surface |
| overridable_exclusive | 3 | mode to get a key grab exclusively, overridably regardless of the order in the surface stack |
| exclusive | 4 | mode to get a key grab exclusively regardless of the order in surface stack |
| registered | 5 | mode to get a key grab only when a requesting surface is on top among the registering surfaces for the key |
This value is used to set a mode for a key grab. With this mode and the order of the surface between surfaces' stack, the compositor will determine the destination client surface.
config_mode { none, invisible_set, invisible_get, num_key_focus, picture_off }
Argument | Value | Description |
|---|---|---|
| none | 0 | none |
| invisible_set | 1 | mode to set window to enable send event to invisible window below in stack |
| invisible_get | 2 | mode to set window to get event to invisible state if any top window has set register_set |
| num_key_focus | 3 | mode to register for num keys for focus window |
| picture_off | 4 | mode to set picture off for particular key |
This value is used to set a mode for a window. With this mode and the order of the surface between surfaces' stack, the compositor will determine the destination client surface.
tizen_screenshooter
Clients can get a screenmirror object from this interface.
get_screenmirror(id: new_id<tizen_screenmirror>, output: object<wl_output>)
Argument | Type | Description |
|---|---|---|
| id | new_id<tizen_screenmirror> | new screenmirror object |
| output | object<wl_output> | output object for screenmirror |
Before using screenmirror, a client should get a screenmirror object from display server.
set_oneshot_auto_rotation(set: uint)
Argument | Type | Description |
|---|---|---|
| set | uint |
Client can set auto rotation value for one shot.
destroy()
Destroy the tizen_screenshooter.
format(format: uint)
Argument | Type | Description |
|---|---|---|
| format | uint |
The tbm format codes match the #defines in tbm_surface.h. The formats actually supported by the compositor will be reported by the format event.
screenshooter_notify(noti: uint)
Argument | Type | Description |
|---|---|---|
| noti | uint |
Clients can get notification of screenshooter.
done()
tizen_screenmirror
A client can use this interface to get stream images of screen. Before starting, queue all buffers. Then, start a screenmirror. After starting, a dequeued event will occur when drawing a captured image on a buffer is finished. You might need to queue the dequeued buffer again to get a new image from display server.
destroy()
A user can dequeue a buffer from display server when he wants to take back it from server.
start()
stop()
set_auto_rotation(set: uint)
Argument | Type | Description |
|---|---|---|
| set | uint |
Client can set auto rotation value for screenmirror.
occurs when drawing a captured image on a buffer is finished
tizen_video
Clients can get the video information that the compositor can handle from this interface.
get_object(id: new_id<tizen_video_object>, surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| id | new_id<tizen_video_object> | |
| surface | object<wl_surface> | the surface object |
get_viewport(id: new_id<tizen_viewport>, surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| id | new_id<tizen_viewport> | |
| surface | object<wl_surface> | the surface object |
format(format: uint)
Argument | Type | Description |
|---|---|---|
| format | uint |
The tbm format codes match the #defines in tbm_surface.h. The formats actually supported by the compositor will be reported by the format event.
error { none, object_exists, viewport_exists }
Argument | Value | Description |
|---|---|---|
| none | 0 | |
| object_exists | 1 | |
| viewport_exists | 2 |
tizen_video_object
destroy()
follow_topmost_visibility()
If tizen_video_object.follow_topmost_visibility is applied to a video_object, It will be video mute control based on topmost visibility.
unfollow_topmost_visibility()
If tizen_video_object.unfollow_topmost_visibility is applied to a video_object, It will not be video mute control based on topmost visibility.
allowed_attribute()
If tizen_video_object.allowed_attribute is applied to a video_object, set_attribute request will be deliever to tdm backend directly.
disallowed_attribute()
If tizen_video_object.disallowed_attribute is applied to a video_object, It would be tdm_attribute call when topmost showing.
size(min_w: int, min_h: int, max_w: int, max_h: int, prefer_align: int)
Argument | Type | Description |
|---|---|---|
| min_w | int | |
| min_h | int | |
| max_w | int | |
| max_h | int | |
| prefer_align | int |
tizen_subsurface_watcher
destroy()
Destroy the tizen_subsurface_watcher.
msg { success, parent_id_invalid, parent_id_destroyed }
Argument | Value | Description |
|---|---|---|
| success | 0 | |
| parent_id_invalid | 1 | |
| parent_id_destroyed | 2 |
tizen_viewport
This is the alternative and convenient solution of wl_viewport to present a surface on screen.
The below five functions can be replaced with this interface. The below functions will be ignored after applying this interface to a surface.
- wl_surface.set_buffer_transform
- wl_surface.set_buffer_scale
- wl_subsurface.set_position
- wl_viewport.set_source
- wl_viewport.set_destination
wl_viewport.set_source is very complicated especially when the buffer of wl_surface is transformed by wl_surface.set_buffer_transform. And when the parent is resized, if we want to change the geometry of a subsurface also, wl_subsurface.set_position and wl_viewport.set_destination should be called everytime the parent is resized in client side. This makes difficult to synchronize a parent surface and a subsurface on screen.
tizen_viewport allows clients to set the relative geometry to a subsurface in a parent surface. Whenever a parent surface is resized, the geometry of a subsurface will be calculated, moved and resized automatically by a compositor. The tizen_viewport is specified in the coordinates of a subsurface's parent.
If tizen_viewport is applied to a shell surface(toplevel), the all value related with x, y pos of tizen_viewport and tizen_destination_mode interface will be ignored.
The below 3 functions don't consider the transform of a parent's surface.
- tizen_viewport.set_source
- tizen_viewport.set_destination
- tizen_viewport.set_destination_ratio
Furthermore, tizen_destination_mode.follow_parent_transform is called, tizen_viewport will consider the transform of a parent surface when applying the destination mode to a subsurface. If tizen_destination_mode.follow_parent_transform is applied to a shell surface, it will be ignored.
The destination will be cropped by a parent surface.
The change will be applied when wl_surface.commit is called.
destroy()
set_transform(transform: uint)
Argument | Type | Description |
|---|---|---|
| transform | uint |
The accepted values for the transform parameter are the values for wl_output.transform according to the output transform.
The tizen_viewport.set_transform is applied only to itself. Basically it doesn't effect the transform of its subsurfaces. That is, if 90 transform is setted and its subsurface still has 0 transform, its subsurface won't be rotated.
If needed to rotate the subsurface depended on a parent surface, tizen_destination_mode.follow_parent_transform will make it possible.
The source rectangle won't be changed when a parent is resized. If it needs to be changed, tizen_viewport.set_source should be called with new values.
The destination geometry won't be changed when a parent is resized. If it needs to be changed, tizen_viewport.set_destination should be called with new values.
If tizen_viewport is applied to a shell surface(toplevel), the x, y value of tizen_viewport.set_destination will be ignored.
The destination rectangle of a subsurface will be automatically changed when a parent is resized. This allows the real number between 0.0 and 1.0. See wl_fixed_from_double and wl_fixed_to_double.
If tizen_viewport is applied to a shell surface(toplevel), the x, y value of tizen_viewport.set_destination_ratio will be ignored.
get_destination_mode(id: new_id<tizen_destination_mode>)
Argument | Type | Description |
|---|---|---|
| id | new_id<tizen_destination_mode> |
query_parent_size()
A client can asks the display server to send the size of tizen_viewport object's parent surface. Once a client requests it, the "parent_size" event will be sent whenever the parent surface's size is changed.
follow_parent_transform()
The real transform of a subsurface is (parent's transform + subsurface's transform). The subsurface will be rotated automatically when the parent is rotated.
If tizen_viewport.follow_parent_transform is applied to a shell surface(toplevel), it will be ignored.
unfollow_parent_transform()
tizen_destination_mode
The destination rectangle will be automatically changed when a parent is resized. When tizen_destination_mode.set is called, the value of tizen_viewport.set_destination and tizen_viewport.set_destination_ratio will be ignored.
The destination of a surface is decided by the mode, ratio, scale, offset and align values. The ratio, scale, offset and align will be applied sequentially.
The change will be applied when wl_surface.commit is called.
destroy()
follow_parent_transform()
The real transform of a subsurface is (parent's transform + subsurface's transform). That is, the subsurface will be rotated automatically when the parent is rotated.
If tizen_destination_mode.follow_parent_transform is applied to a shell surface(toplevel), it will be ignored.
unfollow_parent_transform()
set(mode: uint<tizen_destination_mode.type>)
Argument | Type | Description |
|---|---|---|
| mode | uint<tizen_destination_mode.type> |
set_ratio(horizontal: fixed, vertical: fixed)
Argument | Type | Description |
|---|---|---|
| horizontal | fixed | |
| vertical | fixed |
This allows the real number. See wl_fixed_from_double and wl_fixed_to_double.
set_scale(horizontal: fixed, vertical: fixed)
Argument | Type | Description |
|---|---|---|
| horizontal | fixed | |
| vertical | fixed |
This allows the real number. See wl_fixed_from_double and wl_fixed_to_double.
set_align(horizontal: fixed, vertical: fixed)
Argument | Type | Description |
|---|---|---|
| horizontal | fixed | |
| vertical | fixed |
This allows the real number between 0.0 and 1.0. See wl_fixed_from_double and wl_fixed_to_double.
type { none, letter_box, origin, full, cropped_full, origin_or_letter }
Argument | Value | Description |
|---|---|---|
| none | 0 | |
| letter_box | 1 | |
| origin | 2 | |
| full | 3 | |
| cropped_full | 4 | |
| origin_or_letter | 5 |
tizen_embedded_compositor
The global obejct. Wayland has 3 type of compositor, embedded compositor is one of them. But tizen application is sendboxing by smack, then a application not allow commutication to other application by socket. So system or session compositor create socket and send to embedded compostior.
get_socket()
The get_socket request ask the server to create socket and emit socket event.
destroy()
tizen_input_device_manager
Tizen input device manager is a global interface. This object has device add/remove events to provide tizen input device object to a client. This allows for a client to get the con
Be sure to bind this interface after binding wl_seat interface. Tizen input device manager interface will only provide device add/remove event for devices which belongs to the wl_seat object(s) bound by the client. Therefore, the compositor needs to create/send the device add/remove event only for the current client's seat(s).
block_events(serial: uint, clas: uint<tizen_input_device_manager.clas>, duration: uint)
Argument | Type | Description |
|---|---|---|
| serial | uint | |
| clas | uint<tizen_input_device_manager.clas> | |
| duration | uint | time duration with millisecond granularity |
This request allows a client to request to block one or more events for its purpose. By specifying class as an argument in the request, the events belongs to the class will be blocked during the given duration. Note that an error event will be sent if there is any error.
unblock_events(serial: uint)
Argument | Type | Description |
|---|---|---|
| serial | uint |
This request allows a client to request to release the existing block for the client. Note that no error event will be sent if there is no existing block for the client.
init_generator(clas: uint<tizen_input_device_manager.clas>)
Argument | Type | Description |
|---|---|---|
| clas | uint<tizen_input_device_manager.clas> |
deinit_generator(clas: uint<tizen_input_device_manager.clas>)
Argument | Type | Description |
|---|---|---|
| clas | uint<tizen_input_device_manager.clas> |
generate_pointer(type: uint<tizen_input_device_manager.pointer_event_type>, x: uint, y: uint, button: uint)
Argument | Type | Description |
|---|---|---|
| type | uint<tizen_input_device_manager.pointer_event_type> | |
| x | uint | |
| y | uint | |
| button | uint |
generate_touch(type: uint<tizen_input_device_manager.pointer_event_type>, x: uint, y: uint, finger: uint)
Argument | Type | Description |
|---|---|---|
| type | uint<tizen_input_device_manager.pointer_event_type> | |
| x | uint | |
| y | uint | |
| finger | uint |
pointer_warp(surface: object<wl_surface>, x: fixed, y: fixed)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| x | fixed | |
| y | fixed |
init_generator_with_name(clas: uint<tizen_input_device_manager.clas>, name: string)
Argument | Type | Description |
|---|---|---|
| clas | uint<tizen_input_device_manager.clas> | |
| name | string |
destroy()
Destroy the tizen_input_device_manager.
generate_axis(type: uint<tizen_input_device_manager.axis_type>, value: fixed)
Argument | Type | Description |
|---|---|---|
| type | uint<tizen_input_device_manager.axis_type> | |
| value | fixed | axis value |
When the server got this request, the server choices generate a event directly or just save values. Pointer axes (such as wheel/hwheel) are delivered to clients independantly about pointer events, but touch axes are delivered to normal touch events(begin/update/end). So the server just save touch axes before generate touch request is came and send a touch event include saved touch axes value.
set_touch_count(max_count: int)
Argument | Type | Description |
|---|---|---|
| max_count | int |
This request only changes system's touch count. So this request doesn't change already connected touch devices's max count. This will influence to user created device using input generator. Input generator creates touch device only supports default touch count. But if user set touch count before create a Input generator device, user can create touch device has touch count user wanted. But some systems has their own maximum touch count. In that case this request returns error not_allowed.
init_generator_with_sync(clas: uint<tizen_input_device_manager.clas>, name: string)
Argument | Type | Description |
|---|---|---|
| clas | uint<tizen_input_device_manager.clas> | |
| name | string |
keyboard_grab(surface: object<wl_surface>, subclas: uint<tizen_input_device_manager.subclas>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| subclas | uint<tizen_input_device_manager.subclas> |
keyboard_ungrab(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
grab_relative_motion(surface: object<wl_surface>, boundary: uint<tizen_input_device_manager.boundary>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| boundary | uint<tizen_input_device_manager.boundary> |
ungrab_relative_motion(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
device_add(serial: uint, identifier: string, device: new_id<tizen_input_device>, seat: object<wl_seat>)
Argument | Type | Description |
|---|---|---|
| serial | uint | |
| identifier | string | |
| device | new_id<tizen_input_device> | |
| seat | object<wl_seat> |
The device add/remove notification is going to be sent when a physical/logical device is added/removed to/from the given seat. Note that a tizen input device object can be assigned to a wl_seat and can also be assigned to the other wl_seat at any time. Whenever a relationship between a tizen input device object changes, device remove event from the current wl_seat object will be made and device add event to the other wl_seat object will also be mode.
device_remove(serial: uint, identifier: string, device: object<tizen_input_device>, seat: object<wl_seat>)
Argument | Type | Description |
|---|---|---|
| serial | uint | |
| identifier | string | |
| device | object<tizen_input_device> | |
| seat | object<wl_seat> |
The device add/remove notification is going to be sent when a physical/logical device is added/removed to/from the given seat. Note that a tizen input device object can be assigned to a wl_seat and can also be assigned to the other wl_seat at any time. Whenever a relationship between a tizen input device object changes, device remove event from the current wl_seat object will be made and device add event to the other wl_seat object will also be mode.
error(errorcode: uint<tizen_input_device_manager.error>)
Argument | Type | Description |
|---|---|---|
| errorcode | uint<tizen_input_device_manager.error> |
block_expired()
This event will be sent if the duration of existing block is expired. Note that no block expired event will be sent if there is no block for the client.
Each touch devices has their own touch counts can be supported. So a server controls maximum touches in this system to maintain resources efficiently. Sometimes a server controls maximum touches using a predefined configuration option. Sometimes a server ensures maximum touches to be supported by touch device. If a server do not use configuration option, maximum touches can be updated when new touch devices are connected. So this events can be sent to client, when a first touch device is added or maximum touches is changed.
event_boundary(serial: uint, boundary: uint<tizen_input_device_manager.boundary>)
Argument | Type | Description |
|---|---|---|
| serial | uint | |
| boundary | uint<tizen_input_device_manager.boundary> |
clas { none, mouse, keyboard, touchscreen }
Argument | Value | Description |
|---|---|---|
| none | 0 | none of class |
| mouse | 1 | mouse class |
| keyboard | 2 | keyboard class |
| touchscreen | 4 | touchscreen class |
error { none, no_permission, invalid_class, blocked_already, no_system_resources, invalid_parameter, invalid_surface, no_pointer_available, not_allowed }
Argument | Value | Description |
|---|---|---|
| none | 0 | no error |
| no_permission | 1 | no permission |
| invalid_class | 2 | invalid class |
| blocked_already | 3 | blocked already by the other client |
| no_system_resources | 4 | no system resources such as memory lack |
| invalid_parameter | 5 | argument is invalid |
| invalid_surface | 6 | the given surface is not visible or pointer is not on the given surface |
| no_pointer_available | 7 | there is no pointer available to warp |
| not_allowed | 8 | this request is not allowed in this system |
Argument | Value | Description |
|---|---|---|
| none | 0 | no axis type |
| wheel | 1 | pointer vertical wheel axis |
| hwheel | 2 | pointer horizental wheel axis |
| radius_x | 3 | touch radius of x axis of an event area e.g. touching area with a finger or a pen |
| radius_y | 4 | touch radius of y axis of an event area e.g. touching area with a finger or a pen |
| pressure | 5 | touch pressure in an event area e.g. touching area with a finger or a pen |
| angle | 6 | touch angle in an event area e.g. touching area with a finger or a pen |
| palm | 7 | touch palm in an event area e.g. touching area with a finger or a pen |
subclas { none, remocon, virtual_keyboard }
Argument | Value | Description |
|---|---|---|
| none | 1 | none of subclass |
| remocon | 2 | remocon subclass |
| virtual_keyboard | 4 | virtual_keyboard subclass |
tizen_input_device
The tizen_input_device interface represents one or more input devices associated with a physical/logical input device. This interface provides device specific information/events to allows for client to identify the source device of an event or to get the additional axes/attributes of a device. Note that a tizen_input_device object can be used for a physical input device and can also be used for a group of input devices. e.g. a group of mouse devices
select_axes(axes: array)
Argument | Type | Description |
|---|---|---|
| axes | array | array of axis num |
device_info(name: string, clas: uint<tizen_input_device.clas>, subclas: uint<tizen_input_device.subclas>, axes: array)
Argument | Type | Description |
|---|---|---|
| name | string | |
| clas | uint<tizen_input_device.clas> | |
| subclas | uint<tizen_input_device.subclas> | |
| axes | array | array of axis enum |
axis(axis_type: uint<tizen_input_device.axis_type>, value: fixed)
Argument | Type | Description |
|---|---|---|
| axis_type | uint<tizen_input_device.axis_type> | |
| value | fixed | axis value |
clas { none, keyboard, mouse, touchscreen }
Argument | Value | Description |
|---|---|---|
| none | 0 | none of class |
| keyboard | 2 | keyboard class |
| mouse | 3 | mouse class |
| touchscreen | 4 | touchscreen class |
Argument | Value | Description |
|---|---|---|
| none | 0 | radius of x axis of an event area e.g. touching area with a finger or a pen |
| radius_x | 1 | radius of x axis of an event area e.g. touching area with a finger or a pen |
| radius_y | 2 | radius of y axis of an event area e.g. touching area with a finger or a pen |
| pressure | 3 | pressure in an event area e.g. touching area with a finger or a pen |
| angle | 4 | angle in an event area e.g. touching area with a finger or a pen |
| detent | 5 | detent value e.g. moved distance with a rotary device |
tizen_launchscreen
create_img(id: new_id<tizen_launch_image>)
Argument | Type | Description |
|---|---|---|
| id | new_id<tizen_launch_image> | new tizen_launch_image object |
destroy()
Destroy the tizen_launchscreen.
tizen_launch_image
destroy()
show()
hide()
tizen_effect
destroy()
start(surface: object<wl_surface>, type: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| type | uint |
end(surface: object<wl_surface>, type: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| type | uint |
tizen_display_policy
set_window_brightness(surface: object<wl_surface>, brightness: int)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| brightness | int |
destroy()
Destroy the tizen_display_policy.
window_brightness_done(surface: object<wl_surface>, brightness: int, error_state: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| brightness | int | |
| error_state | uint |
error_state { none, permission_denied }
Argument | Value | Description |
|---|---|---|
| none | 0 | |
| permission_denied | 1 |
tizen_indicator
destroy()
set_state(surface: object<wl_surface>, state: int)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| state | int |
set_opacity_mode(surface: object<wl_surface>, mode: int)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| mode | int |
set_visible_type(surface: object<wl_surface>, type: int)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| type | int |
flick(surface: object<wl_surface>, type: int)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | occur the flick event |
| type | int |
opacity_mode { unknown, opaque, translucent, transparent, bg_transparent }
Argument | Value | Description |
|---|---|---|
| unknown | 0 | unknown |
| opaque | 1 | opaque mode |
| translucent | 2 | translucent mode |
| transparent | 3 | transparent all mode |
| bg_transparent | 4 | transparent only background mode |
Argument | Value | Description |
|---|---|---|
| shown | 1 | shown type indicator |
tizen_clipboard
This interface provides some requests and events about clipboard for other clients.
destroy()
show(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
hide(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
set_data_only(set: uint)
Argument | Type | Description |
|---|---|---|
| set | uint |
A wayland client can notify of that the client is data only mode. The data only mode means that this wayland client doesn't have any wl_surfaces at all but it wants to use wl_data_device for some data operations.
data_selected(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
tizen_screen_rotation
get_ignore_output_transform(surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
destroy()
Destroy the tizen_screen_rotation.
ignore_output_transform(surface: object<wl_surface>, ignore: uint)
Argument | Type | Description |
|---|---|---|
| surface | object<wl_surface> | the surface object |
| ignore | uint |
tizen_renderer
get_renderer_surface(id: new_id<tizen_renderer_surface>, surface: object<wl_surface>)
Argument | Type | Description |
|---|---|---|
| id | new_id<tizen_renderer_surface> | |
| surface | object<wl_surface> | the surface object |
destroy()
Destroy the tizen_renderer
tizen_renderer_surface
destroy()
Destroy the tizen_renderer_surface
redraw_request()