OsmGpsMapTrack

OsmGpsMapTrack — A list of GPS points

Stability Level

Stable, unless otherwise indicated

Synopsis

#include <osm-gps-map.h>

struct              OsmGpsMapTrack;
struct              OsmGpsMapTrackClass;
void                osm_gps_map_track_add_point         (OsmGpsMapTrack *track,
                                                         OsmGpsMapPoint *point);
void                osm_gps_map_track_get_color         (OsmGpsMapTrack *track,
                                                         GdkRGBA *color);
GSList *            osm_gps_map_track_get_points        (OsmGpsMapTrack *track);
OsmGpsMapTrack *    osm_gps_map_track_new               (void);

Object Hierarchy

  GObject
   +----OsmGpsMapTrack

Properties

  "alpha"                    gfloat                : Read / Write / Construct
  "breakable"                gboolean              : Read / Write / Construct
  "clickable"                gboolean              : Read / Write / Construct
  "color"                    GdkRGBA*              : Read / Write
  "editable"                 gboolean              : Read / Write / Construct
  "highlight-color"          GdkRGBA*              : Read / Write
  "highlight-point"          gpointer              : Read / Write
  "line-width"               gfloat                : Read / Write / Construct
  "track"                    gpointer              : Read / Write / Construct Only
  "visible"                  gboolean              : Read / Write / Construct

Signals

  "point-changed"                                  : Run First
  "point-clicked"                                  : Run First
  "point-inserted"                                 : Run First
  "point-removed"                                  : Run First

Description

OsmGpsMapTrack stores multiple OsmGpsMapPoint objects, i.e. a track, and describes how such a track should be drawn on the map (see osm_gps_map_track_add()), including its colour, width, etc.

Details

struct OsmGpsMapTrack

struct OsmGpsMapTrack;

struct OsmGpsMapTrackClass

struct OsmGpsMapTrackClass {
    GObjectClass parent_class;
};

osm_gps_map_track_add_point ()

void                osm_gps_map_track_add_point         (OsmGpsMapTrack *track,
                                                         OsmGpsMapPoint *point);

Since 0.7.0

osm_gps_map_track_get_color ()

void                osm_gps_map_track_get_color         (OsmGpsMapTrack *track,
                                                         GdkRGBA *color);

osm_gps_map_track_get_points ()

GSList *            osm_gps_map_track_get_points        (OsmGpsMapTrack *track);

Returns :

 list of OsmGpsMapPoint. [element-type OsmGpsMapPoint][transfer full]

Since 0.7.0

osm_gps_map_track_new ()

OsmGpsMapTrack *    osm_gps_map_track_new               (void);

Property Details

The "alpha" property

  "alpha"                    gfloat                : Read / Write / Construct

alpha transparency of the track.

Allowed values: [0,1]

Default value: 0.6

The "breakable" property

  "breakable"                gboolean              : Read / Write / Construct

should this track be breakable, only works when editable is set to TRUE.

Default value: FALSE

The "clickable" property

  "clickable"                gboolean              : Read / Write / Construct

should this track be clickable.

Default value: FALSE

The "color" property

  "color"                    GdkRGBA*              : Read / Write

color of the track.

The "editable" property

  "editable"                 gboolean              : Read / Write / Construct

should this track be editable.

Default value: FALSE

The "highlight-color" property

  "highlight-color"          GdkRGBA*              : Read / Write

color used to mark a highlighted point.

The "highlight-point" property

  "highlight-point"          gpointer              : Read / Write

point in this track that must be highlighted.

The "line-width" property

  "line-width"               gfloat                : Read / Write / Construct

width of the lines drawn for the track.

Allowed values: [0,100]

Default value: 4

The "track" property

  "track"                    gpointer              : Read / Write / Construct Only

list of points for the track.

The "visible" property

  "visible"                  gboolean              : Read / Write / Construct

should this track be visible.

Default value: TRUE

Signal Details

The "point-changed" signal

void                user_function                      (OsmGpsMapTrack *osmgpsmaptrack,
                                                        OsmGpsMapPoint *arg1,
                                                        gpointer        user_data)           : Run First

osmgpsmaptrack :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "point-clicked" signal

void                user_function                      (OsmGpsMapTrack *osmgpsmaptrack,
                                                        OsmGpsMapPoint *arg1,
                                                        gpointer        user_data)           : Run First

osmgpsmaptrack :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.

The "point-inserted" signal

void                user_function                      (OsmGpsMapTrack *self,
                                                        OsmGpsMapPoint *arg1,
                                                        gpointer        user_data)      : Run First

The point-inserted signal.

self :

 A OsmGpsMapTrack

user_data :

 user data set when the signal handler was connected.

The "point-removed" signal

void                user_function                      (OsmGpsMapTrack *osmgpsmaptrack,
                                                        gint            arg1,
                                                        gpointer        user_data)           : Run First

osmgpsmaptrack :

 the object which received the signal.

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.18