Tizen Native API
Functions | Enumerations
Dali::KeyGrab Namespace Reference
Adaptor Framework

Key grab functions. More...

Functions

bool GrabKeyTopmost (Window window, Dali::KEY daliKey)
 Grabs the key specfied by key for window only when window is the topmost window.
bool UngrabKeyTopmost (Window window, Dali::KEY daliKey)
 Ungrabs the key specfied by key for window.
bool GrabKey (Window window, Dali::KEY daliKey, KeyGrabMode grabMode)
 Grabs the key specfied by key for window in grabMode.
bool UngrabKey (Window window, Dali::KEY daliKey)
 Ungrabs the key specfied by key for window.

Enumerations

enum  KeyGrabMode
 Key grab mode for platform-level APIs. More...

Detailed Description

Key grab functions.

Since :
2.4

Enumeration Type Documentation

enum Dali::KeyGrab::KeyGrabMode

Key grab mode for platform-level APIs.

Since :
2.4
Enumerator:
TOPMOST 

Grab a key only when on the top of the grabbing-window stack mode.

Since :
2.4
SHARED 

Grab a key together with the other client window(s) mode.

Since :
2.4
OVERRIDE_EXCLUSIVE 

Grab a key exclusively regardless of the grabbing-window's position on the window stack with the possibility of overriding the grab by the other client window mode.

Since :
2.4
EXCLUSIVE 

Grab a key exclusively regardless of the grabbing-window's position on the window stack mode.

Since :
2.4

Function Documentation

bool Dali::KeyGrab::GrabKey ( Window  window,
Dali::KEY  daliKey,
KeyGrabMode  grabMode 
)

Grabs the key specfied by key for window in grabMode.

Warning:
This is not for use by third-party applications.

This function can be used for following example scenarios:

  • TV - A user might want to change the volume or channel of the background TV contents while focusing on the foregrund app.
  • Mobile - When a user presses Home key, the homescreen appears regardless of current foreground app.
  • Mobile - Using volume up/down as zoom up/down in camera apps.
Since :
2.4
Privilege Level:
platform
Privilege:
http://tizen.org/privilege/keygrab
Parameters:
[in]windowThe window to set
[in]dailKeyThe key code to grab (defined in key.h)
[in]grabModeThe grab mode for the key
Returns:
true if the grab succeeds.
bool Dali::KeyGrab::GrabKeyTopmost ( Window  window,
Dali::KEY  daliKey 
)

Grabs the key specfied by key for window only when window is the topmost window.

This function can be used for following example scenarios:

  • Mobile - Using volume up/down as zoom up/down in camera apps.
Since :
2.4
Parameters:
[in]windowThe window to set
[in]dailKeyThe key code to grab (defined in key.h)
Returns:
true if the grab succeeds.
bool Dali::KeyGrab::UngrabKey ( Window  window,
Dali::KEY  daliKey 
)

Ungrabs the key specfied by key for window.

Warning:
This is not for use by third-party applications.
Since :
2.4
Privilege Level:
platform
Privilege:
http://tizen.org/privilege/keygrab
Parameters:
[in]windowThe window to set
[in]dailKeyThe key code to ungrab (defined in key.h)
Returns:
true if the ungrab succeeds.
Note:
If this function is called between key down and up events of a grabbed key, an application doesn't receive the key up event.
bool Dali::KeyGrab::UngrabKeyTopmost ( Window  window,
Dali::KEY  daliKey 
)

Ungrabs the key specfied by key for window.

Since :
2.4
Parameters:
[in]windowThe window to set
[in]dailKeyThe key code to ungrab (defined in key.h)
Returns:
true if the ungrab succeeds.
Note:
If this function is called between key down and up events of a grabbed key, an application doesn't receive the key up event.