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
controller.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: Thomas Voß <thomas.voss@canonical.com>
17  */
18 
19 #ifndef UBUNTU_APPLICATION_LOCATION_SERVICE_CONTROLLER_H_
20 #define UBUNTU_APPLICATION_LOCATION_SERVICE_CONTROLLER_H_
21 
22 #include <ubuntu/status.h>
23 #include <ubuntu/visibility.h>
24 
25 #ifdef __cplusplus
26 extern "C"
27 {
28 #endif
29 
34  typedef enum
35  {
36  UA_LOCATION_SERVICE_ENABLED = 1 << 0,
37  UA_LOCATION_SERVICE_DISABLED = 1 << 1,
38  UA_LOCATION_SERVICE_GPS_ENABLED = 1 << 2,
39  UA_LOCATION_SERVICE_GPS_DISABLED = 1 << 3,
40  } UbuntuApplicationLocationServiceStatus;
41 
42  typedef UbuntuApplicationLocationServiceStatus UALocationServiceStatus;
43 
44  typedef unsigned int UALocationServiceStatusFlags;
45 
50  typedef void (*UALocationServiceStatusChangedHandler)(
51  UALocationServiceStatusFlags flags,
52  void *context);
53 
58  typedef struct UbuntuApplicationLocationServiceController UALocationServiceController;
59 
65  UBUNTU_DLL_PUBLIC void
66  ua_location_service_controller_ref(
67  UALocationServiceController *controller);
68 
74  UBUNTU_DLL_PUBLIC void
75  ua_location_service_controller_unref(
76  UALocationServiceController *controller);
77 
85  UBUNTU_DLL_PUBLIC void
86  ua_location_service_controller_set_status_changed_handler(
87  UALocationServiceController *controller,
88  UALocationServiceStatusChangedHandler handler,
89  void *context);
90 
97  UBUNTU_DLL_PUBLIC UStatus
98  ua_location_service_controller_query_status(
99  UALocationServiceController *controller,
100  UALocationServiceStatusFlags *out_flags);
101 
107  UBUNTU_DLL_PUBLIC UStatus
108  ua_location_service_controller_enable_service(
109  UALocationServiceController *controller);
110 
116  UBUNTU_DLL_PUBLIC UStatus
117  ua_location_service_controller_disable_service(
118  UALocationServiceController *controller);
119 
125  UBUNTU_DLL_PUBLIC UStatus
126  ua_location_service_controller_enable_gps(
127  UALocationServiceController *controller);
128 
134  UBUNTU_DLL_PUBLIC UStatus
135  ua_location_service_controller_disable_gps(
136  UALocationServiceController *controller);
137 
138 
139 #ifdef __cplusplus
140 }
141 #endif
142 
143 #endif // UBUNTU_APPLICATION_LOCATION_SERVICE_CONTROLLER_H_