|  |  |  | Geoclue Reference Manual |  | 
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | Signals | ||||
GeoclueProvider; GeoclueProviderClass; void (*GeoclueProviderInfoCallback) (GeoclueProvider *provider,char *name,char *description,GError *error,gpointer userdata); void (*GeoclueProviderOptionsCallback) (GeoclueProvider *provider,GError *error,gpointer userdata); void (*GeoclueProviderStatusCallback) (GeoclueProvider *provider,GeoclueStatus status,GError *error,gpointer userdata); gboolean geoclue_provider_get_provider_info (GeoclueProvider *provider,char **name,char **description,GError **error); void geoclue_provider_get_provider_info_async (GeoclueProvider *provider,GeoclueProviderInfoCallback callback,gpointer userdata); gboolean geoclue_provider_get_status (GeoclueProvider *provider,GeoclueStatus *status,GError **error); void geoclue_provider_get_status_async (GeoclueProvider *provider,GeoclueProviderStatusCallback callback,gpointer userdata); gboolean geoclue_provider_set_options (GeoclueProvider *provider,GHashTable *options,GError **error); void geoclue_provider_set_options_async (GeoclueProvider *provider,GHashTable *options,GeoclueProviderOptionsCallback callback,gpointer userdata);
GObject +----GeoclueProvider +----GeocluePosition +----GeoclueVelocity +----GeoclueAddress +----GeoclueGeocode +----GeoclueReverseGeocode
"interface" gchar* : Write / Construct Only "path" gchar* : Write / Construct Only "service" gchar* : Write / Construct Only
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.
typedef struct {
	GObjectClass object_class;
	
	void (*status_changed) (GeoclueProvider *provider,
	                        GeoclueStatus    status);
} GeoclueProviderClass;
void (*GeoclueProviderInfoCallback) (GeoclueProvider *provider,char *name,char *description,GError *error,gpointer userdata);
Callback function for geoclue_provider_get_provider_info_async().
| 
 | A GeoclueProvider object | 
| 
 | Name of the provider | 
| 
 | one-line description of the provider | 
| 
 | Error as GError or NULL | 
| 
 | User data pointer set in geoclue_provider_get_provider_info_async() | 
void (*GeoclueProviderOptionsCallback) (GeoclueProvider *provider,GError *error,gpointer userdata);
Callback function for geoclue_provider_set_options_async().
| 
 | A GeoclueProvider object | 
| 
 | Error as GError or NULL | 
| 
 | User data pointer set in geoclue_provider_set_options_async() | 
void (*GeoclueProviderStatusCallback) (GeoclueProvider *provider,GeoclueStatus status,GError *error,gpointer userdata);
Callback function for geoclue_provider_get_status_async().
| 
 | A GeoclueProvider object | 
| 
 | A GeoclueStatus | 
| 
 | Error as GError or NULL | 
| 
 | User data pointer set in geoclue_provider_get_status_async() | 
gboolean geoclue_provider_get_provider_info (GeoclueProvider *provider,char **name,char **description,GError **error);
Obtains name and a short description of the provider.
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.
| 
 | A GeoclueProvider object | 
| 
 | A GeoclueProviderInfoCallback function that will be called when info is available | 
| 
 | pointer for user specified data | 
gboolean geoclue_provider_get_status (GeoclueProvider *provider,GeoclueStatus *status,GError **error);
Obtains the current status of the provider.
| 
 | A GeoclueProvider object | 
| 
 | Pointer for returned status as GeoclueStatus | 
| 
 | Pointer for returned GError or NULL | 
| Returns : | TRUEon success | 
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.
| 
 | A GeoclueProvider object | 
| 
 | A GeoclueProviderStatusCallback function that will be called when return values are available | 
| 
 | pointer for user specified data | 
gboolean geoclue_provider_set_options (GeoclueProvider *provider,GHashTable *options,GError **error);
Sets the options on the provider.
| 
 | A GeoclueProvider object | 
| 
 | A GHashTable containing the options | 
| 
 | Pointer for returned GError or NULL | 
| Returns : | TRUEif setting options succeeded | 
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.
| 
 | A GeoclueProvider object | 
| 
 | A GHashTable of options | 
| 
 | A GeoclueProviderOptionsCallback function that will be called when options are set | 
| 
 | pointer for user specified data | 
"interface" property"interface" gchar* : Write / Construct Only
The D-Bus interface implemented by the object.
Default value: ""
"path" property"path" gchar* : Write / Construct Only
The D-Bus path to this provider.
Default value: ""
"service" property"service" gchar* : Write / Construct Only
The D-Bus service this object represents.
Default value: ""
"status-changed" signalvoid                user_function                      (GeoclueProvider *provider,
                                                        gint             status,
                                                        gpointer         user_data)      : No Recursion
The status-changed signal is emitted each time the provider status changes
| 
 | the provider object emitting the signal | 
| 
 | New provider status as GeoclueStatus | 
| 
 | user data set when the signal handler was connected. |