Ubuntu Platform API  1.0.0
A library helping with tight integration into the Ubuntu platform
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ubuntu_ui_session_service.h File Reference
#include <ubuntu/visibility.h>
#include <stdint.h>
+ Include dependency graph for ubuntu_ui_session_service.h:

Go to the source code of this file.

Data Structures

struct  ubuntu_ui_session_lifecycle_observer
 
struct  ubuntu_ui_task_controller
 

Typedefs

typedef const void * ubuntu_ui_session_properties
 
typedef const void * ubuntu_ui_session_preview_provider
 
typedef void(* ubuntu_ui_session_service_snapshot_cb )(const void *pixels, unsigned int width, unsigned int height, unsigned int x, unsigned int y, unsigned int source_width, unsigned int source_height, unsigned int stride, void *context)
 
typedef void(* session_requested_cb )(ubuntu_ui_well_known_application app, void *context)
 
typedef void(* session_born_cb )(ubuntu_ui_session_properties props, void *context)
 
typedef void(* session_unfocused_cb )(ubuntu_ui_session_properties props, void *context)
 
typedef void(* session_focused_cb )(ubuntu_ui_session_properties props, void *context)
 
typedef void(* keyboard_geometry_changed_cb )(int x, int y, int width, int height, void *context)
 
typedef void(* session_requested_fullscreen_cb )(ubuntu_ui_session_properties props, void *context)
 
typedef void(* session_died_cb )(ubuntu_ui_session_properties props, void *context)
 
typedef void(* continue_task_cb )(int pid, void *context)
 
typedef void(* suspend_task_cb )(int pid, void *context)
 

Enumerations

enum  ubuntu_ui_well_known_application {
  UNKNOWN_APP = -1,
  CAMERA_APP = 0,
  GALLERY_APP = 1,
  BROWSER_APP = 2,
  SHARE_APP = 3,
  PHONE_APP = 4,
  DIALER_APP = 5,
  MESSAGING_APP = 6,
  ADDRESSBOOK_APP = 7
}
 

Functions

UBUNTU_DLL_PUBLIC void ubuntu_ui_install_task_controller (ubuntu_ui_task_controller *controller)
 
UBUNTU_DLL_PUBLIC const char * ubuntu_ui_session_properties_get_value_for_key (ubuntu_ui_session_properties props, const char *key)
 
UBUNTU_DLL_PUBLIC int ubuntu_ui_session_properties_get_application_stage_hint (ubuntu_ui_session_properties props)
 
UBUNTU_DLL_PUBLIC int ubuntu_ui_session_properties_get_application_instance_id (ubuntu_ui_session_properties props)
 
UBUNTU_DLL_PUBLIC const char * ubuntu_ui_session_properties_get_desktop_file_hint (ubuntu_ui_session_properties props)
 
UBUNTU_DLL_PUBLIC void ubuntu_ui_session_install_session_lifecycle_observer (ubuntu_ui_session_lifecycle_observer *observer)
 
UBUNTU_DLL_PUBLIC void ubuntu_ui_session_unfocus_running_sessions ()
 
UBUNTU_DLL_PUBLIC void ubuntu_ui_session_focus_running_session_with_id (int id)
 
UBUNTU_DLL_PUBLIC void ubuntu_ui_session_snapshot_running_session_with_id (int id, ubuntu_ui_session_service_snapshot_cb cb, void *context)
 
UBUNTU_DLL_PUBLIC void ubuntu_ui_session_trigger_switch_to_well_known_application (ubuntu_ui_well_known_application app)
 
UBUNTU_DLL_PUBLIC int32_t ubuntu_ui_set_surface_trap (int x, int y, int width, int height)
 
UBUNTU_DLL_PUBLIC void ubuntu_ui_unset_surface_trap (int32_t handle)
 
UBUNTU_DLL_PUBLIC void ubuntu_ui_report_osk_visible (int x, int y, int width, int height)
 
UBUNTU_DLL_PUBLIC void ubuntu_ui_report_osk_invisible ()
 
UBUNTU_DLL_PUBLIC void ubuntu_ui_report_notification_visible ()
 
UBUNTU_DLL_PUBLIC void ubuntu_ui_report_notification_invisible ()
 

Typedef Documentation

typedef void(* continue_task_cb)(int pid, void *context)

Definition at line 69 of file ubuntu_ui_session_service.h.

typedef void(* keyboard_geometry_changed_cb)(int x, int y, int width, int height, void *context)

Definition at line 52 of file ubuntu_ui_session_service.h.

typedef void(* session_born_cb)(ubuntu_ui_session_properties props, void *context)

Definition at line 49 of file ubuntu_ui_session_service.h.

typedef void(* session_died_cb)(ubuntu_ui_session_properties props, void *context)

Definition at line 54 of file ubuntu_ui_session_service.h.

typedef void(* session_focused_cb)(ubuntu_ui_session_properties props, void *context)

Definition at line 51 of file ubuntu_ui_session_service.h.

typedef void(* session_requested_cb)(ubuntu_ui_well_known_application app, void *context)

Definition at line 48 of file ubuntu_ui_session_service.h.

typedef void(* session_requested_fullscreen_cb)(ubuntu_ui_session_properties props, void *context)

Definition at line 53 of file ubuntu_ui_session_service.h.

typedef void(* session_unfocused_cb)(ubuntu_ui_session_properties props, void *context)

Definition at line 50 of file ubuntu_ui_session_service.h.

typedef void(* suspend_task_cb)(int pid, void *context)

Definition at line 70 of file ubuntu_ui_session_service.h.

Definition at line 44 of file ubuntu_ui_session_service.h.

typedef const void* ubuntu_ui_session_properties

Definition at line 43 of file ubuntu_ui_session_service.h.

typedef void(* ubuntu_ui_session_service_snapshot_cb)(const void *pixels, unsigned int width, unsigned int height, unsigned int x, unsigned int y, unsigned int source_width, unsigned int source_height, unsigned int stride, void *context)

Definition at line 46 of file ubuntu_ui_session_service.h.

Enumeration Type Documentation

Enumerator
UNKNOWN_APP 
CAMERA_APP 
GALLERY_APP 
BROWSER_APP 
SHARE_APP 
PHONE_APP 
DIALER_APP 
MESSAGING_APP 
ADDRESSBOOK_APP 

Definition at line 30 of file ubuntu_ui_session_service.h.

Function Documentation

UBUNTU_DLL_PUBLIC void ubuntu_ui_install_task_controller ( ubuntu_ui_task_controller controller)
UBUNTU_DLL_PUBLIC void ubuntu_ui_report_notification_invisible ( )
UBUNTU_DLL_PUBLIC void ubuntu_ui_report_notification_visible ( )
UBUNTU_DLL_PUBLIC void ubuntu_ui_report_osk_invisible ( )
UBUNTU_DLL_PUBLIC void ubuntu_ui_report_osk_visible ( int  x,
int  y,
int  width,
int  height 
)
UBUNTU_DLL_PUBLIC void ubuntu_ui_session_focus_running_session_with_id ( int  id)
UBUNTU_DLL_PUBLIC void ubuntu_ui_session_install_session_lifecycle_observer ( ubuntu_ui_session_lifecycle_observer observer)
UBUNTU_DLL_PUBLIC int ubuntu_ui_session_properties_get_application_instance_id ( ubuntu_ui_session_properties  props)
UBUNTU_DLL_PUBLIC int ubuntu_ui_session_properties_get_application_stage_hint ( ubuntu_ui_session_properties  props)
UBUNTU_DLL_PUBLIC const char* ubuntu_ui_session_properties_get_desktop_file_hint ( ubuntu_ui_session_properties  props)
UBUNTU_DLL_PUBLIC const char* ubuntu_ui_session_properties_get_value_for_key ( ubuntu_ui_session_properties  props,
const char *  key 
)
UBUNTU_DLL_PUBLIC void ubuntu_ui_session_snapshot_running_session_with_id ( int  id,
ubuntu_ui_session_service_snapshot_cb  cb,
void *  context 
)
UBUNTU_DLL_PUBLIC void ubuntu_ui_session_trigger_switch_to_well_known_application ( ubuntu_ui_well_known_application  app)
UBUNTU_DLL_PUBLIC void ubuntu_ui_session_unfocus_running_sessions ( )
UBUNTU_DLL_PUBLIC int32_t ubuntu_ui_set_surface_trap ( int  x,
int  y,
int  width,
int  height 
)
UBUNTU_DLL_PUBLIC void ubuntu_ui_unset_surface_trap ( int32_t  handle)