* Get rid of black lines between tiles at high zoom levels
(Pierre-Luc Beaudoin)
* Fix polygon not visible at higher zoom levels (Pierre-Luc Beaudoin)
-* 594963: Initial scrolling results in map being in Antarctica (Pierre-Luc Beaudoin)
+* 594963: Initial scrolling results in map being in Antarctica
+ (Pierre-Luc Beaudoin)
* Make default selection mode in ChamplainSelectionMode single to match Gtk+
(Pierre-Luc Beaudoin)
+* Remove deprecated symbols introduced in 0.3 and removed in 0.3
+ (Pierre-Luc Beaudoin)
libchamplain 0.3.92 (2009-09-03)
===============================
/**
* champlain_base_marker_new:
*
- * Returns a new #ChamplainBaseMarker ready to be used as a #ClutterActor.
+ * Returns: a new #ChamplainBaseMarker ready to be used as a #ClutterActor.
*
* Since: 0.4
*/
* champlain_base_marker_get_highlighted:
* @marker: a #ChamplainBaseMarker
*
- * Returns the highlighted or not state of the marker.
+ * Returns: the highlighted or not state of the marker.
*
* Since: 0.4
*/
/**
* champlain_cache_dup_default:
*
- * Returns the #ChamplainCache singleton, use #g_object_unref when not neeeded
+ * Returns: the #ChamplainCache singleton, use #g_object_unref when not neeeded
* anymore.
*
*
return g_object_new (CHAMPLAIN_TYPE_CACHE, NULL);
}
-ChamplainCache*
-champlain_cache_get_default (void)
-{
- return champlain_cache_dup_default ();
-}
-
/**
* champlain_cache_get_size_limit:
* @self: the #ChamplainCache
*
- * Returns the cache size limit in bytes
+ * Returns: the cache size limit in bytes
*
* Since: 0.4
*/
*
* Loads data from disk for the given tile
*
- * Returns TRUE if the tile was in cache, false if it needs to be
+ * Returns: TRUE if the tile was in cache, false if it needs to be
* loaded from network
*
* Since: 0.4
* @self: the #ChamplainCache
* @tile: the #ChamplainTile to fill
*
- * Returns TRUE if the tile should be
- * reloaded from network
+ * Returns: TRUE if the tile should be reloaded from network, FALSE otherwize.
*
* Since: 0.4
*/
GType champlain_cache_get_type (void);
ChamplainCache* champlain_cache_dup_default (void);
-ChamplainCache* champlain_cache_get_default (void) G_GNUC_DEPRECATED;
void champlain_cache_update_tile (ChamplainCache *self,
ChamplainTile *tile,
/**
* champlain_layer_new:
*
- * Returns a new #ChamplainLayer ready to be used as a #ClutterContainer for the markers.
+ * Returns: a new #ChamplainLayer ready to be used as a #ClutterContainer for the markers.
*
* Since: 0.2.2
*/
/**
* champlain_map_source_desc_new:
- * @lat: the latitude
- * @lon: the longitude
*
- * Return value: a newly allocated #ChamplainMapSourceDesc to be freed with #champlain_map_source_desc_free
+ * Returns: a newly allocated #ChamplainMapSourceDesc to be freed with #champlain_map_source_desc_free
*
* Since: 0.4
*/
/**
* 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
*/
typedef ChamplainMapSource * (*ChamplainMapSourceConstructor) (
/**
* 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.
*
/**
* champlain_map_source_factory_dup_default:
*
- * Returns the singleton #ChamplainMapSourceFactory, it should be freed
+ * Returns: the singleton #ChamplainMapSourceFactory, it should be freed
* using #g_object_unref when not needed.
*
* Since: 0.4
return g_object_new (CHAMPLAIN_TYPE_MAP_SOURCE_FACTORY, NULL);
}
-ChamplainMapSourceFactory *
-champlain_map_source_factory_get_default (void)
-{
- return champlain_map_source_factory_dup_default ();
-}
-
/**
* champlain_map_source_factory_dup_list:
*
- * Returns the list of registered map sources, the items should not be freed,
+ * Returns: the list of registered map sources, the items should not be freed,
* the list should be freed with #g_slist_free.
*
* Since: 0.4
return g_slist_copy (factory->priv->registered_sources);
}
-GSList *
-champlain_map_source_factory_get_list (ChamplainMapSourceFactory *factory)
-{
- return champlain_map_source_factory_dup_list (factory);
-}
-
/**
* champlain_map_source_factory_create:
* @factory: the Factory
* @id: the wanted map source id
*
- * Returns a ready to use #ChamplainMapSource matching the given name, returns
+ * Returns: a ready to use #ChamplainMapSource matching the given name, returns
* NULL is none match.
*
* The id should not contain any character that can't be in a filename as it
/**
* champlain_map_source_factory_register:
+ * @factory: A #ChamplainMapSourceFactory
* @desc: the description of the map source
* @constructor: the new map source constructor function
* @data: data to be passed to the constructor function, or NULL
* #ChamplainMapSourceDesc, so don't free it. They will not be freed either so
* you can use static structs here.
*
- * Returns TRUE if the registration suceeded.
+ * Returns: TRUE if the registration suceeded.
*
* Since: 0.4
*/
GType champlain_map_source_factory_get_type (void);
ChamplainMapSourceFactory * champlain_map_source_factory_dup_default (void);
-ChamplainMapSourceFactory * champlain_map_source_factory_get_default (void) G_GNUC_DEPRECATED;
GSList * champlain_map_source_factory_dup_list (ChamplainMapSourceFactory *factory);
-GSList * champlain_map_source_factory_get_list (ChamplainMapSourceFactory *factory) G_GNUC_DEPRECATED;
ChamplainMapSource * champlain_map_source_factory_create (ChamplainMapSourceFactory *factory,
const gchar *id);
gboolean
champlain_map_source_factory_register (ChamplainMapSourceFactory *factory,
ChamplainMapSourceDesc *desc, ChamplainMapSourceConstructor constructor,
- gpointer user_data);
+ gpointer data);
#define CHAMPLAIN_MAP_SOURCE_OSM_MAPNIK "osm-mapnik"
#define CHAMPLAIN_MAP_SOURCE_OSM_OSMARENDER "osm-osmarender"
* champlain_map_source_get_max_zoom_level:
* @map_source: a #ChamplainMapSource
*
- * Returns the maximum zoom level this map source supports
+ * Returns: the maximum zoom level this map source supports
*
* Since: 0.4
*/
* champlain_map_source_get_min_zoom_level:
* @map_source: a #ChamplainMapSource
*
- * Returns the miminum zoom level this map source supports
+ * Returns: the miminum zoom level this map source supports
*
* Since: 0.4
*/
* champlain_map_source_get_tile_size:
* @map_source: a #ChamplainMapSource
*
- * Returns the tile's size (width and height) in pixels for this map source
+ * Returns: the tile's size (width and height) in pixels for this map source
*
* Since: 0.4
*/
* @zoom_level: the zoom level
* @longitude: a longitude
*
- * Returns the x position on the map using this map source's projection.
+ * Returns: the x position on the map using this map source's projection.
* (0, 0) is located at the top left.
*
* Since: 0.4
* @zoom_level: the zoom level
* @latitude: a latitude
*
- * Returns the y position on the map using this map source's projection.
+ * Returns: the y position on the map using this map source's projection.
* (0, 0) is located at the top left.
*
* Since: 0.4
* @map_source: a #ChamplainMapSource
* @zoom_level: the zoom level
*
- * Returns the number of tiles in a row at this zoom level for this map source.
+ * Returns: the number of tiles in a row at this zoom level for this map source.
*
* Since: 0.4
*/
* @map_source: a #ChamplainMapSource
* @zoom_level: the zoom level
*
- * Returns the number of tiles in a column at this zoom level for this map
+ * Returns: the number of tiles in a column at this zoom level for this map
* source.
*
* Since: 0.4
* @zoom_level: the zoom level
* @x: a x position
*
- * Returns the longitude corresponding to this x position in the map source's
+ * Returns: the longitude corresponding to this x position in the map source's
* projection.
*
* Since: 0.4
* @zoom_level: the zoom level
* @y: a y position
*
- * Returns the latitude corresponding to this y position in the map source's
+ * Returns: the latitude corresponding to this y position in the map source's
* projection.
*
* Since: 0.4
* champlain_map_source_get_name:
* @map_source: a #ChamplainMapSource
*
- * Returns the map source's name.
+ * Returns: the map source's name.
*
* Since: 0.4
*/
* champlain_map_source_get_license:
* @map_source: a #ChamplainMapSource
*
- * Returns the map source's license.
+ * Returns: the map source's license.
*
* Since: 0.4
*/
* champlain_map_source_get_license_uri:
* @map_source: a #ChamplainMapSource
*
- * Returns the map source's license URI.
+ * Returns: the map source's license URI.
*
* Since: 0.4
*/
* champlain_map_source_get_projection:
* @map_source: a #ChamplainMapSource
*
- * Returns the map source's projection.
+ * Returns: the map source's projection.
*
* Since: 0.4
*/
* champlain_map_source_get_id:
* @map_source: a #ChamplainMapSource
*
- * Returns the map source's id.
+ * Returns: the map source's id.
*
* Since: 0.4
*/
* champlain_marker_set_hightlight_color:
* @color: a #ClutterColor
*
+ *
* Changes the highlight color, this is to ensure a better integration with
* the desktop, this is automatically done by GtkChamplainEmbed.
*
- * Since: 0.2
+ * Since: 0.4
*/
void
champlain_marker_set_highlight_color (ClutterColor *color)
/**
* champlain_marker_new:
*
- * Returns a new #ChamplainMarker ready to be used as a #ClutterActor.
+ * Returns: a new #ChamplainMarker ready to be used as a #ClutterActor.
*
* Since: 0.2
*/
* @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 #ChamplainMarker with a drawn marker containing the given text.
+ * Returns: a new #ChamplainMarker with a drawn marker containing the given text.
*
* Since: 0.2
*/
* champlain_marker_new_with_image:
* @actor: The actor of the image.
*
- * Returns a new #ChamplainMarker with a drawn marker containing the given
+ * Returns: a new #ChamplainMarker with a drawn marker containing the given
* image.
*
* Since: 0.4
* @filename: The filename of the image.
* @error: Return location for an error.
*
- * Returns a new #ChamplainMarker with a drawn marker containing the given
+ * Returns: a new #ChamplainMarker with a drawn marker containing the given
* image.
*
* Since: 0.4
* @text: The text
* @actor: The image
*
- * Returns a new #ChamplainMarker with a drawn marker containing the given
+ * Returns: a new #ChamplainMarker with a drawn marker containing the given
* image.
*
* Since: 0.4
* champlain_marker_get_image:
* @marker: The marker
*
- * Returns the marker's image.
+ * Returns: the marker's image.
*
* Since: 0.4
*/
* champlain_marker_get_use_markup:
* @marker: The marker
*
- * Returns if the marker's text contains markup.
+ * Returns: if the marker's text contains markup.
*
* Since: 0.4
*/
* champlain_marker_get_text:
* @marker: The marker
*
- * Returns the marker's text.
+ * Returns: the marker's text.
*
* Since: 0.4
*/
* champlain_marker_get_alignment:
* @marker: The marker
*
- * Returns the marker's text alignment.
+ * Returns: the marker's text alignment.
*
* Since: 0.4
*/
* champlain_marker_get_color:
* @marker: The marker
*
- * Returns the marker's color.
+ * Returns: the marker's color.
*
* Since: 0.4
*/
* champlain_marker_get_text_color:
* @marker: The marker
*
- * Returns the marker's text color.
+ * Returns: the marker's text color.
*
* Since: 0.4
*/
* champlain_marker_get_font_name:
* @marker: The marker
*
- * Returns the marker's font name.
+ * Returns: the marker's font name.
*
* Since: 0.4
*/
* champlain_marker_get_wrap:
* @marker: The marker
*
- * Returns if the marker's text wraps.
+ * Returns: if the marker's text wraps.
*
* Since: 0.4
*/
* champlain_marker_get_wrap_mode:
* @marker: The marker
*
- * Returns the marker's text wrap mode.
+ * Returns: the marker's text wrap mode.
*
* Since: 0.4
*/
* champlain_marker_get_ellipsize:
* @marker: The marker
*
- * Returns the marker's text ellipsize mode.
+ * Returns: the marker's text ellipsize mode.
*
* Since: 0.4
*/
* champlain_marker_get_single_line_mode:
* @marker: The marker
*
- * Returns the marker's text single side mode.
+ * Returns: the marker's text single side mode.
*
* Since: 0.4
*/
* champlain_marker_get_draw_background:
* @marker: The marker
*
- * Returns if the marker's has a background.
+ * Returns: if the marker's has a background.
*
* Since: 0.4
*/
* @projection: the map source's projection
* @uri_format: the URI to fetch the tiles from, see #champlain_network_map_source_set_uri_format
*
- * Returns a constructed #ChamplainNetworkMapSource
+ * Returns: a constructed #ChamplainNetworkMapSource
*
* Since: 0.4
*/
* @y: the y position of the tile
* @z: the zool level of the tile
*
- * Returns a contruscted URI with the given parameters based on the map
+ * Returns: a contruscted URI with the given parameters based on the map
* source's URI format.
*
* Since: 0.4
*/
g_object_unref (cache);
}
-
-void
-champlain_network_map_source_fill_tile (ChamplainMapSource *map_source,
- ChamplainTile *tile)
-{
- fill_tile (map_source, tile);
-}
void champlain_network_map_source_set_uri_format (ChamplainNetworkMapSource *source,
const gchar *uri_format);
-void champlain_network_map_source_fill_tile (ChamplainMapSource *map_source,
- ChamplainTile *tile) G_GNUC_DEPRECATED;
-
G_END_DECLS
#endif
}
static void
-champlain_polygon_init (ChamplainPolygon *self)
+champlain_polygon_init (ChamplainPolygon *polygon)
{
- self->priv = GET_PRIVATE (self);
+ polygon->priv = GET_PRIVATE (polygon);
- self->priv->visible = TRUE;
- self->priv->points = NULL;
- self->priv->fill = FALSE;
- self->priv->stroke = TRUE;
- self->priv->stroke_width = 2.0;
+ polygon->priv->visible = TRUE;
+ polygon->priv->points = NULL;
+ polygon->priv->fill = FALSE;
+ polygon->priv->stroke = TRUE;
+ polygon->priv->stroke_width = 2.0;
- self->priv->fill_color = clutter_color_copy (&DEFAULT_FILL_COLOR);
- self->priv->stroke_color = clutter_color_copy (&DEFAULT_STROKE_COLOR);
+ polygon->priv->fill_color = clutter_color_copy (&DEFAULT_FILL_COLOR);
+ polygon->priv->stroke_color = clutter_color_copy (&DEFAULT_STROKE_COLOR);
}
/**
* champlain_polygon_new:
*
- * Returns a new empty #ChamplainPolygon
+ * Returns: a new empty #ChamplainPolygon
*
* Since: 0.4
*/
*
* Adds point at the end of the list of points in the polygon
*
- * Returns the added point, should not be freed.
+ * Returns: the added point, should not be freed.
*
* Since: 0.4
*/
ChamplainPoint *
-champlain_polygon_append_point (ChamplainPolygon *self,
+champlain_polygon_append_point (ChamplainPolygon *polygon,
gdouble lat,
gdouble lon)
{
- g_return_val_if_fail (CHAMPLAIN_IS_POLYGON (self), NULL);
+ g_return_val_if_fail (CHAMPLAIN_IS_POLYGON (polygon), NULL);
ChamplainPoint *point = champlain_point_new (lat, lon);
- self->priv->points = g_list_append (self->priv->points, point);
- g_object_notify (G_OBJECT (self), "visible");
+ polygon->priv->points = g_list_append (polygon->priv->points, point);
+ g_object_notify (G_OBJECT (polygon), "visible");
return point;
}
*
* Adds point at the given position in the list of points in the polygon
*
- * Returns the added point, should not be freed.
+ * Returns: the added point, should not be freed.
*
* Since: 0.4
*/
ChamplainPoint *
-champlain_polygon_insert_point (ChamplainPolygon *self,
+champlain_polygon_insert_point (ChamplainPolygon *polygon,
gdouble lat,
gdouble lon,
gint pos)
{
- g_return_val_if_fail (CHAMPLAIN_IS_POLYGON (self), NULL);
+ g_return_val_if_fail (CHAMPLAIN_IS_POLYGON (polygon), NULL);
ChamplainPoint *point = champlain_point_new (lat, lon);
- self->priv->points = g_list_insert (self->priv->points, point, pos);
- g_object_notify (G_OBJECT (self), "visible");
+ polygon->priv->points = g_list_insert (polygon->priv->points, point, pos);
+ g_object_notify (G_OBJECT (polygon), "visible");
return point;
}
/**
* champlain_polygon_remove_point:
- * @polygon: The polygon
+ * @polygon: a #ChamplainPolygon
* @point: the #ChamplainPoint to remove
*
* Removes the point from the polygon.
* Since: 0.4
*/
void
-champlain_polygon_remove_point (ChamplainPolygon *self,
+champlain_polygon_remove_point (ChamplainPolygon *polygon,
ChamplainPoint *point)
{
- g_return_if_fail (CHAMPLAIN_IS_POLYGON (self));
+ g_return_if_fail (CHAMPLAIN_IS_POLYGON (polygon));
- self->priv->points = g_list_remove (self->priv->points, point);
- g_object_notify (G_OBJECT (self), "visible");
+ polygon->priv->points = g_list_remove (polygon->priv->points, point);
+ g_object_notify (G_OBJECT (polygon), "visible");
}
/**
* Since: 0.4
*/
void
-champlain_polygon_clear_points (ChamplainPolygon *self)
+champlain_polygon_clear_points (ChamplainPolygon *polygon)
{
- g_return_if_fail (CHAMPLAIN_IS_POLYGON (self));
+ g_return_if_fail (CHAMPLAIN_IS_POLYGON (polygon));
- GList *next = self->priv->points;
+ GList *next = polygon->priv->points;
while (next != NULL)
{
champlain_point_free (next->data);
next = g_list_next (next);
}
- g_list_free (self->priv->points);
- self->priv->points = NULL;
- g_object_notify (G_OBJECT (self), "visible");
+ g_list_free (polygon->priv->points);
+ polygon->priv->points = NULL;
+ g_object_notify (G_OBJECT (polygon), "visible");
}
/**
* champlain_polygon_get_points:
* @polygon: The polygon
*
- * Returns a list of all points from the polygon, it shouldn't be freed.
+ * Returns: a list of all points from the polygon, it shouldn't be freed.
*
* Since: 0.4
*/
GList *
-champlain_polygon_get_points (ChamplainPolygon *self)
+champlain_polygon_get_points (ChamplainPolygon *polygon)
{
- g_return_val_if_fail (CHAMPLAIN_IS_POLYGON (self), NULL);
+ g_return_val_if_fail (CHAMPLAIN_IS_POLYGON (polygon), NULL);
- return self->priv->points;
+ return polygon->priv->points;
}
/**
* champlain_polygon_get_color:
* @polygon: The polygon
*
- * Returns the polygon's fill color.
+ * Returns: the polygon's fill color.
*
* Since: 0.4
*/
* champlain_polygon_get_stroke_color:
* @polygon: The polygon
*
- * Returns the polygon's stroke color.
+ * Returns: the polygon's stroke color.
*
* Since: 0.4
*/
* champlain_polygon_get_stroke:
* @polygon: The polygon
*
- * Returns if the polygon has a stroke
+ * Returns: TRUE if the polygon has a stroke, FALSE otherwise.
*
* Since: 0.4
*/
* champlain_polygon_get_fill:
* @polygon: The polygon
*
- * Returns if the polygon is filled
+ * Returns: TRUE if the polygon is filled, FALSE otherwise.
*
* Since: 0.4
*/
* champlain_polygon_get_stroke_width:
* @polygon: The polygon
*
- * Returns the width of the stroke
+ * Returns: the width of the stroke
*
* Since: 0.4
*/
gdouble lat,
gdouble lon,
gint pos);
-void champlain_polygon_remove_point (ChamplainPolygon *self,
+void champlain_polygon_remove_point (ChamplainPolygon *polygon,
ChamplainPoint *point);
void champlain_polygon_clear_points (ChamplainPolygon *polygon);
GList *champlain_polygon_get_points (ChamplainPolygon *polygon);
if (champlain_selection_layer_marker_is_selected (layer, marker))
return;
+ if (layer->priv->mode == CHAMPLAIN_SELECTION_NONE)
+ return;
+
if (layer->priv->mode == CHAMPLAIN_SELECTION_SINGLE)
{
/* Clear previous selection */
{
DEBUG ("Mouse select %p", marker);
+ if (layer->priv->mode == CHAMPLAIN_SELECTION_NONE)
+ return;
+
if (layer->priv->mode == CHAMPLAIN_SELECTION_SINGLE)
{
/* Clear previous selection */
/**
* champlain_selection_layer_new:
*
- * Returns a new #ChamplainSelectionLayer ready to be used as a #ClutterContainer for the markers.
+ * Returns: a new #ChamplainSelectionLayer ready to be used as a #ClutterContainer for the markers.
*
* Since: 0.4
*/
*
* This function will return NULL if in CHAMPLAIN_SELETION_MULTIPLE.
*
- * Returns the selected #ChamplainBaseMarker or NULL if none is selected.
+ * Returns: the selected #ChamplainBaseMarker or NULL if none is selected.
*
* Since: 0.4
*/
/**
* champlain_selection_get_selected_markers:
*
- * Returns the list of selected #ChamplainBaseMarker or NULL if none is selected.
+ * Returns: the list of selected #ChamplainBaseMarker or NULL if none is selected.
* You shouldn't free that list.
*
* Since: 0.4
/**
* champlain_selection_layer_count_selected_markers:
*
- * Returns the number of selected #ChamplainBaseMarker
+ * Returns: the number of selected #ChamplainBaseMarker
*
* Since: 0.4
*/
return g_list_length (layer->priv->selection);
}
-void
+/**
+ * champlain_selection_layer_select:
+ * @layer: a #ChamplainSelectionLayer
+ * @marker: a #ChamplainBaseMarker
+ *
+ * Selects the marker.
+ *
+ * Since: 0.4
+ */
+void
champlain_selection_layer_select (ChamplainSelectionLayer *layer,
ChamplainBaseMarker *marker)
{
api_select (layer, marker);
}
+/**
+ * champlain_selection_layer_unselect_all:
+ * @layer: a #ChamplainSelectionLayer
+ *
+ * Unselects all markers.
+ *
+ * Since: 0.4
+ */
void
champlain_selection_layer_unselect_all (ChamplainSelectionLayer *layer)
{
/**
* champlain_selection_layer_select_all:
+ * @layer: a #ChamplainSelectionLayer
*
* Selects all markers in the layer. This call will only work if the selection
* mode is set CHAMPLAIN_SELETION_MULTIPLE.
gint n_children = 0;
gint i = 0;
+ if (layer->priv->mode == CHAMPLAIN_SELECTION_NONE)
+ return;
+
if (layer->priv->mode == CHAMPLAIN_SELECTION_SINGLE)
return;
}
}
+/**
+ * champlain_selection_layer_unselect:
+ * @layer: a #ChamplainSelectionLayer
+ * @marker: a #ChamplainBaseMarker
+ *
+ * Unselect the marker.
+ *
+ * Since: 0.4
+ */
void
champlain_selection_layer_unselect (ChamplainSelectionLayer *layer,
ChamplainBaseMarker *marker)
}
}
+/**
+ * champlain_selection_layer_marker_is_selected:
+ * @layer: a #ChamplainSelectionLayer
+ * @marker: a #ChamplainBaseMarker
+ *
+ * Returns: whether the marker is selected or not.
+ *
+ * Since: 0.4
+ */
gboolean
champlain_selection_layer_marker_is_selected (ChamplainSelectionLayer *layer,
ChamplainBaseMarker *marker)
* @mode: a #ChamplainSelectionMode value
*
* Sets the selection mode of the layer.
- * NOTE: changing selection mode to CHAMPLAIN_SELECTION_SINGLE will clear all
- * previously selected markers.
+ *
+ * NOTE: changing selection mode to CHAMPLAIN_SELECTION_NONE or
+ * CHAMPLAIN_SELECTION_SINGLE will clear all previously selected markers.
*
* Since: 0.4
*/
layer->priv->mode = mode;
/* Switching to single mode shouldn't keep the selection */
- if (mode == CHAMPLAIN_SELECTION_SINGLE)
+ if (mode == CHAMPLAIN_SELECTION_NONE ||
+ mode == CHAMPLAIN_SELECTION_SINGLE)
champlain_selection_layer_unselect_all (layer);
g_object_notify (G_OBJECT (layer), "selection-mode");
* champlain_selection_layer_get_selection_mode:
* @layer: a #ChamplainSelectionLayer
*
- * Returns the selection mode of the layer.
+ * Returns: the selection mode of the layer.
*
* Since: 0.4
*/
/**
* champlain_tile_new:
*
- * Returns a new #ChamplainTile
+ * Returns: a new #ChamplainTile
*
* Since: 0.4
*/
* champlain_tile_get_x:
* @self: the #ChamplainTile
*
- * Returns the tile's x position
+ * Returns: the tile's x position
*
* Since: 0.4
*/
* champlain_tile_get_y:
* @self: the #ChamplainTile
*
- * Returns the tile's y position
+ * Returns: the tile's y position
*
* Since: 0.4
*/
* champlain_tile_get_zoom_level:
* @self: the #ChamplainTile
*
- * Returns the tile's zoom level
+ * Returns: the tile's zoom level
*
* Since: 0.4
*/
* champlain_tile_get_size:
* @self: the #ChamplainTile
*
- * Returns the tile's size in pixels
+ * Returns: the tile's size in pixels
*
* Since: 0.4
*/
* champlain_tile_get_state:
* @self: the #ChamplainTile
*
- * Returns the tile's #ChamplainState
+ * Returns: the tile's #ChamplainState
*
* Since: 0.4
*/
* champlain_tile_get_uri:
* @self: the #ChamplainTile
*
- * Returns the tile's remote uri
+ * Returns: the tile's remote uri
*
* Since: 0.4
*/
* champlain_tile_get_filename:
* @self: the #ChamplainTile
*
- * Returns the tile's local filename
+ * Returns: the tile's local filename
*
* Since: 0.4
*/
* champlain_tile_get_actor:
* @self: the #ChamplainTile
*
- * Returns the tile's actor. This actor should not change during the tile's
+ * Returns: the tile's actor. This actor should not change during the tile's
* lifetime. You should not unref this actor, it is owned by the tile.
*
* Since: 0.4
/**
* champlain_tile_new_full:
- * @self: the #ChamplainTile
* @x: the x position
* @y: the y position
* @size: the size in pixels
* @zoom_level: the zoom level
*
- * Returns a #ChamplainTile
+ * Returns: a #ChamplainTile
*
* Since: 0.4
*/
* champlain_tile_get_modified_time:
* @self: the #ChamplainTile
*
- * Returns the tile's last modified time
+ * Returns: the tile's last modified time
*
* Since: 0.4
*/
/**
* champlain_tile_set_modified_time:
* @self: the #ChamplainTile
- * @time_: a #GTimeVal, the value will be copied
+ * @time: a #GTimeVal, the value will be copied
*
* Sets the tile's modified time
*
* champlain_tile_get_modified_time_string:
* @self: the #ChamplainTile
*
- * Returns the tile's modified time as a string (formated as per RFC 1123)
+ * Returns: the tile's modified time as a string (formated as per RFC 1123)
*
* Since: 0.4
*/
* champlain_tile_get_etag:
* @self: the #ChamplainTile
*
- * Returns the tile's ETag
+ * Returns: the tile's ETag
*
* Since: 0.4
*/
/**
* champlain_tile_get_content:
*
- * Returns the tile's content, this actor will change each time the tile's content changes.
+ * Returns: the tile's content, this actor will change each time the tile's content changes.
* You should not unref this content, it is owned by the tile.
*
* Since: 0.4
/**
* ChamplainView::animation-completed:
- * @view: the #ChamplainView that received the signal
*
* The ::animation-completed signal is emitted when any animation in the view
* ends. This is a detailed signal. For example, if you want to be signaled
clutter_container_add_actor (CLUTTER_CONTAINER (priv->viewport),
priv->map_layer);
-
g_signal_connect (priv->finger_scroll, "button-press-event",
G_CALLBACK (finger_scroll_button_press_cb), view);
g_signal_connect_after (priv->finger_scroll, "button-release-event",
g_object_notify (G_OBJECT (view), "latitude");
}
+/**
+ * champlain_view_set_size:
+ * @view: a #ChamplainView
+ * @width: the width in pixels
+ * @height: the height in pixels
+ *
+ * Sets the size of the view. This function will most probably be deprecated in
+ * future versions in favor of #clutter_actor_set_size. In the mean time, you need
+ * to call both.
+ *
+ * Since: 0.1
+ */
//FIXME: move to an handler of actor size change
void
champlain_view_set_size (ChamplainView *view,
/**
* champlain_view_new:
*
- * Returns a new #ChamplainView ready to be used as a #ClutterActor.
+ * Returns: a new #ChamplainView ready to be used as a #ClutterActor.
*
* Since: 0.4
*/
* @lat: a variable where to put the latitude of the event
* @lon: a variable where to put the longitude of the event
*
- * Returns the latitude, longitude coordinates for the given ClutterEvent.
+ * Returns: the latitude, longitude coordinates for the given ClutterEvent.
*
* Since: 0.2.8
*/
* @lat: a variable where to put the latitude of the event
* @lon: a variable where to put the longitude of the event
*
- * Returns the latitude, longitude coordinates for the given x, y position in
+ * Returns: the latitude, longitude coordinates for the given x, y position in
* the view. Use if you get coordinates from GtkEvents for example.
*
* Since: 0.4
* champlain_view_get_zoom_level:
* @view: The view
*
- * Returns the view's current zoom level.
+ * Returns: the view's current zoom level.
*
* Since: 0.4
*/
* champlain_view_get_min_zoom_level:
* @view: The view
*
- * Returns the view's minimal zoom level allowed.
+ * Returns: the view's minimal zoom level allowed.
*
* Since: 0.4
*/
* champlain_view_get_max_zoom_level:
* @view: The view
*
- * Returns the view's maximal zoom level allowed.
+ * Returns: the view's maximal zoom level allowed.
*
* Since: 0.4
*/
* champlain_view_get_map_source:
* @view: The view
*
- * Returns the view's current map source. If you need to keep a reference to the
+ * Returns: the view's current map source. If you need to keep a reference to the
* map source then you have to call #g_object_ref.
*
* Since: 0.4
* champlain_view_get_decel_rate:
* @view: The view
*
- * Returns the view's deceleration rate.
+ * Returns: the view's deceleration rate.
*
* Since: 0.4
*/
* champlain_view_get_scroll_mode:
* @view: The view
*
- * Returns the view's scroll mode behaviour.
+ * Returns: the view's scroll mode behaviour.
*
* Since: 0.4
*/
* champlain_view_get_keep_center_on_resize:
* @view: The view
*
- * Returns TRUE if the view keeps the center or resize.
+ * Returns: TRUE if the view keeps the center or resize, FALSE otherwise.
*
* Since: 0.4
*/
* champlain_view_get_show_license:
* @view: The view
*
- * Returns TRUE if the view displays the license.
+ * Returns: TRUE if the view displays the license, FALSE otherwise.
*
* Since: 0.4
*/
* champlain_view_get_zoom_on_double_click:
* @view: The view
*
- * Returns TRUE if the view zooms on double click.
+ * Returns: TRUE if the view zooms on double click, FALSE otherwise.
*
* Since: 0.4
*/
/**
* champlain_zoom_level_new:
*
- * Returns a new ChamplainZoomLevel
+ * Returns: a new #ChamplainZoomLevel
*
* Since: 0.4
*/
* champlain_zoom_level_tile_count:
* @self: a #ChamplainZoomLevel
*
- * Returns the number of tiles in a #ChamplainZoomLevel.
+ * Returns: the number of tiles in a #ChamplainZoomLevel.
*
* Since: 0.4
*/
* @self: a #ChamplainZoomLevel
* @index: an index
*
- * Returns the #ChamplainTile at given index
+ * Returns: the #ChamplainTile at given index
*
* Since: 0.4
*/
* champlain_zoom_level_get_width:
* @self: a #ChamplainZoomLevel
*
- * Returns the absolute width of a #ChamplainZoomLevel in tiles
+ * Returns: the width of a #ChamplainZoomLevel in tiles
*
* Since: 0.4
*/
* champlain_zoom_level_get_height:
* @self: a #ChamplainZoomLevel
*
- * Returns the absolute height of a #ChamplainZoomLevel in tiles
+ * Returns: the height of a #ChamplainZoomLevel in tiles
*
* Since: 0.4
*/
* champlain_zoom_level_get_zoom_level:
* @self: a #ChamplainZoomLevel
*
- * Returns the zoom level of a #ChamplainZoomLevel
+ * Returns: the zoom level of a #ChamplainZoomLevel
*
* Since: 0.4
*/
* champlain_zoom_level_get_actor:
* @self: a #ChamplainZoomLevel
*
- * Returns the #ClutterActor containing all the tiles of a #ChamplainZoomLevel,
+ * Returns: the #ClutterActor containing all the tiles of a #ChamplainZoomLevel,
* it should not be unref.
*
* Since: 0.4
<releaseinfo>
for libchamplain-gtk &version;
The latest version of this documentation can be found on-line at
- <ulink role="online-location" url="http://blog.pierlux.com/projects/libchamplain/">http://blog.pierlux.com/projects/libchamplain/</ulink>.
+ <ulink role="online-location" url="http://projects.gnome.org/libchamplain/">http://projects.gnome.org/libchamplain/</ulink>.
</releaseinfo>
+ <copyright>
+ <year>2008, 2009</year>
+ <holder>libchamplain contributors</holder>
+ </copyright>
+ <legalnotice>
+ <para>
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the <citetitle>GNU Free
+ Documentation License</citetitle>, Version 1.1 or any later
+ version published by the Free Software Foundation with no
+ Invariant Sections, no Front-Cover Texts, and no Back-Cover
+ Texts. You may obtain a copy of the <citetitle>GNU Free
+ Documentation License</citetitle> from the Free Software
+ Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing
+ to:
+
+ <address>
+ The Free Software Foundation, Inc.,
+ <street>59 Temple Place</street> - Suite 330,
+ <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
+ <country>USA</country>
+ </address>
+ </para>
+ </legalnotice>
</bookinfo>
<chapter>
<ulink role="online-location" url="http://projects.gnome.org/libchamplain/">http://projects.gnome.org/libchamplain/</ulink>.
</releaseinfo>
<copyright>
- <year>2008,2009</year>
- <holder>Pierre-Luc Beaudoin <pierre-luc@pierlux.com></holder>
+ <year>2008, 2009</year>
+ <holder>libchamplain contributors</holder>
</copyright>
<legalnotice>
<para>
<TITLE>ChamplainCache</TITLE>
ChamplainCache
ChamplainCacheClass
-champlain_cache_get_default
+champlain_cache_dup_default
champlain_cache_fill_tile
champlain_cache_dup_default
champlain_cache_get_size_limit
champlain_map_source_desc_free
champlain_map_source_desc_get_type
champlain_map_source_desc_new
-champlain_map_source_factory_get_default
champlain_map_source_factory_get_list
<SUBSECTION Standard>
CHAMPLAIN_MAP_SOURCE_FACTORY
champlain_polygon_show
champlain_polygon_hide
<SUBSECTION Standard>
-CHAMPLAIN_POLYGON_FACTORY
CHAMPLAIN_IS_POLYGON
CHAMPLAIN_TYPE_POLYGON
champlain_polygon_get_type
ChamplainSelectionMode
ChamplainSelectionLayer
champlain_selection_layer_new
-champlain_selection_layer_get_selected
-champlain_selection_layer_get_selected_markers
-champlain_selection_layer_count_selected_markers
+champlain_selection_layer_set_selection_mode
+champlain_selection_layer_get_selection_mode
champlain_selection_layer_select
champlain_selection_layer_unselect
-champlain_selection_layer_marker_is_selected
champlain_selection_layer_select_all
champlain_selection_layer_unselect_all
-champlain_selection_layer_get_selection_mode
-champlain_selection_layer_set_selection_mode
-champlain_selection_mode_get_type
+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_base_marker_get_type
champlain_marker_get_type
champlain_layer_get_type
+champlain_selection_layer_get_type
champlain_map_source_get_type
champlain_network_map_source_get_type
champlain_tile_get_type
projects / libchamplain / commitdiff