![]() |
![]() |
![]() |
geocode-glib Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
#include <geocode-glib/geocode-glib.h> struct GeocodeForward; struct GeocodeForwardClass; GeocodeForward * geocode_forward_new_for_string (const char *str
); GeocodeForward * geocode_forward_new_for_params (GHashTable *params
); guint geocode_forward_get_answer_count (GeocodeForward *forward
); void geocode_forward_set_answer_count (GeocodeForward *forward
,guint count
); GeocodeBoundingBox * geocode_forward_get_search_area (GeocodeForward *forward
); void geocode_forward_set_search_area (GeocodeForward *forward
,GeocodeBoundingBox *box
); gboolean geocode_forward_get_bounded (GeocodeForward *forward
); void geocode_forward_set_bounded (GeocodeForward *forward
,gboolean bounded
); void geocode_forward_search_async (GeocodeForward *forward
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); GList * geocode_forward_search_finish (GeocodeForward *forward
,GAsyncResult *res
,GError **error
); GList * geocode_forward_search (GeocodeForward *forward
,GError **error
); void geocode_forward_set_backend (GeocodeForward *forward
,GeocodeBackend *backend
);
"answer-count" guint : Read / Write "bounded" gboolean : Read / Write "search-area" GeocodeBoundingBox* : Read / Write
struct GeocodeForward;
All the fields in the GeocodeForward structure are private and should never be accessed directly.
struct GeocodeForwardClass { };
All the fields in the GeocodeForwardClass structure are private and should never be accessed directly.
GeocodeForward * geocode_forward_new_for_string (const char *str
);
Creates a new GeocodeForward to perform forward geocoding with. The string is in free-form format.
|
a string containing a free-form description of the location |
Returns : |
a new GeocodeForward. Use g_object_unref() when done. |
GeocodeForward * geocode_forward_new_for_params (GHashTable *params
);
Creates a new GeocodeForward to perform geocoding with. The GHashTable is in the format used by Telepathy, and documented on Telepathy's specification site.
See also: XEP-0080 specification.
|
a GHashTable with string keys, and GValue values. [transfer none][element-type utf8 GValue] |
Returns : |
a new GeocodeForward. Use g_object_unref() when done. |
guint geocode_forward_get_answer_count (GeocodeForward *forward
);
Gets the number of requested results for searches.
|
a GeocodeForward representing a query |
void geocode_forward_set_answer_count (GeocodeForward *forward
,guint count
);
Sets the number of requested results to count
.
|
a GeocodeForward representing a query |
|
the number of requested results, which must be greater than zero |
GeocodeBoundingBox * geocode_forward_get_search_area (GeocodeForward *forward
);
Gets the area to limit searches within.
|
a GeocodeForward representing a query |
Returns : |
the search area, or NULL if none is set. [transfer none][nullable]
|
void geocode_forward_set_search_area (GeocodeForward *forward
,GeocodeBoundingBox *box
);
Sets the area to limit searches within.
|
a GeocodeForward representing a query |
|
a bounding box to limit the search area. |
gboolean geocode_forward_get_bounded (GeocodeForward *forward
);
Gets the "bounded" property that regulates whether the "search-area" property acts restricting or not.
|
a GeocodeForward representing a query |
void geocode_forward_set_bounded (GeocodeForward *forward
,gboolean bounded
);
Set the "bounded" property that regulates whether the "search-area" property acts restricting or not.
|
a GeocodeForward representing a query |
|
TRUE to restrict results to only items contained within the "search-area" bounding box. |
void geocode_forward_search_async (GeocodeForward *forward
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously performs a forward geocoding
query using a web service. Use geocode_forward_search()
to do the same
thing synchronously.
When the operation is finished, callback
will be called. You can then call
geocode_forward_search_finish()
to get the result of the operation.
|
a GeocodeForward representing a query |
|
optional GCancellable forward, NULL to ignore. |
|
a GAsyncReadyCallback to call when the request is satisfied |
|
the data to pass to callback function |
GList * geocode_forward_search_finish (GeocodeForward *forward
,GAsyncResult *res
,GError **error
);
Finishes a forward geocoding operation. See geocode_forward_search_async()
.
|
a GeocodeForward representing a query |
|
a GAsyncResult. |
|
a GError. |
Returns : |
A list of
places or NULL in case of errors. Free the returned instances with
g_object_unref() and the list with g_list_free() when done. [element-type GeocodePlace][transfer full]
|
GList * geocode_forward_search (GeocodeForward *forward
,GError **error
);
Gets the result of a forward geocoding
query using the current backend (see geocode_forward_set_backend()
). By
default the GNOME Nominatim server is used. See GeocodeBackend for more
information.
If no results are found, a GEOCODE_ERROR_NO_MATCHES
error is returned.
|
a GeocodeForward representing a query |
|
a GError |
Returns : |
A list of
places or NULL in case of errors. Free the returned instances with
g_object_unref() and the list with g_list_free() when done. [element-type GeocodePlace][transfer full]
|
void geocode_forward_set_backend (GeocodeForward *forward
,GeocodeBackend *backend
);
Specifies the backend to use in the forward geocoding operation.
If none is given, the default GNOME Nominatim server is used.
|
a GeocodeForward representing a query |
|
a GeocodeBackend, or NULL to use the
default one. [nullable][transfer none]
|
Since 3.23.1
"answer-count"
property "answer-count" guint : Read / Write
The number of requested results to a search query.
Allowed values: <= G_MAXLONG
Default value: 10
"bounded"
property "bounded" gboolean : Read / Write
If set to TRUE then only results in the "search-area" bounding box are returned. If set to FALSE the "search-area" is treated like a preferred area for results.
Default value: FALSE
"search-area"
property"search-area" GeocodeBoundingBox* : Read / Write
The bounding box that limits the search area. If "bounded" property is set to TRUE only results from this area is returned.