## OsmGpsMapLayer

OsmGpsMapLayer — An interface for layers to be drawn on the map

## Stability Level

Stable, unless otherwise indicated

## Synopsis

    #include <osm-gps-map.h>

                        OsmGpsMapLayer;
    void                osm_gps_map_layer_render            (OsmGpsMapLayer *self,
                                                             OsmGpsMap *map);
    void                osm_gps_map_layer_draw              (OsmGpsMapLayer *self,
                                                             OsmGpsMap *map,
                                                             GdkDrawable *drawable);
    gboolean            osm_gps_map_layer_busy              (OsmGpsMapLayer *self);
    gboolean            osm_gps_map_layer_button_press      (OsmGpsMapLayer *self,
                                                             OsmGpsMap *map,
                                                             GdkEventButton *event);
    struct              OsmGpsMapOsd;
    struct              OsmGpsMapOsdClass;
    OsmGpsMapOsd *      osm_gps_map_osd_new                 (void);

## Object Hierarchy

      GInterface
       +----OsmGpsMapLayer

      GObject
       +----OsmGpsMapOsd

## Implemented Interfaces

OsmGpsMapOsd implements OsmGpsMapLayer.

## Known Implementations

OsmGpsMapLayer is implemented by OsmGpsMapOsd.

## Properties

      "dpad-radius"              guint                 : Read / Write / Construct
      "osd-x"                    gint                  : Read / Write / Construct
      "osd-y"                    gint                  : Read / Write / Construct
      "show-coordinates"         gboolean              : Read / Write / Construct
      "show-crosshair"           gboolean              : Read / Write / Construct
      "show-dpad"                gboolean              : Read / Write / Construct
      "show-gps-in-dpad"         gboolean              : Read / Write / Construct
      "show-gps-in-zoom"         gboolean              : Read / Write / Construct
      "show-scale"               gboolean              : Read / Write / Construct
      "show-zoom"                gboolean              : Read / Write / Construct

## Description

OsmGpsMapLayer is an interface implemented by objects that wish to draw on top of the map respond to button press events. The most common implementation of this interface is OsmGpsMapOsd

## Details

### OsmGpsMapLayer

    typedef struct _OsmGpsMapLayer OsmGpsMapLayer;

### osm_gps_map_layer_render ()

    void                osm_gps_map_layer_render            (OsmGpsMapLayer *self,
                                                             OsmGpsMap *map);

### osm_gps_map_layer_draw ()

    void                osm_gps_map_layer_draw              (OsmGpsMapLayer *self,
                                                             OsmGpsMap *map,
                                                             GdkDrawable *drawable);

### osm_gps_map_layer_busy ()

    gboolean            osm_gps_map_layer_busy              (OsmGpsMapLayer *self);

### osm_gps_map_layer_button_press ()

    gboolean            osm_gps_map_layer_button_press      (OsmGpsMapLayer *self,
                                                             OsmGpsMap *map,
                                                             GdkEventButton *event);

### struct OsmGpsMapOsd

    struct OsmGpsMapOsd;

### struct OsmGpsMapOsdClass

    struct OsmGpsMapOsdClass {
    	GObjectClass parent_class;

    	/* vtable */
    };

### osm_gps_map_osd_new ()

    OsmGpsMapOsd *      osm_gps_map_osd_new                 (void);

Creates a new instance of OsmGpsMapOsd.

Returns : | the newly created OsmGpsMapOsd instance

## Property Details

### The `"dpad-radius"` property

      "dpad-radius"              guint                 : Read / Write / Construct

The dpad radius property.

Default value: 30

### The `"osd-x"` property

      "osd-x"                    gint                  : Read / Write / Construct

The osd x property.

Default value: 10

### The `"osd-y"` property

      "osd-y"                    gint                  : Read / Write / Construct

The osd y property.

Default value: 10

### The `"show-coordinates"` property

      "show-coordinates"         gboolean              : Read / Write / Construct

The show coordinates of map centre property.

Default value: TRUE

### The `"show-crosshair"` property

      "show-crosshair"           gboolean              : Read / Write / Construct

The show crosshair at map centre property.

Default value: FALSE

### The `"show-dpad"` property

      "show-dpad"                gboolean              : Read / Write / Construct

The show dpad for map navigation property.

Default value: FALSE

### The `"show-gps-in-dpad"` property

      "show-gps-in-dpad"         gboolean              : Read / Write / Construct

The show gps indicator in middle of dpad property.

Default value: FALSE

### The `"show-gps-in-zoom"` property

      "show-gps-in-zoom"         gboolean              : Read / Write / Construct

The show gps indicator in middle of zoom control property.

Default value: FALSE

### The `"show-scale"` property

      "show-scale"               gboolean              : Read / Write / Construct

The show scale on the map property.

Default value: TRUE

### The `"show-zoom"` property

      "show-zoom"                gboolean              : Read / Write / Construct

The show zoom control for map navigation property.

Default value: FALSE