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
window_properties.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 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: Ricardo Mendoza <ricardo.mendoza@canonical.com>
17  * Thomas Voß <thomas.voss@canonical.com>
18  */
19 
20 #ifndef UBUNTU_APPLICATION_UI_WINDOW_PROPERTIES_H_
21 #define UBUNTU_APPLICATION_UI_WINDOW_PROPERTIES_H_
22 
23 #include <ubuntu/visibility.h>
24 
25 #include <ubuntu/application/ui/input/event.h>
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31  typedef enum {
32  U_MAIN_ROLE = 1,
33  U_DASH_ROLE,
34  U_INDICATOR_ROLE,
35  U_NOTIFICATIONS_ROLE,
36  U_GREETER_ROLE,
37  U_LAUNCHER_ROLE,
38  U_ON_SCREEN_KEYBOARD_ROLE,
39  U_SHUTDOWN_DIALOG_ROLE,
40  } UAUiWindowRole;
41 
42 
43  typedef void (*input_event_cb)(void* ctx, const Event* ev);
44  typedef input_event_cb UAUiWindowInputEventCb;
45 
46  typedef void UAUiWindowProperties;
47 
48  UBUNTU_DLL_PUBLIC UAUiWindowProperties*
49  ua_ui_window_properties_new_for_normal_window();
50 
51  UBUNTU_DLL_PUBLIC void
52  ua_ui_window_properties_destroy(
53  UAUiWindowProperties *properties);
54 
55  UBUNTU_DLL_PUBLIC void
56  ua_ui_window_properties_set_titlen(
57  UAUiWindowProperties *properties,
58  const char *title,
59  size_t size);
60 
61  UBUNTU_DLL_PUBLIC const char*
62  ua_ui_window_properties_get_title(
63  UAUiWindowProperties *properties);
64 
65  UBUNTU_DLL_PUBLIC void
66  ua_ui_window_properties_set_role(
67  UAUiWindowProperties *properties,
68  UAUiWindowRole role);
69 
70  UBUNTU_DLL_PUBLIC UAUiWindowRole
71  ua_ui_window_properties_get_role(
72  UAUiWindowProperties *properties);
73 
74  UBUNTU_DLL_PUBLIC void
75  ua_ui_window_properties_set_input_cb_and_ctx(
76  UAUiWindowProperties *properties,
77  UAUiWindowInputEventCb cb,
78  void *ctx);
79 
80 #ifdef __cplusplus
81 }
82 #endif
83 
84 #endif /* UBUNTU_APPLICATION_UI_WINDOW_PROPERTIES_H_ */