From: Pierre-Luc Beaudoin Date: Sat, 6 Sep 2008 16:58:59 +0000 (-0400) Subject: Improve doc X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2aa28c3ad080d81d058b3541c647479c023e4e88;p=libchamplain Improve doc --- diff --git a/champlain/champlainmarker.c b/champlain/champlainmarker.c index 7fe3b50..d16610d 100644 --- a/champlain/champlainmarker.c +++ b/champlain/champlainmarker.c @@ -163,7 +163,7 @@ champlain_marker_init (ChamplainMarker *champlainMarker) /** * champlain_marker_new: * - * Returns a new #ChamplainWidget ready to be used as a #ClutterActor. + * Returns a new #ChamplainMarker ready to be used as a #ClutterActor. * * Since: 0.2 */ @@ -229,7 +229,7 @@ champlain_marker_set_anchor (ChamplainMarker *champlainMarker, gint x, gint y) * @text_color: a #ClutterColor, the color of the text, can be NULL * @marker_color: a #ClutterColor, the color of the marker, can be NULL * - * Returns a new #ChamplainWidget with a drawn marker containing the given text. + * Returns a new #ChamplainMarker with a drawn marker containing the given text. * * Since: 0.2 */ diff --git a/docs/reference/libchamplain-docs.sgml b/docs/reference/libchamplain-docs.sgml index 7ce90b2..a63dfd9 100644 --- a/docs/reference/libchamplain-docs.sgml +++ b/docs/reference/libchamplain-docs.sgml @@ -14,5 +14,6 @@ I. API Reference + diff --git a/docs/reference/libchamplain-sections.txt b/docs/reference/libchamplain-sections.txt index 666e59b..2859920 100644 --- a/docs/reference/libchamplain-sections.txt +++ b/docs/reference/libchamplain-sections.txt @@ -4,9 +4,6 @@ champlain/champlainview.h ChamplainMapSource ChamplainViewMode -CHAMPLAIN_CLASS -CHAMPLAIN_GET_CLASS -ChamplainViewPrivate ChamplainView champlain_view_get_type champlain_view_new @@ -19,6 +16,17 @@ CHAMPLAIN_IS_VIEW CHAMPLAIN_TYPE_VIEW CHAMPLAIN_IS_VIEW_CLASS +
+champlainmarker +ChamplainMarker +champlain/champlainmarker.h +ChamplainMarker +champlain_marker_get_type +champlain_marker_new +champlain_marker_new_with_label +champlain_marker_set_anchor +champlain_marker_set_position +
champlain diff --git a/docs/reference/tmpl/champlainmarker.sgml b/docs/reference/tmpl/champlainmarker.sgml new file mode 100644 index 0000000..1dc25a4 --- /dev/null +++ b/docs/reference/tmpl/champlainmarker.sgml @@ -0,0 +1,77 @@ + +ChamplainMarker + + +A marker to identify points of interest on a map + + +Markers reprensent points of interest on a map. Markers need to be placed on a layer (a #ClutterGroup). Layers have to be added to a #ChamplainView for the markers to show on the map. + +A marker is nothing more than a regular #ClutterActor. You can draw on it what ever you want. Don't forget to set the anchor position in the marker using #champlain_marker_set_anchor. Set the markers position on the map using #champlain_marker_set_position. + +Champlain has a default type of markers with text. To create one, use #champlain_marker_new_with_label. + + + + + + + + + + + + + + +@group: +@priv: + + + + + + +@Returns: + + + + + + + +@Returns: + + + + + + + +@label: +@font: +@text_color: +@marker_color: +@Returns: + + + + + + + +@marker: +@x: +@y: + + + + + + + +@marker: +@longitude: +@latitude: + + diff --git a/docs/reference/tmpl/champlainview.sgml b/docs/reference/tmpl/champlainview.sgml new file mode 100644 index 0000000..fa75da2 --- /dev/null +++ b/docs/reference/tmpl/champlainview.sgml @@ -0,0 +1,131 @@ + +ChamplainView + + +A widget to display maps + + + +The #ChamplainView widget is a Clutter based widget to display maps. It supports two modes of scrolling: + + Push: the normal behavior where the maps doesn't move after the user stopped scrolling; + Kinetic: the iPhone-like behavior where the maps decelerate after the user stopped scrolling. + + + +You can use the same #ChamplainView to display many types of maps. In Champlain they are called map sources. You can change the #map-source property at anytime to replace the current displayed map. + + +The maps are downloaded from Internet from open maps sources (like OpenStreetMap). Maps are divided in tiles for each zoom level. When a tile is requested, #ChamplainView will first check if it is in cache (in +the user's cache dir under champlain). If an error occurs during download, an error tile will be displayed (if not in offline mode). + + + + + + + + + + + + + + + + + + +@CHAMPLAIN_MAP_SOURCE_DEBUG: +@CHAMPLAIN_MAP_SOURCE_OPENSTREETMAP: +@CHAMPLAIN_MAP_SOURCE_OPENARIALMAP: +@CHAMPLAIN_MAP_SOURCE_MAPSFORFREE_RELIEF: +@CHAMPLAIN_MAP_SOURCE_COUNT: + + + + + + +@CHAMPLAIN_VIEW_MODE_PUSH: +@CHAMPLAIN_VIEW_MODE_KINETIC: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@mode: +@Returns: + + + + + + + +@view: +@longitude: +@latitude: + + + + + + + +@champlainView: + + + + + + + +@champlainView: + +