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
Go to the documentation of this file.
1 /*
2  * Copyright © 2012 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Thomas Voß <thomas.voss@canonical.com>
17  */
18 
19 #ifndef UBUNTU_UI_SESSION_SERVICE_C_API_H_
20 #define UBUNTU_UI_SESSION_SERVICE_C_API_H_
21 
22 #include <ubuntu/visibility.h>
23 
24 #include <stdint.h>
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30  typedef enum
31  {
32  UNKNOWN_APP = -1,
33  CAMERA_APP = 0,
34  GALLERY_APP = 1,
35  BROWSER_APP = 2,
36  SHARE_APP = 3,
37  PHONE_APP = 4,
38  DIALER_APP = 5,
39  MESSAGING_APP = 6,
40  ADDRESSBOOK_APP = 7
41  } ubuntu_ui_well_known_application;
42 
43  typedef const void* ubuntu_ui_session_properties;
44  typedef const void* ubuntu_ui_session_preview_provider;
45 
46  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);
47 
48  typedef void (*session_requested_cb)(ubuntu_ui_well_known_application app, void* context);
49  typedef void (*session_born_cb)(ubuntu_ui_session_properties props, void* context);
50  typedef void (*session_unfocused_cb)(ubuntu_ui_session_properties props, void* context);
51  typedef void (*session_focused_cb)(ubuntu_ui_session_properties props, void* context);
52  typedef void (*keyboard_geometry_changed_cb)(int x, int y, int width, int height, void* context);
53  typedef void (*session_requested_fullscreen_cb)(ubuntu_ui_session_properties props, void* context);
54  typedef void (*session_died_cb)(ubuntu_ui_session_properties props, void * context);
55 
56  typedef struct
57  {
58  session_requested_cb on_session_requested;
59  session_born_cb on_session_born;
60  session_unfocused_cb on_session_unfocused;
61  session_focused_cb on_session_focused;
62  keyboard_geometry_changed_cb on_keyboard_geometry_changed;
63  session_requested_fullscreen_cb on_session_requested_fullscreen;
64  session_died_cb on_session_died;
65 
66  void* context;
67  } ubuntu_ui_session_lifecycle_observer;
68 
69  typedef void (*continue_task_cb)(int pid, void* context);
70  typedef void (*suspend_task_cb)(int pid, void* context);
71 
72  typedef struct
73  {
74  continue_task_cb continue_task;
75  suspend_task_cb suspend_task;
76 
77  void *context;
78  } ubuntu_ui_task_controller;
79 
80  UBUNTU_DLL_PUBLIC void
81  ubuntu_ui_install_task_controller(
82  ubuntu_ui_task_controller *controller);
83 
84  UBUNTU_DLL_PUBLIC const char*
85  ubuntu_ui_session_properties_get_value_for_key(
86  ubuntu_ui_session_properties props,
87  const char* key);
88 
89  UBUNTU_DLL_PUBLIC int
90  ubuntu_ui_session_properties_get_application_stage_hint(
91  ubuntu_ui_session_properties props);
92 
93  UBUNTU_DLL_PUBLIC int
94  ubuntu_ui_session_properties_get_application_instance_id(
95  ubuntu_ui_session_properties props);
96 
97  UBUNTU_DLL_PUBLIC const char*
98  ubuntu_ui_session_properties_get_desktop_file_hint(
99  ubuntu_ui_session_properties props);
100 
101  UBUNTU_DLL_PUBLIC void
102  ubuntu_ui_session_install_session_lifecycle_observer(
103  ubuntu_ui_session_lifecycle_observer* observer);
104 
105  UBUNTU_DLL_PUBLIC void
106  ubuntu_ui_session_unfocus_running_sessions();
107 
108  UBUNTU_DLL_PUBLIC void
109  ubuntu_ui_session_focus_running_session_with_id(int id);
110 
111  UBUNTU_DLL_PUBLIC void
112  ubuntu_ui_session_snapshot_running_session_with_id(int id, ubuntu_ui_session_service_snapshot_cb cb, void* context);
113 
114  UBUNTU_DLL_PUBLIC void
115  ubuntu_ui_session_trigger_switch_to_well_known_application(ubuntu_ui_well_known_application app);
116 
117  UBUNTU_DLL_PUBLIC int32_t
118  ubuntu_ui_set_surface_trap(int x, int y, int width, int height);
119 
120  UBUNTU_DLL_PUBLIC void
121  ubuntu_ui_unset_surface_trap(int32_t handle);
122 
123  UBUNTU_DLL_PUBLIC void
124  ubuntu_ui_report_osk_visible(int x, int y, int width, int height);
125 
126  UBUNTU_DLL_PUBLIC void
127  ubuntu_ui_report_osk_invisible();
128 
129  UBUNTU_DLL_PUBLIC void
130  ubuntu_ui_report_notification_visible();
131 
132  UBUNTU_DLL_PUBLIC void
133  ubuntu_ui_report_notification_invisible();
134 
135 #ifdef __cplusplus
136 }
137 #endif
138 
139 #endif // UBUNTU_UI_SESSION_SERVICE_C_API_H_