GeocodeBoundingBox

GeocodeBoundingBox — Geocode BoundingBox object

Synopsis

#include <geocode-glib/geocode-bounding-box.h>

struct              GeocodeBoundingBox;
struct              GeocodeBoundingBoxClass;
GeocodeBoundingBox * geocode_bounding_box_new           (gdouble top,
                                                         gdouble bottom,
                                                         gdouble left,
                                                         gdouble right);
gdouble             geocode_bounding_box_get_top        (GeocodeBoundingBox *bbox);
gdouble             geocode_bounding_box_get_bottom     (GeocodeBoundingBox *bbox);
gdouble             geocode_bounding_box_get_left       (GeocodeBoundingBox *bbox);
gdouble             geocode_bounding_box_get_right      (GeocodeBoundingBox *bbox);

Object Hierarchy

  GObject
   +----GeocodeBoundingBox

Properties

  "bottom"                   gdouble               : Read / Write / Construct Only
  "left"                     gdouble               : Read / Write / Construct Only
  "right"                    gdouble               : Read / Write / Construct Only
  "top"                      gdouble               : Read / Write / Construct Only

Description

The GeocodeBoundingBox represents a geographical area on earth, bounded by top, bottom, left and right coordinates.

Details

struct GeocodeBoundingBox

struct GeocodeBoundingBox;

All the fields in the GeocodeLocation structure are private and should never be accessed directly.


struct GeocodeBoundingBoxClass

struct GeocodeBoundingBoxClass {
};

All the fields in the GeocodeBoundingBoxClass structure are private and should never be accessed directly.


geocode_bounding_box_new ()

GeocodeBoundingBox * geocode_bounding_box_new           (gdouble top,
                                                         gdouble bottom,
                                                         gdouble left,
                                                         gdouble right);

Creates a new GeocodeBoundingBox object.

Returns :

a new GeocodeBoundingBox object. Use g_object_unref() when done.

geocode_bounding_box_get_top ()

gdouble             geocode_bounding_box_get_top        (GeocodeBoundingBox *bbox);

Gets the top coordinate of bbox.

bbox :

a GeocodeBoundingBox

Returns :

the top coordinate of bbox.

geocode_bounding_box_get_bottom ()

gdouble             geocode_bounding_box_get_bottom     (GeocodeBoundingBox *bbox);

Gets the bottom coordinate of bbox.

bbox :

a GeocodeBoundingBox

Returns :

the bottom coordinate of bbox.

geocode_bounding_box_get_left ()

gdouble             geocode_bounding_box_get_left       (GeocodeBoundingBox *bbox);

Gets the left coordinate of bbox.

bbox :

a GeocodeBoundingBox

Returns :

the left coordinate of bbox.

geocode_bounding_box_get_right ()

gdouble             geocode_bounding_box_get_right      (GeocodeBoundingBox *bbox);

Gets the right coordinate of bbox.

bbox :

a GeocodeBoundingBox

Returns :

the right coordinate of bbox.

Property Details

The "bottom" property

  "bottom"                   gdouble               : Read / Write / Construct Only

Bottom coordinate.

Allowed values: [-90,90]

Default value: 0


The "left" property

  "left"                     gdouble               : Read / Write / Construct Only

Left coordinate.

Allowed values: [-180,180]

Default value: 0


The "right" property

  "right"                    gdouble               : Read / Write / Construct Only

Right coordinate.

Allowed values: [-180,180]

Default value: 0


The "top" property

  "top"                      gdouble               : Read / Write / Construct Only

Top coordinate.

Allowed values: [-90,90]

Default value: 0