| Top |
GObject ╰── GeoclueProvider ├── GeocluePosition ├── GeoclueVelocity ├── GeoclueAddress ├── GeoclueGeocode ╰── GeoclueReverseGeocode
GeoclueProvider contains the methods and signals common to all Geoclue providers. It is part of the public C client API which uses D-Bus to communicate with the actual provider.
A GeoclueProvider is not explicitly created. Instead any provider object can be cast to GeoclueProvider. Using a GeocluePosition as example here:
1 2 3 4 5 6 7 8 9 10 11 |
GeocluePosition *pos; char *name; GError *error; pos = geoclue_position_new ("org.freedesktop.Geoclue.Providers.Example", "/org/freedesktop/Geoclue/Providers/Example"); if (geoclue_provider_get_provider_info (GEOCLUE_PROVIDER (pos), &name, NULL, &error)) { g_print ("name = %s", name); } |
GeoclueProvider can be used to obtain generic information about the provider and to set provider options.
gboolean geoclue_provider_get_status (GeoclueProvider *provider,GeoclueStatus *status,GError **error);
Obtains the current status of the provider.
provider |
A GeoclueProvider object |
|
status |
Pointer for returned status as GeoclueStatus |
|
error |
void (*GeoclueProviderStatusCallback) (GeoclueProvider *provider,GeoclueStatus status,GError *error,gpointer userdata);
Callback function for geoclue_provider_get_status_async().
provider |
A GeoclueProvider object |
|
status |
||
error |
||
userdata |
User data pointer set in |
void geoclue_provider_get_status_async (GeoclueProvider *provider,GeoclueProviderStatusCallback callback,gpointer userdata);
Asynchronous version of geoclue_provider_get_status(). Function returns
(essentially) immediately and calls callback
when status is available or
when there is an error.
provider |
A GeoclueProvider object |
|
callback |
A GeoclueProviderStatusCallback function that will be called when return values are available |
|
userdata |
pointer for user specified data |
gboolean geoclue_provider_get_provider_info (GeoclueProvider *provider,char **name,char **description,GError **error);
Obtains name and a short description of the provider.
provider |
A GeoclueProvider object |
|
name |
Pointer for returned provider name or |
|
description |
Pointer for returned provider description or |
|
error |
void (*GeoclueProviderInfoCallback) (GeoclueProvider *provider,char *name,char *description,GError *error,gpointer userdata);
Callback function for geoclue_provider_get_provider_info_async().
provider |
A GeoclueProvider object |
|
name |
Name of the provider |
|
description |
one-line description of the provider |
|
error |
||
userdata |
User data pointer set in |
void geoclue_provider_get_provider_info_async (GeoclueProvider *provider,GeoclueProviderInfoCallback callback,gpointer userdata);
Asynchronous version of geoclue_provider_get_provider_info(). Function returns
(essentially) immediately and calls callback
when info is available or
when there is an error.
provider |
A GeoclueProvider object |
|
callback |
A GeoclueProviderInfoCallback function that will be called when info is available |
|
userdata |
pointer for user specified data |
gboolean geoclue_provider_set_options (GeoclueProvider *provider,GHashTable *options,GError **error);
Sets the options on the provider.
void (*GeoclueProviderOptionsCallback) (GeoclueProvider *provider,GError *error,gpointer userdata);
Callback function for geoclue_provider_set_options_async().
provider |
A GeoclueProvider object |
|
error |
||
userdata |
User data pointer set in |
void geoclue_provider_set_options_async (GeoclueProvider *provider,GHashTable *options,GeoclueProviderOptionsCallback callback,gpointer userdata);
Asynchronous version of geoclue_provider_set_options(). Function returns
(essentially) immediately and calls callback
when options have been set or
when there is an error.
provider |
A GeoclueProvider object |
|
options |
A GHashTable of options |
|
callback |
A GeoclueProviderOptionsCallback function that will be called when options are set |
|
userdata |
pointer for user specified data |
“interface” property“interface” gchar *
The D-Bus interface implemented by the object.
Flags: Write / Construct Only
Default value: ""
“path” property“path” gchar *
The D-Bus path to this provider.
Flags: Write / Construct Only
Default value: ""
“service” property“service” gchar *
The D-Bus service this object represents.
Flags: Write / Construct Only
Default value: ""
“status-changed” signalvoid user_function (GeoclueProvider *provider, gint status, gpointer user_data)
Flags: No Recursion