[libchamplain] Update documentation
- From: Jiří Techet <jiritechet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libchamplain] Update documentation
- Date: Wed, 9 Feb 2011 08:40:35 +0000 (UTC)
commit 08b3c51981fdbf8343f1d55eb889a97d681f9e78
Author: JiÅ?Ã Techet <techet gmail com>
Date: Mon Feb 7 23:23:03 2011 +0100
Update documentation
champlain/champlain-label.c | 94 ++++----
champlain/champlain-layer.c | 22 ++-
champlain/champlain-license.c | 74 +++++-
champlain/champlain-license.h | 1 +
champlain/champlain-map-source-desc.c | 224 ++++++++++++++++-
champlain/champlain-map-source-desc.h | 28 +--
champlain/champlain-map-source-factory.c | 7 +-
champlain/champlain-marker-layer.c | 196 +++++++++------
champlain/champlain-marker.c | 10 +
champlain/champlain-point.c | 81 ++++++-
champlain/champlain-scale.c | 58 ++++-
champlain/champlain-scale.h | 1 +
champlain/champlain-tile-source.c | 2 +-
champlain/champlain-tile.c | 8 +-
champlain/champlain-view.c | 113 +++++++--
champlain/champlain-view.h | 1 -
docs/reference/libchamplain-docs.sgml | 17 +-
docs/reference/libchamplain-sections.txt | 404 ++++++++++++++++-------------
18 files changed, 943 insertions(+), 398 deletions(-)
---
diff --git a/champlain/champlain-label.c b/champlain/champlain-label.c
index d432a03..8fdc34a 100644
--- a/champlain/champlain-label.c
+++ b/champlain/champlain-label.c
@@ -138,7 +138,7 @@ static void unmap (ClutterActor *self);
* Changes the selection color, this is to ensure a better integration with
* the desktop, this is automatically done by GtkChamplainEmbed.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_selection_color (ClutterColor *color)
@@ -157,7 +157,7 @@ champlain_label_set_selection_color (ClutterColor *color)
*
* Returns: the selection color. Should not be freed.
*
- * Since: 0.4.1
+ * Since: 0.10
*/
const ClutterColor *
champlain_label_get_selection_color ()
@@ -173,7 +173,7 @@ champlain_label_get_selection_color ()
* Changes the selection text color, this is to ensure a better integration with
* the desktop, this is automatically done by GtkChamplainEmbed.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_selection_text_color (ClutterColor *color)
@@ -192,7 +192,7 @@ champlain_label_set_selection_text_color (ClutterColor *color)
*
* Returns: the selection text color. Should not be freed.
*
- * Since: 0.4.1
+ * Since: 0.10
*/
const ClutterColor *
champlain_label_get_selection_text_color ()
@@ -441,7 +441,7 @@ champlain_label_class_init (ChamplainLabelClass *klass)
*
* The text of the label
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class, PROP_TEXT,
g_param_spec_string ("text", "Text", "The text of the label",
@@ -452,7 +452,7 @@ champlain_label_class_init (ChamplainLabelClass *klass)
*
* The image of the label
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class, PROP_IMAGE,
g_param_spec_object ("image", "Image", "The image of the label",
@@ -463,7 +463,7 @@ champlain_label_class_init (ChamplainLabelClass *klass)
*
* If the label's text uses markup
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class, PROP_USE_MARKUP,
g_param_spec_boolean ("use-markup", "Use Markup", "The text uses markup",
@@ -474,7 +474,7 @@ champlain_label_class_init (ChamplainLabelClass *klass)
*
* The label's alignment
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class, PROP_ALIGNMENT,
g_param_spec_enum ("alignment", "Alignment", "The label's alignment",
@@ -485,7 +485,7 @@ champlain_label_class_init (ChamplainLabelClass *klass)
*
* The label's color
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class, PROP_COLOR,
clutter_param_spec_color ("color", "Color", "The label's color",
@@ -496,7 +496,7 @@ champlain_label_class_init (ChamplainLabelClass *klass)
*
* The label's text color
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class, PROP_TEXT_COLOR,
clutter_param_spec_color ("text-color", "Text Color", "The label's text color",
@@ -507,7 +507,7 @@ champlain_label_class_init (ChamplainLabelClass *klass)
*
* The label's text font name
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class, PROP_FONT_NAME,
g_param_spec_string ("font-name", "Font Name", "The label's text font name",
@@ -518,7 +518,7 @@ champlain_label_class_init (ChamplainLabelClass *klass)
*
* If the label's text wrap is set
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class, PROP_WRAP,
g_param_spec_boolean ("wrap", "Wrap", "The label's text wrap",
@@ -529,7 +529,7 @@ champlain_label_class_init (ChamplainLabelClass *klass)
*
* The label's text wrap mode
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class, PROP_WRAP_MODE,
g_param_spec_enum ("wrap-mode", "Wrap Mode", "The label's text wrap mode",
@@ -540,7 +540,7 @@ champlain_label_class_init (ChamplainLabelClass *klass)
*
* The label's ellipsize mode
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class, PROP_ELLIPSIZE,
g_param_spec_enum ("ellipsize", "Ellipsize Mode", "The label's text ellipsize mode",
@@ -551,7 +551,7 @@ champlain_label_class_init (ChamplainLabelClass *klass)
*
* If the label has a background
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class, PROP_DRAW_BACKGROUND,
g_param_spec_boolean ("draw-background", "Draw Background", "The label has a background",
@@ -562,7 +562,7 @@ champlain_label_class_init (ChamplainLabelClass *klass)
*
* If the label is in single line mode
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class, PROP_SINGLE_LINE_MODE,
g_param_spec_boolean ("single-line-mode", "Single Line Mode", "The label's single line mode",
@@ -847,7 +847,7 @@ redraw_on_idle (gpointer gobject)
* that affect the aspect of the label. When they change, call this function
* to update the label.
*
- * Since: 0.4.3
+ * Since: 0.10
*/
void
champlain_label_queue_redraw (ChamplainLabel *label)
@@ -912,7 +912,7 @@ champlain_label_init (ChamplainLabel *label)
*
* Returns: a new #ChamplainLabel ready to be used as a #ClutterActor.
*
- * Since: 0.2
+ * Since: 0.10
*/
ClutterActor *
champlain_label_new (void)
@@ -1025,7 +1025,7 @@ unmap (ClutterActor *self)
*
* Returns: a new #ChamplainLabel with a drawn label containing the given text.
*
- * Since: 0.2
+ * Since: 0.10
*/
ClutterActor *
champlain_label_new_with_text (const gchar *text,
@@ -1059,7 +1059,7 @@ champlain_label_new_with_text (const gchar *text,
* Returns: a new #ChamplainLabel with a drawn label containing the given
* image.
*
- * Since: 0.4
+ * Since: 0.10
*/
ClutterActor *
champlain_label_new_with_image (ClutterActor *actor)
@@ -1085,7 +1085,7 @@ champlain_label_new_with_image (ClutterActor *actor)
* Returns: a new #ChamplainLabel with a drawn label containing the given
* image.
*
- * Since: 0.4
+ * Since: 0.10
*/
ClutterActor *
champlain_label_new_from_file (const gchar *filename,
@@ -1116,7 +1116,7 @@ champlain_label_new_from_file (const gchar *filename,
* Returns: a new #ChamplainLabel with a drawn label containing the given
* image.
*
- * Since: 0.4
+ * Since: 0.10
*/
ClutterActor *
champlain_label_new_full (const gchar *text,
@@ -1141,7 +1141,7 @@ champlain_label_new_full (const gchar *text,
*
* Sets the label's text.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_text (ChamplainLabel *label,
@@ -1166,7 +1166,7 @@ champlain_label_set_text (ChamplainLabel *label,
*
* Sets the label's image.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_image (ChamplainLabel *label,
@@ -1199,7 +1199,7 @@ champlain_label_set_image (ChamplainLabel *label,
*
* Sets if the label's text uses markup.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_use_markup (ChamplainLabel *label,
@@ -1220,7 +1220,7 @@ champlain_label_set_use_markup (ChamplainLabel *label,
*
* Set the label's text alignment.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_alignment (ChamplainLabel *label,
@@ -1242,7 +1242,7 @@ champlain_label_set_alignment (ChamplainLabel *label,
*
* Set the label's background color.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_color (ChamplainLabel *label,
@@ -1272,7 +1272,7 @@ champlain_label_set_color (ChamplainLabel *label,
*
* Set the label's text color.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_text_color (ChamplainLabel *label,
@@ -1302,7 +1302,7 @@ champlain_label_set_text_color (ChamplainLabel *label,
*
* Set the label's font name such as "Sans 12".
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_font_name (ChamplainLabel *label,
@@ -1331,7 +1331,7 @@ champlain_label_set_font_name (ChamplainLabel *label,
*
* Set if the label's text wrap.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_wrap (ChamplainLabel *label,
@@ -1352,7 +1352,7 @@ champlain_label_set_wrap (ChamplainLabel *label,
*
* Set the label's text color.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_wrap_mode (ChamplainLabel *label,
@@ -1373,7 +1373,7 @@ champlain_label_set_wrap_mode (ChamplainLabel *label,
*
* Set the label's text attribute.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_attributes (ChamplainLabel *label,
@@ -1403,7 +1403,7 @@ champlain_label_set_attributes (ChamplainLabel *label,
*
* Set the label's text ellipsize mode.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_ellipsize (ChamplainLabel *label,
@@ -1424,7 +1424,7 @@ champlain_label_set_ellipsize (ChamplainLabel *label,
*
* Set if the label's text is on a single line.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_single_line_mode (ChamplainLabel *label,
@@ -1446,7 +1446,7 @@ champlain_label_set_single_line_mode (ChamplainLabel *label,
*
* Set if the label has a background.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_label_set_draw_background (ChamplainLabel *label,
@@ -1468,7 +1468,7 @@ champlain_label_set_draw_background (ChamplainLabel *label,
*
* Returns: (transfer none): the label's image.
*
- * Since: 0.4
+ * Since: 0.10
*/
ClutterActor *
champlain_label_get_image (ChamplainLabel *label)
@@ -1487,7 +1487,7 @@ champlain_label_get_image (ChamplainLabel *label)
*
* Returns: if the label's text contains markup.
*
- * Since: 0.4
+ * Since: 0.10
*/
gboolean
champlain_label_get_use_markup (ChamplainLabel *label)
@@ -1506,7 +1506,7 @@ champlain_label_get_use_markup (ChamplainLabel *label)
*
* Returns: the label's text.
*
- * Since: 0.4
+ * Since: 0.10
*/
const gchar *
champlain_label_get_text (ChamplainLabel *label)
@@ -1525,7 +1525,7 @@ champlain_label_get_text (ChamplainLabel *label)
*
* Returns: the label's text alignment.
*
- * Since: 0.4
+ * Since: 0.10
*/
PangoAlignment
champlain_label_get_alignment (ChamplainLabel *label)
@@ -1544,7 +1544,7 @@ champlain_label_get_alignment (ChamplainLabel *label)
*
* Returns: the label's color.
*
- * Since: 0.4
+ * Since: 0.10
*/
ClutterColor *
champlain_label_get_color (ChamplainLabel *label)
@@ -1563,7 +1563,7 @@ champlain_label_get_color (ChamplainLabel *label)
*
* Returns: the label's text color.
*
- * Since: 0.4
+ * Since: 0.10
*/
ClutterColor *
champlain_label_get_text_color (ChamplainLabel *label)
@@ -1582,7 +1582,7 @@ champlain_label_get_text_color (ChamplainLabel *label)
*
* Returns: the label's font name.
*
- * Since: 0.4
+ * Since: 0.10
*/
const gchar *
champlain_label_get_font_name (ChamplainLabel *label)
@@ -1601,7 +1601,7 @@ champlain_label_get_font_name (ChamplainLabel *label)
*
* Returns: if the label's text wraps.
*
- * Since: 0.4
+ * Since: 0.10
*/
gboolean
champlain_label_get_wrap (ChamplainLabel *label)
@@ -1620,7 +1620,7 @@ champlain_label_get_wrap (ChamplainLabel *label)
*
* Returns: the label's text wrap mode.
*
- * Since: 0.4
+ * Since: 0.10
*/
PangoWrapMode
champlain_label_get_wrap_mode (ChamplainLabel *label)
@@ -1639,7 +1639,7 @@ champlain_label_get_wrap_mode (ChamplainLabel *label)
*
* Returns: the label's text ellipsize mode.
*
- * Since: 0.4
+ * Since: 0.10
*/
PangoEllipsizeMode
champlain_label_get_ellipsize (ChamplainLabel *label)
@@ -1658,7 +1658,7 @@ champlain_label_get_ellipsize (ChamplainLabel *label)
*
* Returns: the label's text single line mode.
*
- * Since: 0.4
+ * Since: 0.10
*/
gboolean
champlain_label_get_single_line_mode (ChamplainLabel *label)
@@ -1677,7 +1677,7 @@ champlain_label_get_single_line_mode (ChamplainLabel *label)
*
* Returns: if the label's has a background.
*
- * Since: 0.4
+ * Since: 0.10
*/
gboolean
champlain_label_get_draw_background (ChamplainLabel *label)
diff --git a/champlain/champlain-layer.c b/champlain/champlain-layer.c
index ec589a4..81fdd30 100644
--- a/champlain/champlain-layer.c
+++ b/champlain/champlain-layer.c
@@ -16,6 +16,14 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * SECTION:champlain-layer
+ * @short_description: Base class of libchamplain layers
+ *
+ * Every layer (overlay that moves together with the map) has to inherit this
+ * class and implement its virtual methods.
+ */
+
#include "champlain-layer.h"
G_DEFINE_TYPE (ChamplainLayer, champlain_layer, CLUTTER_TYPE_ACTOR)
@@ -45,7 +53,19 @@ champlain_layer_class_init (ChamplainLayerClass *klass)
klass->set_view = NULL;
}
-
+/**
+ * champlain_layer_set_view:
+ * @layer: a #ChamplainLayer
+ * @view: a #ChamplainView
+ *
+ * #ChamplainView calls this method to pass a reference to itself to the layer
+ * when the layer is added to the view. When the layer is removed from the
+ * view, it passes NULL to the layer. Custom layers can implement this method
+ * and perform the necessary initialization. This method schould not be called
+ * by user code.
+ *
+ * Since: 0.10
+ */
void champlain_layer_set_view (ChamplainLayer *layer,
ChamplainView *view)
{
diff --git a/champlain/champlain-license.c b/champlain/champlain-license.c
index d69cc19..af2db9a 100644
--- a/champlain/champlain-license.c
+++ b/champlain/champlain-license.c
@@ -16,6 +16,12 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * SECTION:champlain-license
+ * @short_description: An actor that displays license text.
+ *
+ * An actor that displays license text.
+ */
#include "config.h"
@@ -171,13 +177,13 @@ champlain_license_class_init (ChamplainLicenseClass *klass)
actor_class->unmap = unmap;
/**
- * ChamplainView:license-text:
+ * ChamplainLicense:extra-text:
*
* Sets additional text to be displayed in the license area. The map's
- * license will be added below it. Your text can have multiple line, just use
+ * license will be added below it. Your text can have multiple lines, just use
* "\n" in between.
*
- * Since: 0.4.3
+ * Since: 0.10
*/
g_object_class_install_property (object_class,
PROP_LICENSE_EXTRA,
@@ -195,17 +201,23 @@ redraw_license (ChamplainLicense *license)
ChamplainLicensePrivate *priv = license->priv;
gchar *text;
gfloat width, height;
+ ChamplainMapSource *map_source;
if (!priv->view)
return;
+ map_source = champlain_view_get_map_source (priv->view);
+
+ if (!map_source)
+ return;
+
if (priv->extra_text)
text = g_strjoin ("\n",
priv->extra_text,
- champlain_view_get_license_text (priv->view),
+ champlain_map_source_get_license (map_source),
NULL);
else
- text = g_strdup (champlain_view_get_license_text (priv->view));
+ text = g_strdup (champlain_map_source_get_license (map_source));
clutter_text_set_text (CLUTTER_TEXT (priv->license_actor), text);
clutter_actor_get_size (priv->license_actor, &width, &height);
@@ -251,6 +263,15 @@ champlain_license_init (ChamplainLicense *license)
}
+/**
+ * champlain_license_new:
+ *
+ * Creates an instance of #ChamplainLicense.
+ *
+ * Returns: a new #ChamplainLicense.
+ *
+ * Since: 0.10
+ */
ClutterActor *
champlain_license_new (void)
{
@@ -360,6 +381,16 @@ redraw_license_cb (G_GNUC_UNUSED GObject *gobject,
}
+/**
+ * champlain_license_connect_view:
+ * @license: The license
+ * @view: a #ChamplainView
+ *
+ * This method connects to the necessary signals of #ChamplainView to make the
+ * license change automatically when the map source changes.
+ *
+ * Since: 0.10
+ */
void
champlain_license_connect_view (ChamplainLicense *license,
ChamplainView *view)
@@ -373,15 +404,36 @@ champlain_license_connect_view (ChamplainLicense *license,
redraw_license (license);
}
+
/**
- * champlain_view_set_extra_text:
- * @view: a #ChamplainView
+ * champlain_license_disconnect_view:
+ * @license: The license
+ *
+ * This method disconnects from the signals previously connected by champlain_license_connect_view().
+ *
+ * Since: 0.10
+ */
+void
+champlain_license_disconnect_view (ChamplainLicense *license)
+{
+ g_return_if_fail (CHAMPLAIN_IS_LICENSE (license));
+
+ g_signal_handlers_disconnect_by_func (license->priv->view,
+ redraw_license_cb,
+ license);
+ license->priv->view = NULL;
+}
+
+
+/**
+ * champlain_license_set_extra_text:
+ * @license: a #ChamplainLicense
* @text: a license
*
* Show the additional license text on the map view. The text will preceed the
* map's licence when displayed. Use "\n" to separate the lines.
*
- * Since: 0.4.3
+ * Since: 0.10
*/
void
champlain_license_set_extra_text (ChamplainLicense *license,
@@ -399,14 +451,14 @@ champlain_license_set_extra_text (ChamplainLicense *license,
}
/**
- * champlain_view_get_extra_text:
- * @view: The view
+ * champlain_license_get_extra_text:
+ * @license: a #ChamplainLicense
*
* Gets the additional license text.
*
* Returns: the additional license text
*
- * Since: 0.4.3
+ * Since: 0.10
*/
const gchar *
champlain_license_get_extra_text (ChamplainLicense *license)
diff --git a/champlain/champlain-license.h b/champlain/champlain-license.h
index 23a67e9..ad8d01d 100644
--- a/champlain/champlain-license.h
+++ b/champlain/champlain-license.h
@@ -76,6 +76,7 @@ const gchar *champlain_license_get_extra_text (ChamplainLicense *license);
void champlain_license_connect_view (ChamplainLicense *license,
ChamplainView *view);
+void champlain_license_disconnect_view (ChamplainLicense *license);
G_END_DECLS
diff --git a/champlain/champlain-map-source-desc.c b/champlain/champlain-map-source-desc.c
index 7a63b71..8874ba4 100644
--- a/champlain/champlain-map-source-desc.c
+++ b/champlain/champlain-map-source-desc.c
@@ -21,10 +21,9 @@
/**
* SECTION:champlain-map-source-desc
- * @short_description: A basic struct to describe map sources.
- *
- * A basic struct to describe map sources.
+ * @short_description: A class that describes map sources.
*
+ * A class that describes map sources.
*/
#include "champlain-map-source-desc.h"
@@ -247,6 +246,13 @@ champlain_map_source_desc_class_init (ChamplainMapSourceDescClass *klass)
object_class->get_property = champlain_map_source_desc_get_property;
object_class->set_property = champlain_map_source_desc_set_property;
+ /**
+ * ChamplainMapSourceDesc:id:
+ *
+ * The id of the map source
+ *
+ * Since: 0.10
+ */
g_object_class_install_property (object_class,
PROP_ID,
g_param_spec_string ("id",
@@ -255,6 +261,13 @@ champlain_map_source_desc_class_init (ChamplainMapSourceDescClass *klass)
"",
G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
+ /**
+ * ChamplainMapSourceDesc:name:
+ *
+ * The name of the map source
+ *
+ * Since: 0.10
+ */
g_object_class_install_property (object_class,
PROP_NAME,
g_param_spec_string ("name",
@@ -263,6 +276,13 @@ champlain_map_source_desc_class_init (ChamplainMapSourceDescClass *klass)
"",
G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
+ /**
+ * ChamplainMapSourceDesc:license:
+ *
+ * The license of the map source
+ *
+ * Since: 0.10
+ */
g_object_class_install_property (object_class,
PROP_LICENSE,
g_param_spec_string ("license",
@@ -271,6 +291,13 @@ champlain_map_source_desc_class_init (ChamplainMapSourceDescClass *klass)
"",
G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
+ /**
+ * ChamplainMapSourceDesc:license-uri:
+ *
+ * The license's uri for more information
+ *
+ * Since: 0.10
+ */
g_object_class_install_property (object_class,
PROP_LICENSE_URI,
g_param_spec_string ("license-uri",
@@ -279,6 +306,13 @@ champlain_map_source_desc_class_init (ChamplainMapSourceDescClass *klass)
"",
G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
+ /**
+ * ChamplainMapSourceDesc:uri-format:
+ *
+ * The URI format of a network map source
+ *
+ * Since: 0.10
+ */
g_object_class_install_property (object_class,
PROP_URI_FORMAT,
g_param_spec_string ("uri-format",
@@ -287,6 +321,13 @@ champlain_map_source_desc_class_init (ChamplainMapSourceDescClass *klass)
"",
G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
+ /**
+ * ChamplainMapSourceDesc:min-zoom-level:
+ *
+ * The minimum zoom level
+ *
+ * Since: 0.10
+ */
g_object_class_install_property (object_class,
PROP_MIN_ZOOM_LEVEL,
g_param_spec_uint ("min-zoom-level",
@@ -295,6 +336,13 @@ champlain_map_source_desc_class_init (ChamplainMapSourceDescClass *klass)
0, 20, 0,
G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
+ /**
+ * ChamplainMapSourceDesc:max-zoom-level:
+ *
+ * The maximum zoom level
+ *
+ * Since: 0.10
+ */
g_object_class_install_property (object_class,
PROP_MAX_ZOOM_LEVEL,
g_param_spec_uint ("max-zoom-level",
@@ -303,6 +351,13 @@ champlain_map_source_desc_class_init (ChamplainMapSourceDescClass *klass)
0, 20, 20,
G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
+ /**
+ * ChamplainMapSourceDesc:projection
+ *
+ * The map projection of the map source
+ *
+ * Since: 0.10
+ */
g_object_class_install_property (object_class,
PROP_PROJECTION,
g_param_spec_enum ("projection",
@@ -312,6 +367,13 @@ champlain_map_source_desc_class_init (ChamplainMapSourceDescClass *klass)
CHAMPLAIN_MAP_PROJECTION_MERCATOR,
G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
+ /**
+ * ChamplainMapSourceDesc:tile-size:
+ *
+ * The tile size of the map source
+ *
+ * Since: 0.10
+ */
g_object_class_install_property (object_class,
PROP_TILE_SIZE,
g_param_spec_uint ("tile-size",
@@ -322,6 +384,13 @@ champlain_map_source_desc_class_init (ChamplainMapSourceDescClass *klass)
256,
G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
+ /**
+ * ChamplainMapSourceDesc:constructor:
+ *
+ * The map source constructor
+ *
+ * Since: 0.10
+ */
g_object_class_install_property (object_class,
PROP_CONSTRUCTOR,
g_param_spec_pointer ("constructor",
@@ -329,6 +398,13 @@ champlain_map_source_desc_class_init (ChamplainMapSourceDescClass *klass)
"Map source constructor",
G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
+ /**
+ * ChamplainMapSourceDesc:data:
+ *
+ * User data passed to the constructor
+ *
+ * Since: 0.10
+ */
g_object_class_install_property (object_class,
PROP_DATA,
g_param_spec_pointer ("data",
@@ -360,14 +436,35 @@ champlain_map_source_desc_init (ChamplainMapSourceDesc *desc)
}
+/**
+ * champlain_map_source_desc_new_full:
+ * @id: the map source's id
+ * @name: the map source's name
+ * @license: the map source's license
+ * @license_uri: the map source's license URI
+ * @min_zoom: the map source's minimum zoom level
+ * @max_zoom: the map source's maximum zoom level
+ * @tile_size: the map source's tile size (in pixels)
+ * @projection: the map source's projection
+ * @uri_format: the URI to fetch the tiles from, see #champlain_network_tile_source_set_uri_format
+ * @constructor: the map source's constructor
+ * @data: user data passed to the constructor
+ *
+ * Constructor of #ChamplainMapSourceDesc which describes a #ChamplainMapSource.
+ * This is returned by #champlain_map_source_factory_get_registered
+ *
+ * Returns: a constructed #ChamplainMapSourceDesc object
+ *
+ * Since: 0.10
+ */
ChamplainMapSourceDesc *
champlain_map_source_desc_new_full (
gchar *id,
gchar *name,
gchar *license,
gchar *license_uri,
- guint min_zoom_level,
- guint max_zoom_level,
+ guint min_zoom,
+ guint max_zoom,
guint tile_size,
ChamplainMapProjection projection,
gchar *uri_format,
@@ -379,8 +476,8 @@ champlain_map_source_desc_new_full (
"name", name,
"license", license,
"license-uri", license_uri,
- "min-zoom-level", min_zoom_level,
- "max-zoom-level", max_zoom_level,
+ "min-zoom-level", min_zoom,
+ "max-zoom-level", max_zoom,
"tile-size", tile_size,
"projection", projection,
"uri-format", uri_format,
@@ -390,6 +487,16 @@ champlain_map_source_desc_new_full (
}
+/**
+ * champlain_map_source_desc_get_id:
+ * @desc: a #ChamplainMapSourceDesc
+ *
+ * Gets map source's id.
+ *
+ * Returns: the map source's id.
+ *
+ * Since: 0.10
+ */
const gchar *
champlain_map_source_desc_get_id (ChamplainMapSourceDesc *desc)
{
@@ -399,6 +506,16 @@ champlain_map_source_desc_get_id (ChamplainMapSourceDesc *desc)
}
+/**
+ * champlain_map_source_desc_get_name:
+ * @desc: a #ChamplainMapSourceDesc
+ *
+ * Gets map source's name.
+ *
+ * Returns: the map source's name.
+ *
+ * Since: 0.10
+ */
const gchar *
champlain_map_source_desc_get_name (ChamplainMapSourceDesc *desc)
{
@@ -408,6 +525,16 @@ champlain_map_source_desc_get_name (ChamplainMapSourceDesc *desc)
}
+/**
+ * champlain_map_source_desc_get_license:
+ * @desc: a #ChamplainMapSourceDesc
+ *
+ * Gets map source's license.
+ *
+ * Returns: the map source's license.
+ *
+ * Since: 0.10
+ */
const gchar *
champlain_map_source_desc_get_license (ChamplainMapSourceDesc *desc)
{
@@ -417,6 +544,16 @@ champlain_map_source_desc_get_license (ChamplainMapSourceDesc *desc)
}
+/**
+ * champlain_map_source_desc_get_license_uri:
+ * @desc: a #ChamplainMapSourceDesc
+ *
+ * Gets map source's license URI.
+ *
+ * Returns: the map source's license URI.
+ *
+ * Since: 0.10
+ */
const gchar *
champlain_map_source_desc_get_license_uri (ChamplainMapSourceDesc *desc)
{
@@ -426,6 +563,16 @@ champlain_map_source_desc_get_license_uri (ChamplainMapSourceDesc *desc)
}
+/**
+ * champlain_map_source_desc_get_uri_format:
+ * @desc: a #ChamplainMapSourceDesc
+ *
+ * Gets network map source's URI format.
+ *
+ * Returns: the URI format.
+ *
+ * Since: 0.10
+ */
const gchar *
champlain_map_source_desc_get_uri_format (ChamplainMapSourceDesc *desc)
{
@@ -435,6 +582,16 @@ champlain_map_source_desc_get_uri_format (ChamplainMapSourceDesc *desc)
}
+/**
+ * champlain_map_source_desc_get_min_zoom_level:
+ * @desc: a #ChamplainMapSourceDesc
+ *
+ * Gets map source's minimum zoom level.
+ *
+ * Returns: the miminum zoom level this map source supports
+ *
+ * Since: 0.10
+ */
guint
champlain_map_source_desc_get_min_zoom_level (ChamplainMapSourceDesc *desc)
{
@@ -444,6 +601,16 @@ champlain_map_source_desc_get_min_zoom_level (ChamplainMapSourceDesc *desc)
}
+/**
+ * champlain_map_source_desc_get_max_zoom_level:
+ * @desc: a #ChamplainMapSourceDesc
+ *
+ * Gets map source's maximum zoom level.
+ *
+ * Returns: the maximum zoom level this map source supports
+ *
+ * Since: 0.10
+ */
guint
champlain_map_source_desc_get_max_zoom_level (ChamplainMapSourceDesc *desc)
{
@@ -453,6 +620,16 @@ champlain_map_source_desc_get_max_zoom_level (ChamplainMapSourceDesc *desc)
}
+/**
+ * champlain_map_source_desc_get_tile_size:
+ * @desc: a #ChamplainMapSourceDesc
+ *
+ * Gets map source's tile size.
+ *
+ * Returns: the tile's size (width and height) in pixels for this map source
+ *
+ * Since: 0.10
+ */
guint
champlain_map_source_desc_get_tile_size (ChamplainMapSourceDesc *desc)
{
@@ -462,6 +639,16 @@ champlain_map_source_desc_get_tile_size (ChamplainMapSourceDesc *desc)
}
+/**
+ * champlain_map_source_desc_get_projection:
+ * @desc: a #ChamplainMapSourceDesc
+ *
+ * Gets map source's projection.
+ *
+ * Returns: the map source's projection.
+ *
+ * Since: 0.10
+ */
ChamplainMapProjection
champlain_map_source_desc_get_projection (ChamplainMapSourceDesc *desc)
{
@@ -471,6 +658,16 @@ champlain_map_source_desc_get_projection (ChamplainMapSourceDesc *desc)
}
+/**
+ * champlain_map_source_desc_get_data:
+ * @desc: a #ChamplainMapSourceDesc
+ *
+ * Gets user data.
+ *
+ * Returns: the user data.
+ *
+ * Since: 0.10
+ */
gpointer
champlain_map_source_desc_get_data (ChamplainMapSourceDesc *desc)
{
@@ -480,7 +677,18 @@ champlain_map_source_desc_get_data (ChamplainMapSourceDesc *desc)
}
-const ChamplainMapSourceConstructor champlain_map_source_desc_get_constructor (ChamplainMapSourceDesc *desc)
+/**
+ * champlain_map_source_desc_get_constructor:
+ * @desc: a #ChamplainMapSourceDesc
+ *
+ * Gets the map source constructor.
+ *
+ * Returns: the constructor.
+ *
+ * Since: 0.10
+ */
+const ChamplainMapSourceConstructor
+champlain_map_source_desc_get_constructor (ChamplainMapSourceDesc *desc)
{
g_return_val_if_fail (CHAMPLAIN_IS_MAP_SOURCE_DESC (desc), NULL);
diff --git a/champlain/champlain-map-source-desc.h b/champlain/champlain-map-source-desc.h
index 6f96a1a..e001007 100644
--- a/champlain/champlain-map-source-desc.h
+++ b/champlain/champlain-map-source-desc.h
@@ -62,51 +62,31 @@ struct _ChamplainMapSourceDescClass
GObjectClass parent_class;
};
-GType champlain_map_source_desc_get_type (void);
-
/**
* ChamplainMapSourceConstructor:
* @desc: a #ChamplainMapSourceDesc
- * @data: User data
*
* A #ChamplainMapSource constructor. It should return a ready to use
* #ChamplainMapSource.
*
* Returns: A fully constructed #ChamplainMapSource ready to be used.
*
- * Since: 0.4
+ * Since: 0.10
*/
typedef ChamplainMapSource * (*ChamplainMapSourceConstructor)
(ChamplainMapSourceDesc *desc);
#define CHAMPLAIN_MAP_SOURCE_CONSTRUCTOR (f) ((ChamplainMapSourceConstructor) (f))
+GType champlain_map_source_desc_get_type (void);
-
-/*
- * ChamplainMapSourceDesc:
- * @id: A unique identifier, should contain only characters found in filenames
- * @name: A display name
- * @license: A display name for the licence of the data
- * @license_uri: A URI for the licence of the data
- * @min_zoom_level: the minimum supported zoom level
- * @max_zoom_level: the maximum supported zoom level
- * @projection: the projection used by the data
- * @uri_format: the URI to use to fetch network map data
- * @constructor: a function that returns a fully constructed #ChamplainMapSource
- * @data: user data passed to the constructor
- *
- * Describes a #ChamplainMapSource. This is returned by #champlain_map_source_factory_get_list.
- *
- * Since: 0.4
- */
ChamplainMapSourceDesc *champlain_map_source_desc_new_full (
gchar *id,
gchar *name,
gchar *license,
gchar *license_uri,
- guint min_zoom_level,
- guint max_zoom_level,
+ guint min_zoom,
+ guint max_zoom,
guint tile_size,
ChamplainMapProjection projection,
gchar *uri_format,
diff --git a/champlain/champlain-map-source-factory.c b/champlain/champlain-map-source-factory.c
index 00ef48c..d3bc4fd 100644
--- a/champlain/champlain-map-source-factory.c
+++ b/champlain/champlain-map-source-factory.c
@@ -428,18 +428,15 @@ champlain_map_source_factory_create_error_source (ChamplainMapSourceFactory *fac
* champlain_map_source_factory_register:
* @factory: A #ChamplainMapSourceFactory
* @desc: the description of the map source
- * @constructor: (scope notified): the new map source constructor function
- * @data: data to be passed to the constructor function, or NULL
*
* Registers the new map source with the given constructor. When this map
* source is requested, the given constructor will be used to build the
* map source. #ChamplainMapSourceFactory will take ownership of the passed
- * #ChamplainMapSourceDesc, so don't free it. They will not be freed either so
- * you can use static structs here.
+ * #ChamplainMapSourceDesc, so don't free it.
*
* Returns: TRUE if the registration suceeded.
*
- * Since: 0.4
+ * Since: 0.10
*/
gboolean
champlain_map_source_factory_register (ChamplainMapSourceFactory *factory,
diff --git a/champlain/champlain-marker-layer.c b/champlain/champlain-marker-layer.c
index 30d7881..feee840 100644
--- a/champlain/champlain-marker-layer.c
+++ b/champlain/champlain-marker-layer.c
@@ -295,11 +295,11 @@ champlain_marker_layer_class_init (ChamplainMarkerLayerClass *klass)
CHAMPLAIN_PARAM_READWRITE));
/**
- * ChamplainPath:close-path:
+ * ChamplainMarkerLayer:close-path:
*
* The shape is a closed path
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class,
PROP_CLOSED_PATH,
@@ -309,11 +309,11 @@ champlain_marker_layer_class_init (ChamplainMarkerLayerClass *klass)
FALSE, CHAMPLAIN_PARAM_READWRITE));
/**
- * ChamplainPath:fill:
+ * ChamplainMarkerLayer:fill:
*
* The shape should be filled
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class,
PROP_FILL,
@@ -323,11 +323,11 @@ champlain_marker_layer_class_init (ChamplainMarkerLayerClass *klass)
FALSE, CHAMPLAIN_PARAM_READWRITE));
/**
- * ChamplainPath:stroke:
+ * ChamplainMarkerLayer:stroke:
*
* The shape should be stroked
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class,
PROP_STROKE,
@@ -337,11 +337,11 @@ champlain_marker_layer_class_init (ChamplainMarkerLayerClass *klass)
TRUE, CHAMPLAIN_PARAM_READWRITE));
/**
- * ChamplainPath:stroke-color:
+ * ChamplainMarkerLayer:stroke-color:
*
* The path's stroke color
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class,
PROP_STROKE_COLOR,
@@ -352,11 +352,11 @@ champlain_marker_layer_class_init (ChamplainMarkerLayerClass *klass)
CHAMPLAIN_PARAM_READWRITE));
/**
- * ChamplainPath:text-color:
+ * ChamplainMarkerLayer:fill-color:
*
* The path's fill color
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class,
PROP_FILL_COLOR,
@@ -367,11 +367,11 @@ champlain_marker_layer_class_init (ChamplainMarkerLayerClass *klass)
CHAMPLAIN_PARAM_READWRITE));
/**
- * ChamplainPath:stroke-width:
+ * ChamplainMarkerLayer:stroke-width:
*
* The path's stroke width (in pixels)
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class,
PROP_STROKE_WIDTH,
@@ -383,11 +383,11 @@ champlain_marker_layer_class_init (ChamplainMarkerLayerClass *klass)
CHAMPLAIN_PARAM_READWRITE));
/**
- * ChamplainPath:visible:
+ * ChamplainMarkerLayer:visible:
*
* Wether the path is visible
*
- * Since: 0.4
+ * Since: 0.10
*/
g_object_class_install_property (object_class,
PROP_VISIBLE,
@@ -435,9 +435,9 @@ champlain_marker_layer_init (ChamplainMarkerLayer *self)
*
* Creates a new instance of #ChamplainMarkerLayer.
*
- * Returns: a new #ChamplainMarkerLayer ready to be used as a #ClutterContainer for the markers.
+ * Returns: a new #ChamplainMarkerLayer ready to be used as a container for the markers.
*
- * Since: 0.2.2
+ * Since: 0.10
*/
ChamplainMarkerLayer *
champlain_marker_layer_new_full (ChamplainSelectionMode mode)
@@ -672,7 +672,7 @@ add_marker (ChamplainMarkerLayer *layer,
*
* Adds the marker to the layer.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_add_marker (ChamplainMarkerLayer *layer,
@@ -685,6 +685,14 @@ champlain_marker_layer_add_marker (ChamplainMarkerLayer *layer,
}
+/**
+ * champlain_marker_layer_remove_all:
+ * @layer: a #ChamplainMarkerLayer
+ *
+ * Removes all markers from the layer.
+ *
+ * Since: 0.10
+ */
void champlain_marker_layer_remove_all (ChamplainMarkerLayer *layer)
{
ChamplainMarkerLayerPrivate *priv = GET_PRIVATE (layer);
@@ -713,6 +721,16 @@ void champlain_marker_layer_remove_all (ChamplainMarkerLayer *layer)
}
+/**
+ * champlain_marker_layer_get_markers:
+ * @layer: a #ChamplainMarkerLayer
+ *
+ * Gets the list of all markers inserted into the layer.
+ *
+ * Returns: (transfer none) (element-type ChamplainMarker): the list
+ *
+ * Since: 0.10
+ */
GList *
champlain_marker_layer_get_markers (ChamplainMarkerLayer *layer)
{
@@ -729,7 +747,7 @@ champlain_marker_layer_get_markers (ChamplainMarkerLayer *layer)
*
* Removes the marker from the layer.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_remove_marker (ChamplainMarkerLayer *layer,
@@ -752,6 +770,16 @@ champlain_marker_layer_remove_marker (ChamplainMarkerLayer *layer,
}
+/**
+ * champlain_marker_layer_insert_marker:
+ * @layer: a #ChamplainMarkerLayer
+ * @marker: a #ChamplainMarker
+ * @position: position in the list where the marker should be inserted
+ *
+ * Inserts a marker to the specified position.
+ *
+ * Since: 0.10
+ */
void
champlain_marker_layer_insert_marker (ChamplainMarkerLayer *layer,
ChamplainMarker *marker,
@@ -769,7 +797,7 @@ champlain_marker_layer_insert_marker (ChamplainMarkerLayer *layer,
*
* Fade in all markers with an animation
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_animate_in_all_markers (ChamplainMarkerLayer *layer)
@@ -796,7 +824,7 @@ champlain_marker_layer_animate_in_all_markers (ChamplainMarkerLayer *layer)
*
* Fade out all markers with an animation
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_animate_out_all_markers (ChamplainMarkerLayer *layer)
@@ -824,7 +852,7 @@ champlain_marker_layer_animate_out_all_markers (ChamplainMarkerLayer *layer)
*
* Calls clutter_actor_show on all markers
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_show_all_markers (ChamplainMarkerLayer *layer)
@@ -848,7 +876,7 @@ champlain_marker_layer_show_all_markers (ChamplainMarkerLayer *layer)
*
* Calls clutter_actor_hide on all markers
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_hide_all_markers (ChamplainMarkerLayer *layer)
@@ -867,6 +895,14 @@ champlain_marker_layer_hide_all_markers (ChamplainMarkerLayer *layer)
}
+/**
+ * champlain_marker_layer_set_all_markers_movable:
+ * @layer: a #ChamplainMarkerLayer
+ *
+ * Sets all markers movable
+ *
+ * Since: 0.10
+ */
void
champlain_marker_layer_set_all_markers_movable (ChamplainMarkerLayer *layer)
{
@@ -884,6 +920,14 @@ champlain_marker_layer_set_all_markers_movable (ChamplainMarkerLayer *layer)
}
+/**
+ * champlain_marker_layer_set_all_markers_unmovable:
+ * @layer: a #ChamplainMarkerLayer
+ *
+ * Sets all markers unmovable
+ *
+ * Since: 0.10
+ */
void
champlain_marker_layer_set_all_markers_unmovable (ChamplainMarkerLayer *layer)
{
@@ -903,12 +947,12 @@ champlain_marker_layer_set_all_markers_unmovable (ChamplainMarkerLayer *layer)
/**
- * champlain_marker_layer_unselect_all:
+ * champlain_marker_layer_unselect_all_markers:
* @layer: a #ChamplainMarkerLayer
*
* Unselects all markers.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_unselect_all_markers (ChamplainMarkerLayer *layer)
@@ -920,13 +964,12 @@ champlain_marker_layer_unselect_all_markers (ChamplainMarkerLayer *layer)
/**
- * champlain_marker_layer_select_all:
+ * champlain_marker_layer_select_all_markers:
* @layer: a #ChamplainMarkerLayer
*
- * Selects all markers in the layer. This call will only work if the selection
- * mode is set CHAMPLAIN_SELETION_MULTIPLE.
+ * Selects all markers in the layer.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_select_all_markers (ChamplainMarkerLayer *layer)
@@ -947,7 +990,7 @@ champlain_marker_layer_select_all_markers (ChamplainMarkerLayer *layer)
* NOTE: changing selection mode to CHAMPLAIN_SELECTION_NONE or
* CHAMPLAIN_SELECTION_SINGLE will clear all previously selected markers.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_set_selection_mode (ChamplainMarkerLayer *layer,
@@ -978,7 +1021,7 @@ champlain_marker_layer_set_selection_mode (ChamplainMarkerLayer *layer,
*
* Returns: the selection mode of the layer.
*
- * Since: 0.4
+ * Since: 0.10
*/
ChamplainSelectionMode
champlain_marker_layer_get_selection_mode (ChamplainMarkerLayer *layer)
@@ -1132,17 +1175,16 @@ set_view (ChamplainLayer *layer,
}
/**
- * champlain_view_ensure_markers_visible:
- * @view: a #ChamplainView
- * @markers: (array zero-terminated=1): a NULL terminated array of #ChamplainMarker elements
- * @animate: a #gboolean
+ * champlain_marker_layer_get_bounding_box:
+ * @layer: a #ChamplainMarkerLayer
*
- * Changes the map's zoom level and center to make sure those markers are
- * visible.
+ * Gets the bounding box occupied by the markers in the layer
*
+ * Returns: The bounding box.
+ *
* FIXME: This doesn't take into account the marker's actor size yet
*
- * Since: 0.4
+ * Since: 0.10
*/
ChamplainBoundingBox *
champlain_marker_layer_get_bounding_box (ChamplainMarkerLayer *layer)
@@ -1183,14 +1225,14 @@ champlain_marker_layer_get_bounding_box (ChamplainMarkerLayer *layer)
/**
- * champlain_path_set_fill_color:
- * @path: The path
+ * champlain_marker_layer_set_path_fill_color:
+ * @layer: a #ChamplainMarkerLayer
* @color: (allow-none): The path's fill color or NULL to reset to the
* default color. The color parameter is copied.
*
* Set the path's fill color.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_set_path_fill_color (ChamplainMarkerLayer *layer,
@@ -1212,14 +1254,14 @@ champlain_marker_layer_set_path_fill_color (ChamplainMarkerLayer *layer,
/**
- * champlain_path_set_stroke_color:
- * @path: The path
+ * champlain_marker_layer_set_path_stroke_color:
+ * @layer: a #ChamplainMarkerLayer
* @color: (allow-none): The path's stroke color or NULL to reset to the
* default color. The color parameter is copied.
*
* Set the path's stroke color.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_set_path_stroke_color (ChamplainMarkerLayer *layer,
@@ -1241,14 +1283,14 @@ champlain_marker_layer_set_path_stroke_color (ChamplainMarkerLayer *layer,
/**
- * champlain_path_get_fill_color:
- * @path: The path
+ * champlain_marker_layer_get_path_fill_color:
+ * @layer: a #ChamplainMarkerLayer
*
* Gets the path's fill color.
*
* Returns: the path's fill color.
*
- * Since: 0.4
+ * Since: 0.10
*/
ClutterColor *
champlain_marker_layer_get_path_fill_color (ChamplainMarkerLayer *layer)
@@ -1260,14 +1302,14 @@ champlain_marker_layer_get_path_fill_color (ChamplainMarkerLayer *layer)
/**
- * champlain_path_get_stroke_color:
- * @path: The path
+ * champlain_marker_layer_get_path_stroke_color:
+ * @layer: a #ChamplainMarkerLayer
*
* Gets the path's stroke color.
*
* Returns: the path's stroke color.
*
- * Since: 0.4
+ * Since: 0.10
*/
ClutterColor *
champlain_marker_layer_get_path_stroke_color (ChamplainMarkerLayer *layer)
@@ -1279,13 +1321,13 @@ champlain_marker_layer_get_path_stroke_color (ChamplainMarkerLayer *layer)
/**
- * champlain_path_set_stroke:
- * @path: The path
+ * champlain_marker_layer_set_path_stroke:
+ * @layer: a #ChamplainMarkerLayer
* @value: if the path is stroked
*
- * Sets the path to have a stroke
+ * Sets the path to be stroked
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_set_path_stroke (ChamplainMarkerLayer *layer,
@@ -1299,14 +1341,14 @@ champlain_marker_layer_set_path_stroke (ChamplainMarkerLayer *layer,
/**
- * champlain_path_get_stroke:
- * @path: The path
+ * champlain_marker_layer_get_path_stroke:
+ * @layer: a #ChamplainMarkerLayer
*
- * Checks whether the path has a stroke.
+ * Checks whether the path is stroked.
*
- * Returns: TRUE if the path has a stroke, FALSE otherwise.
+ * Returns: TRUE if the path is stroked, FALSE otherwise.
*
- * Since: 0.4
+ * Since: 0.10
*/
gboolean
champlain_marker_layer_get_path_stroke (ChamplainMarkerLayer *layer)
@@ -1318,13 +1360,13 @@ champlain_marker_layer_get_path_stroke (ChamplainMarkerLayer *layer)
/**
- * champlain_path_set_fill:
- * @path: The path
+ * champlain_marker_layer_set_path_fill:
+ * @layer: a #ChamplainMarkerLayer
* @value: if the path is filled
*
- * Sets the path to have be filled
+ * Sets the path to be filled
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_set_path_fill (ChamplainMarkerLayer *layer,
@@ -1338,14 +1380,14 @@ champlain_marker_layer_set_path_fill (ChamplainMarkerLayer *layer,
/**
- * champlain_path_get_fill:
- * @path: The path
+ * champlain_marker_layer_get_path_fill:
+ * @layer: a #ChamplainMarkerLayer
*
* Checks whether the path is filled.
*
* Returns: TRUE if the path is filled, FALSE otherwise.
*
- * Since: 0.4
+ * Since: 0.10
*/
gboolean
champlain_marker_layer_get_path_fill (ChamplainMarkerLayer *layer)
@@ -1357,13 +1399,13 @@ champlain_marker_layer_get_path_fill (ChamplainMarkerLayer *layer)
/**
- * champlain_path_set_stroke_width:
- * @path: The path
+ * champlain_marker_layer_set_path_stroke_width:
+ * @layer: a #ChamplainMarkerLayer
* @value: the width of the stroke (in pixels)
*
* Sets the width of the stroke
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_set_path_stroke_width (ChamplainMarkerLayer *layer,
@@ -1377,14 +1419,14 @@ champlain_marker_layer_set_path_stroke_width (ChamplainMarkerLayer *layer,
/**
- * champlain_path_get_stroke_width:
- * @path: The path
+ * champlain_marker_layer_get_path_stroke_width:
+ * @layer: a #ChamplainMarkerLayer
*
* Gets the width of the stroke.
*
* Returns: the width of the stroke
*
- * Since: 0.4
+ * Since: 0.10
*/
gdouble
champlain_marker_layer_get_path_stroke_width (ChamplainMarkerLayer *layer)
@@ -1396,12 +1438,12 @@ champlain_marker_layer_get_path_stroke_width (ChamplainMarkerLayer *layer)
/**
- * champlain_path_show:
- * @path: The path
+ * champlain_marker_layer_show_path:
+ * @layer: a #ChamplainMarkerLayer
*
* Makes the path visible
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_show_path (ChamplainMarkerLayer *layer)
@@ -1415,12 +1457,12 @@ champlain_marker_layer_show_path (ChamplainMarkerLayer *layer)
/**
- * champlain_path_hide:
- * @path: The path
+ * champlain_marker_layer_hide_path:
+ * @layer: a #ChamplainMarkerLayer
*
* Hides the path
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_marker_layer_hide_path (ChamplainMarkerLayer *layer)
diff --git a/champlain/champlain-marker.c b/champlain/champlain-marker.c
index 2860f0a..71a43e2 100644
--- a/champlain/champlain-marker.c
+++ b/champlain/champlain-marker.c
@@ -262,6 +262,16 @@ champlain_marker_class_init (ChamplainMarkerClass *marker_class)
"The movable state of the marker",
FALSE, CHAMPLAIN_PARAM_READWRITE));
+ /**
+ * ChamplainMarker::moved:
+ * @dx: by how much the marker has been moved in the x direction
+ * @dy: by how much the marker has been moved in the y direction
+ *
+ * Emmitted when the marker is dragged by mouse. dx and dy specify by how much
+ * the marker has been dragged since last time.
+ *
+ * Since: 0.10
+ */
signals[MOVE_BY_SIGNAL] =
g_signal_new ("moved", G_OBJECT_CLASS_TYPE (object_class),
G_SIGNAL_RUN_LAST, 0, NULL, NULL,
diff --git a/champlain/champlain-point.c b/champlain/champlain-point.c
index e6c2889..8e05008 100644
--- a/champlain/champlain-point.c
+++ b/champlain/champlain-point.c
@@ -16,6 +16,14 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * SECTION:champlain-point
+ * @short_description: Simple point to mark a coordinate
+ *
+ * #ChamplainPoint is a simple variant of #ChamplainMarker. Contrary to
+ * #ChamplainLabel, it is not capable of labelling the point with text and
+ * only shows the location of the point as a circle on the map.
+ */
#include "config.h"
@@ -86,14 +94,14 @@ static void unmap (ClutterActor *self);
static void draw_point (ChamplainPoint *point);
+
/**
* champlain_point_set_selection_color:
- * @color: a #ClutterColor
+ * @color: The selection color.
*
- * Changes the selection color, this is to ensure a better integration with
- * the desktop, this is automatically done by GtkChamplainEmbed.
+ * Set the selection color.
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_point_set_selection_color (ClutterColor *color)
@@ -110,9 +118,9 @@ champlain_point_set_selection_color (ClutterColor *color)
*
* Gets the selection color.
*
- * Returns: the selection color. Should not be freed.
+ * Returns: the color.
*
- * Since: 0.4.1
+ * Since: 0.10
*/
const ClutterColor *
champlain_point_get_selection_color ()
@@ -121,7 +129,6 @@ champlain_point_get_selection_color ()
}
-
static void
champlain_point_get_property (GObject *object,
guint prop_id,
@@ -298,6 +305,15 @@ champlain_point_init (ChamplainPoint *point)
}
+/**
+ * champlain_point_new:
+ *
+ * Creates an instance of #ChamplainPoint with default size and color.
+ *
+ * Returns: a new #ChamplainPoint.
+ *
+ * Since: 0.10
+ */
ClutterActor *
champlain_point_new (void)
{
@@ -305,6 +321,17 @@ champlain_point_new (void)
}
+/**
+ * champlain_point_new_full:
+ * @size: Marker size
+ * @color: Marker color
+ *
+ * Creates an instance of #ChamplainPoint with the specified size and color.
+ *
+ * Returns: a new #ChamplainPoint.
+ *
+ * Since: 0.10
+ */
ClutterActor *
champlain_point_new_full (gdouble size,
const ClutterColor *color)
@@ -317,6 +344,7 @@ champlain_point_new_full (gdouble size,
return CLUTTER_ACTOR (point);
}
+
static void
paint (ClutterActor *self)
{
@@ -410,6 +438,15 @@ unmap (ClutterActor *self)
}
+/**
+ * champlain_point_set_size:
+ * @point: a #ChamplainPoint
+ * @size: The size of the point.
+ *
+ * Set the size of the point.
+ *
+ * Since: 0.10
+ */
void
champlain_point_set_size (ChamplainPoint *point,
gdouble size)
@@ -422,6 +459,16 @@ champlain_point_set_size (ChamplainPoint *point,
}
+/**
+ * champlain_point_get_size:
+ * @point: a #ChamplainPoint
+ *
+ * Gets the size of the point.
+ *
+ * Returns: the size.
+ *
+ * Since: 0.10
+ */
gdouble
champlain_point_get_size (ChamplainPoint *point)
{
@@ -431,6 +478,16 @@ champlain_point_get_size (ChamplainPoint *point)
}
+/**
+ * champlain_point_set_color:
+ * @point: a #ChamplainPoint
+ * @color: (allow-none): The color of the point or NULL to reset the background to the
+ * default color. The color parameter is copied.
+ *
+ * Set the color of the point.
+ *
+ * Since: 0.10
+ */
void
champlain_point_set_color (ChamplainPoint *point,
const ClutterColor *color)
@@ -451,6 +508,16 @@ champlain_point_set_color (ChamplainPoint *point,
}
+/**
+ * champlain_point_get_color:
+ * @point: a #ChamplainPoint
+ *
+ * Gets the color of the point.
+ *
+ * Returns: the color.
+ *
+ * Since: 0.10
+ */
ClutterColor *
champlain_point_get_color (ChamplainPoint *point)
{
diff --git a/champlain/champlain-scale.c b/champlain/champlain-scale.c
index 9cd5fb4..abc4521 100644
--- a/champlain/champlain-scale.c
+++ b/champlain/champlain-scale.c
@@ -16,6 +16,12 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * SECTION:champlain-scale
+ * @short_description: An actor displaying a scale.
+ *
+ * An actor displaying a scale.
+ */
#include "config.h"
@@ -112,7 +118,6 @@ champlain_scale_get_property (GObject *object,
}
-
static void
champlain_scale_set_property (GObject *object,
guint prop_id,
@@ -187,7 +192,7 @@ champlain_scale_class_init (ChamplainScaleClass *klass)
*
* The size of the map scale on screen in pixels.
*
- * Since: 0.4.3
+ * Since: 0.10
*/
g_object_class_install_property (object_class,
PROP_MAX_SCALE_WIDTH,
@@ -205,7 +210,7 @@ champlain_scale_class_init (ChamplainScaleClass *klass)
*
* The scale's units.
*
- * Since: 0.4.3
+ * Since: 0.10
*/
g_object_class_install_property (object_class,
PROP_SCALE_UNIT,
@@ -405,6 +410,15 @@ champlain_scale_init (ChamplainScale *scale)
}
+/**
+ * champlain_scale_new:
+ *
+ * Creates an instance of #ChamplainScale.
+ *
+ * Returns: a new #ChamplainScale.
+ *
+ * Since: 0.10
+ */
ClutterActor *
champlain_scale_new (void)
{
@@ -512,7 +526,7 @@ unmap (ClutterActor *self)
*
* Sets the maximum width of the scale on the screen in pixels
*
- * Since: 0.4.3
+ * Since: 0.10
*/
void
champlain_scale_set_max_width (ChamplainScale *scale,
@@ -533,7 +547,7 @@ champlain_scale_set_max_width (ChamplainScale *scale,
*
* Sets the scales unit.
*
- * Since: 0.4.3
+ * Since: 0.10
*/
void
champlain_scale_set_unit (ChamplainScale *scale,
@@ -554,7 +568,7 @@ champlain_scale_set_unit (ChamplainScale *scale,
*
* Returns: The max scale width in pixels.
*
- * Since: 0.4.3
+ * Since: 0.10
*/
guint
champlain_scale_get_max_width (ChamplainScale *scale)
@@ -573,7 +587,7 @@ champlain_scale_get_max_width (ChamplainScale *scale)
*
* Returns: The unit used by the scale
*
- * Since: 0.4.3
+ * Since: 0.10
*/
ChamplainUnit
champlain_scale_get_unit (ChamplainScale *scale)
@@ -593,6 +607,16 @@ redraw_scale_cb (G_GNUC_UNUSED GObject *gobject,
}
+/**
+ * champlain_scale_connect_view:
+ * @scale: The scale
+ * @view: a #ChamplainView
+ *
+ * This method connects to the necessary signals of #ChamplainView to make the
+ * scale adapt to the current latitude and longitude.
+ *
+ * Since: 0.10
+ */
void
champlain_scale_connect_view (ChamplainScale *scale,
ChamplainView *view)
@@ -604,3 +628,23 @@ champlain_scale_connect_view (ChamplainScale *scale,
G_CALLBACK (redraw_scale_cb), scale);
redraw_scale (scale);
}
+
+
+/**
+ * champlain_scale_disconnect_view:
+ * @scale: The scale
+ *
+ * This method disconnects from the signals previously connected by champlain_scale_connect_view().
+ *
+ * Since: 0.10
+ */
+void
+champlain_scale_disconnect_view (ChamplainScale *scale)
+{
+ g_return_if_fail (CHAMPLAIN_IS_SCALE (scale));
+
+ g_signal_handlers_disconnect_by_func (scale->priv->view,
+ redraw_scale_cb,
+ scale);
+ scale->priv->view = NULL;
+}
diff --git a/champlain/champlain-scale.h b/champlain/champlain-scale.h
index ae15946..bbec904 100644
--- a/champlain/champlain-scale.h
+++ b/champlain/champlain-scale.h
@@ -92,6 +92,7 @@ ChamplainUnit champlain_scale_get_unit (ChamplainScale *scale);
void champlain_scale_connect_view (ChamplainScale *scale,
ChamplainView *view);
+void champlain_scale_disconnect_view (ChamplainScale *scale);
G_END_DECLS
diff --git a/champlain/champlain-tile-source.c b/champlain/champlain-tile-source.c
index 3649179..f603892 100644
--- a/champlain/champlain-tile-source.c
+++ b/champlain/champlain-tile-source.c
@@ -246,7 +246,7 @@ champlain_tile_source_class_init (ChamplainTileSourceClass *klass)
/**
* ChamplainTileSource:id:
*
- * The name of the tile source
+ * The id of the tile source
*
* Since: 0.4
*/
diff --git a/champlain/champlain-tile.c b/champlain/champlain-tile.c
index 540a2a9..405b9f6 100644
--- a/champlain/champlain-tile.c
+++ b/champlain/champlain-tile.c
@@ -380,15 +380,17 @@ champlain_tile_class_init (ChamplainTileClass *klass)
FALSE,
G_PARAM_READWRITE));
- /*
+ /**
* ChamplainTile::render-complete:
* @self: a #ChamplainTile
- * @calback_data: a #ChamplainRenderCallbackData struct
+ * @data: the result of the rendering
+ * @size: size of data
+ * @error: TRUE if there was an error during rendering
*
* The #ChamplainTile::render-complete signal is emitted when rendering of the tile is
* completed by the renderer.
*
- * Since: 0.8
+ * Since: 0.10
*/
champlain_tile_signals[RENDER_COMPLETE] =
g_signal_new ("render-complete", G_OBJECT_CLASS_TYPE (object_class),
diff --git a/champlain/champlain-view.c b/champlain/champlain-view.c
index d0cb14f..7976825 100644
--- a/champlain/champlain-view.c
+++ b/champlain/champlain-view.c
@@ -879,6 +879,16 @@ champlain_view_class_init (ChamplainViewClass *champlainViewClass)
G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED, 0, NULL, NULL,
g_cclosure_marshal_VOID__OBJECT, G_TYPE_NONE, 0);
+ /**
+ * ChamplainView::layer-relocated:
+ *
+ * Indicates that the layers hav been "relocated". In practice this means that
+ * every layer should connect to this signal and redraw itself when the signal is
+ * emitted. Layer relocation happens when zooming in/out and when panning for more
+ * than MAX_INT pixels.
+ *
+ * Since: 0.10
+ */
signals[LAYER_RELOCATED] =
g_signal_new ("layer-relocated", G_OBJECT_CLASS_TYPE (object_class),
G_SIGNAL_RUN_LAST, 0, NULL, NULL,
@@ -1632,6 +1642,17 @@ champlain_view_remove_layer (ChamplainView *view,
}
+/**
+ * champlain_view_x_to_longitude:
+ * @view: a #ChamplainView
+ * @x: x coordinate of the view
+ *
+ * Converts the view's x coordinate to longitude.
+ *
+ * Returns: the longitude
+ *
+ * Since: 0.10
+ */
gdouble
champlain_view_x_to_longitude (ChamplainView *view,
gdouble x)
@@ -1651,6 +1672,17 @@ champlain_view_x_to_longitude (ChamplainView *view,
}
+/**
+ * champlain_view_y_to_latitude:
+ * @view: a #ChamplainView
+ * @y: y coordinate of the view
+ *
+ * Converts the view's y coordinate to latitude.
+ *
+ * Returns: the latitude
+ *
+ * Since: 0.10
+ */
gdouble
champlain_view_y_to_latitude (ChamplainView *view,
gdouble y)
@@ -1669,6 +1701,18 @@ champlain_view_y_to_latitude (ChamplainView *view,
return latitude;
}
+
+/**
+ * champlain_view_longitude_to_x:
+ * @view: a #ChamplainView
+ * @longitude: the longitude
+ *
+ * Converts the longitude to view's x coordinate.
+ *
+ * Returns: the x coordinate
+ *
+ * Since: 0.10
+ */
gdouble
champlain_view_longitude_to_x (ChamplainView *view,
gdouble longitude)
@@ -1688,6 +1732,17 @@ champlain_view_longitude_to_x (ChamplainView *view,
}
+/**
+ * champlain_view_latitude_to_y:
+ * @view: a #ChamplainView
+ * @latitude: the latitude
+ *
+ * Converts the latitude to view's y coordinate.
+ *
+ * Returns: the y coordinate
+ *
+ * Since: 0.10
+ */
gdouble
champlain_view_latitude_to_y (ChamplainView *view,
gdouble latitude)
@@ -1707,8 +1762,20 @@ champlain_view_latitude_to_y (ChamplainView *view,
}
+/**
+ * champlain_view_get_viewport_origin:
+ * @view: a #ChamplainView
+ * @x: (out): the x coordinate of the viewport
+ * @y: (out): the y coordinate of the viewport
+ *
+ * Gets the x and y coordinate of the viewport in respect to the layer origin.
+ *
+ * Since: 0.10
+ */
void
-champlain_view_get_viewport_origin (ChamplainView *view, gdouble *x, gdouble *y)
+champlain_view_get_viewport_origin (ChamplainView *view,
+ gdouble *x,
+ gdouble *y)
{
DEBUG_LOG ()
@@ -2110,12 +2177,13 @@ champlain_view_set_zoom_on_double_click (ChamplainView *view,
/**
* champlain_view_ensure_visible:
* @view: a #ChamplainView
- * @animate: a #gboolean
+ * @bbox: bounding box of the area that should be visible
+ * @animate: perform animation
*
- * Changes the map's zoom level and center to make sure the two given
- * positions are visible
+ * Changes the map's zoom level and center to make sure the two given area
+ * is visible
*
- * Since: 0.4
+ * Since: 0.10
*/
void
champlain_view_ensure_visible (ChamplainView *view,
@@ -2387,6 +2455,17 @@ champlain_view_get_zoom_on_double_click (ChamplainView *view)
}
+/**
+ * champlain_view_get_layout_manager:
+ * @view: The view
+ *
+ * Returns the #ClutterBinLayout manager. The manager can be used to align
+ * user provided actors on top of the map.
+ *
+ * Returns: the layout manager
+ *
+ * Since: 0.10
+ */
ClutterBinLayout *
champlain_view_get_layout_manager (ChamplainView *view)
{
@@ -2400,19 +2479,19 @@ champlain_view_get_layout_manager (ChamplainView *view)
}
-const gchar *
-champlain_view_get_license_text (ChamplainView *view)
-{
- DEBUG_LOG ()
-
- g_return_val_if_fail (CHAMPLAIN_IS_VIEW (view), FALSE);
-
- ChamplainViewPrivate *priv = view->priv;
-
- return champlain_map_source_get_license (priv->map_source);
-}
-
+/**
+ * champlain_view_get_license_actor:
+ * @view: The view
+ *
+ * Returns the #ChamplainLicense actor which is inserted by default into the
+ * layout manager. It can be manipulated using standard #ClutterActor methods
+ * (hidden and so on).
+ *
+ * Returns: the license actor
+ *
+ * Since: 0.10
+ */
ChamplainLicense *champlain_view_get_license_actor (ChamplainView *view)
{
DEBUG_LOG ()
diff --git a/champlain/champlain-view.h b/champlain/champlain-view.h
index 258e611..74c3191 100644
--- a/champlain/champlain-view.h
+++ b/champlain/champlain-view.h
@@ -116,7 +116,6 @@ ChamplainMapSource *champlain_view_get_map_source (ChamplainView *view);
gdouble champlain_view_get_decel_rate (ChamplainView *view);
gboolean champlain_view_get_kinetic_mode (ChamplainView *view);
gboolean champlain_view_get_keep_center_on_resize (ChamplainView *view);
-const gchar *champlain_view_get_license_text (ChamplainView *view);
gboolean champlain_view_get_zoom_on_double_click (ChamplainView *view);
void champlain_view_reload_tiles (ChamplainView *view);
diff --git a/docs/reference/libchamplain-docs.sgml b/docs/reference/libchamplain-docs.sgml
index e25eba1..41876ac 100644
--- a/docs/reference/libchamplain-docs.sgml
+++ b/docs/reference/libchamplain-docs.sgml
@@ -45,24 +45,25 @@
<xi:include href="xml/champlain-view.xml"/>
</part>
<part>
- <title>Layers, Markers and Polygons</title>
+ <title>Layers and Markers</title>
<chapter>
<title>Layers</title>
<xi:include href="xml/champlain-layer.xml"/>
- <xi:include href="xml/champlain-selection-layer.xml"/>
+ <xi:include href="xml/champlain-marker-layer.xml"/>
</chapter>
<chapter>
<title>Markers</title>
- <xi:include href="xml/champlain-base-marker.xml"/>
<xi:include href="xml/champlain-marker.xml"/>
- </chapter>
- <chapter>
- <title>Polygons</title>
- <xi:include href="xml/champlain-polygon.xml"/>
+ <xi:include href="xml/champlain-label.xml"/>
<xi:include href="xml/champlain-point.xml"/>
</chapter>
</part>
<part>
+ <title>Widgets</title>
+ <xi:include href="xml/champlain-license.xml"/>
+ <xi:include href="xml/champlain-scale.xml"/>
+ </part>
+ <part>
<title>Map Source API</title>
<xi:include href="xml/champlain-map-source.xml"/>
<chapter>
@@ -83,6 +84,7 @@
<title>Map Source Utilities</title>
<xi:include href="xml/champlain-map-source-chain.xml"/>
<xi:include href="xml/champlain-map-source-factory.xml"/>
+ <xi:include href="xml/champlain-map-source-desc.xml"/>
</chapter>
</part>
<part>
@@ -95,7 +97,6 @@
<part>
<title>Others</title>
<xi:include href="xml/champlain-tile.xml"/>
- <xi:include href="xml/champlain-map-source-desc.xml"/>
<xi:include href="xml/champlain-bounding-box.xml"/>
<xi:include href="xml/champlain-version.xml"/>
</part>
diff --git a/docs/reference/libchamplain-sections.txt b/docs/reference/libchamplain-sections.txt
index 32523ff..4b71b32 100644
--- a/docs/reference/libchamplain-sections.txt
+++ b/docs/reference/libchamplain-sections.txt
@@ -37,17 +37,55 @@ ChamplainMapSourcePrivate
</SECTION>
<SECTION>
-<FILE>champlain-map-source-desc</FILE>
-<TITLE>ChamplainMapSourceDesc</TITLE>
-ChamplainMapSourceDesc
-champlain_map_source_desc_copy
-champlain_map_source_desc_free
-champlain_map_source_desc_new
+<FILE>champlain-label</FILE>
+<TITLE>ChamplainLabel</TITLE>
+ChamplainLabel
+champlain_label_new
+champlain_label_new_with_text
+champlain_label_new_with_image
+champlain_label_new_from_file
+champlain_label_new_full
+champlain_label_set_text
+champlain_label_set_image
+champlain_label_set_use_markup
+champlain_label_set_alignment
+champlain_label_set_color
+champlain_label_set_text_color
+champlain_label_set_font_name
+champlain_label_set_wrap
+champlain_label_set_wrap_mode
+champlain_label_set_attributes
+champlain_label_set_single_line_mode
+champlain_label_set_ellipsize
+champlain_label_set_draw_background
+champlain_label_get_use_markup
+champlain_label_get_text
+champlain_label_get_image
+champlain_label_get_alignment
+champlain_label_get_color
+champlain_label_get_text_color
+champlain_label_get_font_name
+champlain_label_get_wrap
+champlain_label_get_wrap_mode
+champlain_label_get_ellipsize
+champlain_label_get_single_line_mode
+champlain_label_get_draw_background
+champlain_label_set_selection_color
+champlain_label_get_selection_color
+champlain_label_set_selection_text_color
+champlain_label_get_selection_text_color
+champlain_label_queue_redraw
<SUBSECTION Standard>
-champlain_map_source_desc_get_type
-CHAMPLAIN_MAP_SOURCE_DESC
-CHAMPLAIN_TYPE_MAP_SOURCE_DESC
-CHAMPLAIN_MAP_SOURCE_CONSTRUCTOR
+CHAMPLAIN_LABEL
+CHAMPLAIN_IS_LABEL
+CHAMPLAIN_TYPE_LABEL
+champlain_label_get_type
+CHAMPLAIN_LABEL_CLASS
+CHAMPLAIN_IS_LABEL_CLASS
+CHAMPLAIN_LABEL_GET_CLASS
+<SUBSECTION Private>
+ChamplainLabelClass
+ChamplainLabelPrivate
</SECTION>
<SECTION>
@@ -55,40 +93,19 @@ CHAMPLAIN_MAP_SOURCE_CONSTRUCTOR
<TITLE>ChamplainMarker</TITLE>
ChamplainMarker
champlain_marker_new
-champlain_marker_new_with_text
-champlain_marker_new_with_image
-champlain_marker_new_full
-champlain_marker_new_from_file
-champlain_marker_set_text
-champlain_marker_get_text
-champlain_marker_set_image
-champlain_marker_get_image
-champlain_marker_set_use_markup
-champlain_marker_get_use_markup
-champlain_marker_set_alignment
-champlain_marker_get_alignment
-champlain_marker_set_color
-champlain_marker_get_color
-champlain_marker_set_text_color
-champlain_marker_get_text_color
-champlain_marker_set_font_name
-champlain_marker_get_font_name
-champlain_marker_set_wrap
-champlain_marker_get_wrap
-champlain_marker_set_wrap_mode
-champlain_marker_get_wrap_mode
-champlain_marker_set_attributes
-champlain_marker_set_single_line_mode
-champlain_marker_get_single_line_mode
-champlain_marker_set_ellipsize
-champlain_marker_get_ellipsize
-champlain_marker_set_draw_background
-champlain_marker_get_draw_background
-champlain_marker_set_highlight_text_color
-champlain_marker_get_highlight_text_color
-champlain_marker_set_highlight_color
-champlain_marker_get_highlight_color
-champlain_marker_queue_redraw
+champlain_marker_set_position
+champlain_marker_get_latitude
+champlain_marker_get_longitude
+champlain_marker_set_selectable
+champlain_marker_get_selectable
+champlain_marker_set_movable
+champlain_marker_get_movable
+champlain_marker_set_selected
+champlain_marker_get_selected
+champlain_marker_animate_in
+champlain_marker_animate_in_with_delay
+champlain_marker_animate_out
+champlain_marker_animate_out_with_delay
<SUBSECTION Standard>
CHAMPLAIN_MARKER
CHAMPLAIN_IS_MARKER
@@ -103,37 +120,8 @@ ChamplainMarkerPrivate
</SECTION>
<SECTION>
-<FILE>champlain-base-marker</FILE>
-<TITLE>ChamplainBaseMarker</TITLE>
-ChamplainBaseMarker
-champlain_base_marker_new
-champlain_base_marker_set_position
-champlain_base_marker_get_latitude
-champlain_base_marker_get_longitude
-champlain_base_marker_animate_in
-champlain_base_marker_animate_in_with_delay
-champlain_base_marker_animate_out
-champlain_base_marker_animate_out_with_delay
-champlain_base_marker_set_highlighted
-champlain_base_marker_get_highlighted
-<SUBSECTION Standard>
-CHAMPLAIN_BASE_MARKER
-CHAMPLAIN_IS_BASE_MARKER
-CHAMPLAIN_TYPE_BASE_MARKER
-champlain_base_marker_get_type
-CHAMPLAIN_BASE_MARKER_CLASS
-CHAMPLAIN_IS_BASE_MARKER_CLASS
-CHAMPLAIN_BASE_MARKER_GET_CLASS
-<SUBSECTION Private>
-ChamplainBaseMarkerClass
-ChamplainBaseMarkerPrivate
-</SECTION>
-
-<SECTION>
<FILE>champlain-view</FILE>
<TITLE>ChamplainView</TITLE>
-ChamplainScrollMode
-ChamplainUnit
ChamplainView
champlain_view_new
champlain_view_center_on
@@ -141,42 +129,33 @@ champlain_view_go_to
champlain_view_stop_go_to
champlain_view_zoom_in
champlain_view_zoom_out
-champlain_view_ensure_visible
-champlain_view_ensure_markers_visible
+champlain_view_set_zoom_level
champlain_view_set_min_zoom_level
-champlain_view_get_min_zoom_level
champlain_view_set_max_zoom_level
-champlain_view_get_max_zoom_level
+champlain_view_ensure_visible
champlain_view_set_map_source
-champlain_view_get_map_source
-champlain_view_set_size
champlain_view_set_decel_rate
-champlain_view_get_decel_rate
-champlain_view_set_scroll_mode
-champlain_view_get_scroll_mode
+champlain_view_set_kinetic_mode
champlain_view_set_keep_center_on_resize
-champlain_view_get_keep_center_on_resize
-champlain_view_set_show_license
-champlain_view_get_show_license
-champlain_view_set_zoom_level
-champlain_view_get_zoom_level
champlain_view_set_zoom_on_double_click
-champlain_view_get_zoom_on_double_click
-champlain_view_set_license_text
-champlain_view_get_license_text
-champlain_view_set_max_scale_width
-champlain_view_get_max_scale_width
-champlain_view_set_scale_unit
-champlain_view_get_scale_unit
-champlain_view_set_show_scale
-champlain_view_get_show_scale
champlain_view_add_layer
champlain_view_remove_layer
-champlain_view_get_coords_from_event
-champlain_view_get_coords_at
-champlain_view_add_polygon
-champlain_view_remove_polygon
+champlain_view_get_zoom_level
+champlain_view_get_min_zoom_level
+champlain_view_get_max_zoom_level
+champlain_view_get_map_source
+champlain_view_get_decel_rate
+champlain_view_get_kinetic_mode
+champlain_view_get_keep_center_on_resize
+champlain_view_get_zoom_on_double_click
champlain_view_reload_tiles
+champlain_view_x_to_longitude
+champlain_view_y_to_latitude
+champlain_view_longitude_to_x
+champlain_view_latitude_to_y
+champlain_view_get_viewport_origin
+champlain_view_get_layout_manager
+champlain_view_get_license_actor
<SUBSECTION Standard>
CHAMPLAIN_VIEW
CHAMPLAIN_IS_VIEW
@@ -186,8 +165,8 @@ CHAMPLAIN_VIEW_CLASS
CHAMPLAIN_IS_VIEW_CLASS
CHAMPLAIN_VIEW_GET_CLASS
<SUBSECTION Private>
-ChamplainViewClass
ChamplainViewPrivate
+ChamplainViewClass
</SECTION>
<SECTION>
@@ -275,7 +254,6 @@ ChamplainNullTileSourcePrivate
<SECTION>
<FILE>champlain-tile</FILE>
<TITLE>ChamplainTile</TITLE>
-ChamplainRenderCallbackData
ChamplainState
ChamplainTile
champlain_tile_new
@@ -316,15 +294,7 @@ ChamplainTilePrivate
<FILE>champlain-layer</FILE>
<TITLE>ChamplainLayer</TITLE>
ChamplainLayer
-champlain_layer_new
-champlain_layer_add_marker
-champlain_layer_remove_marker
-champlain_layer_animate_in_all_markers
-champlain_layer_animate_out_all_markers
-champlain_layer_show
-champlain_layer_hide
-champlain_layer_show_all_markers
-champlain_layer_hide_all_markers
+champlain_layer_set_view
<SUBSECTION Standard>
CHAMPLAIN_LAYER
CHAMPLAIN_IS_LAYER
@@ -338,6 +308,53 @@ ChamplainLayerClass
</SECTION>
<SECTION>
+<FILE>champlain-marker-layer</FILE>
+<TITLE>ChamplainMarkerLayer</TITLE>
+ChamplainMarkerLayer
+ChamplainSelectionMode
+champlain_marker_layer_new_full
+champlain_marker_layer_add_marker
+champlain_marker_layer_remove_marker
+champlain_marker_layer_remove_all
+champlain_marker_layer_insert_marker
+champlain_marker_layer_get_markers
+champlain_marker_layer_animate_in_all_markers
+champlain_marker_layer_animate_out_all_markers
+champlain_marker_layer_show_all_markers
+champlain_marker_layer_hide_all_markers
+champlain_marker_layer_set_all_markers_movable
+champlain_marker_layer_set_all_markers_unmovable
+champlain_marker_layer_select_all_markers
+champlain_marker_layer_unselect_all_markers
+champlain_marker_layer_set_selection_mode
+champlain_marker_layer_get_selection_mode
+champlain_marker_layer_get_bounding_box
+champlain_marker_layer_get_path_fill_color
+champlain_marker_layer_set_path_fill_color
+champlain_marker_layer_get_path_stroke_color
+champlain_marker_layer_set_path_stroke_color
+champlain_marker_layer_get_path_fill
+champlain_marker_layer_set_path_fill
+champlain_marker_layer_get_path_stroke
+champlain_marker_layer_set_path_stroke
+champlain_marker_layer_get_path_stroke_width
+champlain_marker_layer_set_path_stroke_width
+champlain_marker_layer_show_path
+champlain_marker_layer_hide_path
+<SUBSECTION Standard>
+CHAMPLAIN_MARKER_LAYER
+CHAMPLAIN_IS_MARKER_LAYER
+CHAMPLAIN_TYPE_MARKER_LAYER
+champlain_marker_layer_get_type
+CHAMPLAIN_MARKER_LAYER_CLASS
+CHAMPLAIN_IS_MARKER_LAYER_CLASS
+CHAMPLAIN_MARKER_LAYER_GET_CLASS
+<SUBSECTION Private>
+ChamplainMarkerLayerClass
+ChamplainMarkerLayerPrivate
+</SECTION>
+
+<SECTION>
<FILE>champlain-version</FILE>
<TITLE>ChamplainVersion</TITLE>
CHAMPLAIN_MAJOR_VERSION
@@ -354,12 +371,49 @@ CHAMPLAIN_CHECK_VERSION
<TITLE>ChamplainPoint</TITLE>
ChamplainPoint
champlain_point_new
-champlain_point_copy
-champlain_point_free
+champlain_point_new_full
+champlain_point_set_color
+champlain_point_get_color
+champlain_point_set_size
+champlain_point_get_size
+champlain_point_set_selection_color
+champlain_point_get_selection_color
<SUBSECTION Standard>
CHAMPLAIN_POINT
+CHAMPLAIN_IS_POINT
CHAMPLAIN_TYPE_POINT
champlain_point_get_type
+CHAMPLAIN_POINT_CLASS
+CHAMPLAIN_IS_POINT_CLASS
+CHAMPLAIN_POINT_GET_CLASS
+<SUBSECTION Private>
+ChamplainPointClass
+ChamplainPointPrivate
+</SECTION>
+
+<SECTION>
+<FILE>champlain-scale</FILE>
+<TITLE>ChamplainScale</TITLE>
+ChamplainScale
+ChamplainUnit
+champlain_scale_new
+champlain_scale_set_max_width
+champlain_scale_set_unit
+champlain_scale_get_max_width
+champlain_scale_get_unit
+champlain_scale_connect_view
+champlain_scale_disconnect_view
+<SUBSECTION Standard>
+CHAMPLAIN_SCALE
+CHAMPLAIN_IS_SCALE
+CHAMPLAIN_TYPE_SCALE
+champlain_scale_get_type
+CHAMPLAIN_SCALE_CLASS
+CHAMPLAIN_IS_SCALE_CLASS
+CHAMPLAIN_SCALE_GET_CLASS
+<SUBSECTION Private>
+ChamplainScaleClass
+ChamplainScalePrivate
</SECTION>
<SECTION>
@@ -387,15 +441,16 @@ ChamplainTileCachePrivate
<TITLE>ChamplainMapSourceFactory</TITLE>
ChamplainMapSourceFactory
champlain_map_source_factory_dup_default
-champlain_map_source_factory_dup_list
champlain_map_source_factory_create
champlain_map_source_factory_create_cached_source
champlain_map_source_factory_create_error_source
champlain_map_source_factory_register
+champlain_map_source_factory_get_registered
CHAMPLAIN_MAP_SOURCE_OSM_MAPNIK
CHAMPLAIN_MAP_SOURCE_OSM_OSMARENDER
CHAMPLAIN_MAP_SOURCE_OSM_CYCLE_MAP
CHAMPLAIN_MAP_SOURCE_OSM_TRANSPORT_MAP
+CHAMPLAIN_MAP_SOURCE_OSM_MAPQUEST
CHAMPLAIN_MAP_SOURCE_OAM
CHAMPLAIN_MAP_SOURCE_MFF_RELIEF
CHAMPLAIN_MAP_SOURCE_MEMPHIS_LOCAL
@@ -414,73 +469,6 @@ ChamplainMapSourceFactoryPrivate
</SECTION>
<SECTION>
-<FILE>champlain-polygon</FILE>
-<TITLE>ChamplainPolygon</TITLE>
-ChamplainPolygon
-champlain_polygon_new
-champlain_polygon_insert_point
-champlain_polygon_append_point
-champlain_polygon_remove_point
-champlain_polygon_clear_points
-champlain_polygon_get_fill
-champlain_polygon_get_fill_color
-champlain_polygon_get_mark_points
-champlain_polygon_get_points
-champlain_polygon_get_stroke
-champlain_polygon_get_stroke_color
-champlain_polygon_get_stroke_width
-champlain_polygon_set_fill
-champlain_polygon_set_fill_color
-champlain_polygon_set_mark_points
-champlain_polygon_set_stroke
-champlain_polygon_set_stroke_color
-champlain_polygon_set_stroke_width
-champlain_polygon_show
-champlain_polygon_hide
-<SUBSECTION Standard>
-CHAMPLAIN_POLYGON
-CHAMPLAIN_IS_POLYGON
-CHAMPLAIN_TYPE_POLYGON
-champlain_polygon_get_type
-CHAMPLAIN_POLYGON_CLASS
-CHAMPLAIN_IS_POLYGON_CLASS
-CHAMPLAIN_POLYGON_GET_CLASS
-<SUBSECTION Private>
-ChamplainPolygonClass
-ChamplainPolygonPrivate
-champlain_polygon_draw_polygon
-</SECTION>
-
-<SECTION>
-<FILE>champlain-selection-layer</FILE>
-<TITLE>ChamplainSelectionLayer</TITLE>
-ChamplainSelectionMode
-ChamplainSelectionLayer
-champlain_selection_layer_new
-champlain_selection_layer_set_selection_mode
-champlain_selection_layer_get_selection_mode
-champlain_selection_layer_select
-champlain_selection_layer_unselect
-champlain_selection_layer_select_all
-champlain_selection_layer_unselect_all
-champlain_selection_layer_marker_is_selected
-champlain_selection_layer_get_selected
-champlain_selection_layer_get_selected_markers
-champlain_selection_layer_count_selected_markers
-<SUBSECTION Standard>
-CHAMPLAIN_IS_SELECTION_LAYER
-CHAMPLAIN_IS_SELECTION_LAYER_CLASS
-CHAMPLAIN_SELECTION_LAYER
-CHAMPLAIN_SELECTION_LAYER_CLASS
-CHAMPLAIN_SELECTION_LAYER_GET_CLASS
-CHAMPLAIN_TYPE_SELECTION_LAYER
-champlain_selection_layer_get_type
-<SUBSECTION Private>
-ChamplainSelectionLayerClass
-ChamplainSelectionLayerPrivate
-</SECTION>
-
-<SECTION>
<FILE>champlain-bounding-box</FILE>
<TITLE>ChamplainBoundingBox</TITLE>
ChamplainBoundingBox
@@ -515,6 +503,28 @@ ChamplainMapSourceChainPrivate
</SECTION>
<SECTION>
+<FILE>champlain-license</FILE>
+<TITLE>ChamplainLicense</TITLE>
+ChamplainLicense
+champlain_license_new
+champlain_license_set_extra_text
+champlain_license_get_extra_text
+champlain_license_connect_view
+champlain_license_disconnect_view
+<SUBSECTION Standard>
+CHAMPLAIN_LICENSE
+CHAMPLAIN_IS_LICENSE
+CHAMPLAIN_TYPE_LICENSE
+champlain_license_get_type
+CHAMPLAIN_LICENSE_CLASS
+CHAMPLAIN_IS_LICENSE_CLASS
+CHAMPLAIN_LICENSE_GET_CLASS
+<SUBSECTION Private>
+ChamplainLicenseClass
+ChamplainLicensePrivate
+</SECTION>
+
+<SECTION>
<FILE>champlain-tile-source</FILE>
<TITLE>ChamplainTileSource</TITLE>
ChamplainTileSource
@@ -642,6 +652,36 @@ ChamplainImageRendererPrivate
</SECTION>
<SECTION>
+<FILE>champlain-map-source-desc</FILE>
+<TITLE>ChamplainMapSourceDesc</TITLE>
+ChamplainMapSourceDesc
+CHAMPLAIN_MAP_SOURCE_CONSTRUCTOR
+champlain_map_source_desc_new_full
+champlain_map_source_desc_get_id
+champlain_map_source_desc_get_name
+champlain_map_source_desc_get_license
+champlain_map_source_desc_get_license_uri
+champlain_map_source_desc_get_uri_format
+champlain_map_source_desc_get_min_zoom_level
+champlain_map_source_desc_get_max_zoom_level
+champlain_map_source_desc_get_tile_size
+champlain_map_source_desc_get_projection
+champlain_map_source_desc_get_data
+champlain_map_source_desc_get_constructor
+<SUBSECTION Standard>
+CHAMPLAIN_MAP_SOURCE_DESC
+CHAMPLAIN_IS_MAP_SOURCE_DESC
+CHAMPLAIN_TYPE_MAP_SOURCE_DESC
+champlain_map_source_desc_get_type
+CHAMPLAIN_MAP_SOURCE_DESC_CLASS
+CHAMPLAIN_IS_MAP_SOURCE_DESC_CLASS
+CHAMPLAIN_MAP_SOURCE_DESC_GET_CLASS
+<SUBSECTION Private>
+ChamplainMapSourceDescClass
+ChamplainMapSourceDescPrivate
+</SECTION>
+
+<SECTION>
<FILE>champlain-memphis-renderer</FILE>
<TITLE>ChamplainMemphisRenderer</TITLE>
ChamplainMemphisRenderer
@@ -671,3 +711,5 @@ CHAMPLAIN_MEMPHIS_RENDERER_GET_CLASS
ChamplainMemphisRendererClass
ChamplainMemphisRendererPrivate
</SECTION>
+
+
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
