GeocodeGlib.Place¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (name, place_type)
class	`new_with_location` (name, place_type, location)
	`equal` (b)
	`get_administrative_area` ()
	`get_area` ()
	`get_bounding_box` ()
	`get_building` ()
	`get_continent` ()
	`get_country` ()
	`get_country_code` ()
	`get_county` ()
	`get_icon` ()
	`get_location` ()
	`get_name` ()
	`get_osm_id` ()
	`get_osm_type` ()
	`get_place_type` ()
	`get_postal_code` ()
	`get_state` ()
	`get_street` ()
	`get_street_address` ()
	`get_town` ()
	`set_administrative_area` (admin_area)
	`set_area` (area)
	`set_bounding_box` (bbox)
	`set_building` (building)
	`set_continent` (continent)
	`set_country` (country)
	`set_country_code` (country_code)
	`set_county` (county)
	`set_location` (location)
	`set_name` (name)
	`set_postal_code` (postal_code)
	`set_state` (state)
	`set_street` (street)
	`set_street_address` (street_address)
	`set_town` (town)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`administrative-area`	`str`	r/w	Local administrative area
`area`	`str`	r/w	A named area such as a campus or neighborhood
`bounding-box`	`GeocodeGlib.BoundingBox`	r/w	The bounding box for the place
`building`	`str`	r/w	A specific building on a street or in an area
`continent`	`str`	r/w	Continent
`country`	`str`	r/w	Country
`country-code`	`str`	r/w	ISO Country Code
`county`	`str`	r/w	County
`icon`	`Gio.Icon`	r	An icon representing the the place
`location`	`GeocodeGlib.Location`	r/w	Location Info
`name`	`str`	r/w	Name
`osm-id`	`str`	r/w	The OpenStreetMap ID of the place
`osm-type`	`GeocodeGlib.PlaceOsmType`	r/w	The OpenStreetMap type of the place
`place-type`	`GeocodeGlib.PlaceType`	r/w/co	Place Type
`postal-code`	`str`	r/w	Postal Code
`state`	`str`	r/w	State
`street`	`str`	r/w	Street name
`street-address`	`str`	r/w	Street Address
`town`	`str`	r/w	Town

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class GeocodeGlib.Place(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: GeocodeGlib.PlaceClass

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

classmethod new(name, place_type)¶

Parameters:

name (str) – the name of place
place_type (GeocodeGlib.PlaceType) – the type of place

Returns:

a new GeocodeGlib.Place object. Use GObject.Object.unref() when done.

Return type:

GeocodeGlib.Place

Creates a new GeocodeGlib.Place object.

classmethod new_with_location(name, place_type, location)¶

Parameters:

name (str) – the name of place
place_type (GeocodeGlib.PlaceType) – the type of place
location (GeocodeGlib.Location) – the location info for the place

Returns:

a new GeocodeGlib.Place object. Use GObject.Object.unref() when done.

Return type:

GeocodeGlib.Place

Creates a new GeocodeGlib.Place object.

equal(b)¶

Parameters:: b (GeocodeGlib.Place) – another place
Returns:: True if the instances are equal, False otherwise
Return type:: bool

Compare two GeocodeGlib.Place instances for equality. This compares all fields and only returns True if the instances are exactly equal. For example, if both places have the same GeocodeGlib.Place :location, but place b has its GeocodeGlib.Place :continent property set and place self does not, False will be returned.

Both instances must be non-None.

New in version 3.23.1.

get_administrative_area()¶

Returns:: The local administrative area of the self.
Return type:: str

Gets the local administrative area of the self.

get_area()¶

Returns:: The area of the self.
Return type:: str

Gets the area of the self.

get_bounding_box()¶

Returns:: A GeocodeGlib.BoundingBox, or None if boundaries are unknown.
Return type:: GeocodeGlib.BoundingBox

Gets the bounding box for the place self.

get_building()¶

Returns:: The building of the self.
Return type:: str

Gets the building of the self.

get_continent()¶

Returns:: The continent of the self.
Return type:: str

Gets the continent of the self.

get_country()¶

Returns:: The country of the self.
Return type:: str

Gets the country of the self.

get_country_code()¶

Returns:: The ISO-3166 country code of the self, in upper case.
Return type:: str

Gets the ISO-3166 country code of the self.

get_county()¶

Returns:: The country of the self.
Return type:: str

Gets the county of the self.

get_icon()¶

Returns:: The Gio.Icon representing the self.
Return type:: Gio.Icon

Gets the Gio.Icon representing the self.

get_location()¶

Returns:: The associated location object.
Return type:: GeocodeGlib.Location

Gets the associated location object.

get_name()¶

Returns:: The name of the self.
Return type:: str

Gets the name of the self.

get_osm_id()¶

Returns:: The osm ID of the self.
Return type:: str

Gets the OpenStreetMap ID of the self.

get_osm_type()¶

Returns:: The osm type of the self.
Return type:: GeocodeGlib.PlaceOsmType

Gets the OpenStreetMap type of the self.

get_place_type()¶

Returns:: The type of the self.
Return type:: GeocodeGlib.PlaceType

Gets the type of the self.

get_postal_code()¶

Returns:: The postal code of the self.
Return type:: str

Gets the postal code of the self.

get_state()¶

Returns:: The state of the self.
Return type:: str

Gets the state of the self.

get_street()¶

Returns:: The street of the self.
Return type:: str

Gets the street of the self.

get_street_address()¶

Returns:: The street address of the self.
Return type:: str

Gets the street address of the self.

get_town()¶

Returns:: The town of the self.
Return type:: str

Gets the town of the self.

set_administrative_area(admin_area)¶

Parameters:: admin_area (str) – an administrative area for the place

Sets the local administrative area of self to admin_area.

set_area(area)¶

Parameters:: area (str) – a area

Sets the area of self to area.

set_bounding_box(bbox)¶

Parameters:: bbox (GeocodeGlib.BoundingBox) – A GeocodeGlib.BoundingBox for the place

Sets the GeocodeGlib.BoundingBox for the place self.

set_building(building)¶

Parameters:: building (str) – a building

Sets the building of self to building.

set_continent(continent)¶

Parameters:: continent (str) – a continent for the place

Sets the continent of self to continent.

set_country(country)¶

Parameters:: country (str) – a country for the place

Sets the country of self to country.

set_country_code(country_code)¶

Parameters:: country_code (str) – an ISO country code for the place

Sets the ISO country code of self to country_code.

set_county(county)¶

Parameters:: county (str) – a county for the place

Sets the county of self to county.

set_location(location)¶

Parameters:: location (GeocodeGlib.Location) – A location

Sets the location of self to location.

set_name(name)¶

Parameters:: name (str) – the name of place

Sets the name of the self to name.

set_postal_code(postal_code)¶

Parameters:: postal_code (str) – a postal code for the place

Sets the postal code of self to postal_code.

set_state(state)¶

Parameters:: state (str) – a state for the place

Sets the state of self to state.

set_street(street)¶

Parameters:: street (str) – a street

Sets the street of self to street.

set_street_address(street_address)¶

Parameters:: street_address (str) – a street address for the place

Sets the street address of self to street_address.

set_town(town)¶

Parameters:: town (str) – a town for the place

Sets the town of self to town.

Property Details¶

GeocodeGlib.Place.props.administrative_area¶

Name:: administrative-area
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The local administrative area.

GeocodeGlib.Place.props.area¶

Name:: area
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

A named area such as a campus or neighborhood.

GeocodeGlib.Place.props.bounding_box¶

Name:: bounding-box
Type:: GeocodeGlib.BoundingBox
Default Value:: None
Flags:: READABLE, WRITABLE

The bounding box for the place.

GeocodeGlib.Place.props.building¶

Name:: building
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

A specific building on a street or in an area.

GeocodeGlib.Place.props.continent¶

Name:: continent
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The continent.

GeocodeGlib.Place.props.country¶

Name:: country
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The country.

GeocodeGlib.Place.props.country_code¶

Name:: country-code
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The country code.

GeocodeGlib.Place.props.county¶

Name:: county
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The county.

GeocodeGlib.Place.props.icon¶

Name:: icon
Type:: Gio.Icon
Default Value:: None
Flags:: READABLE

Gio.Icon representing the GeocodePlace.

GeocodeGlib.Place.props.location¶

Name:: location
Type:: GeocodeGlib.Location
Default Value:: None
Flags:: READABLE, WRITABLE

The location info for the place.

GeocodeGlib.Place.props.name¶

Name:: name
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The name of the place.

GeocodeGlib.Place.props.osm_id¶

Name:: osm-id
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The OpenStreetMap id of the place.

GeocodeGlib.Place.props.osm_type¶

Name:: osm-type
Type:: GeocodeGlib.PlaceOsmType
Default Value:: GeocodeGlib.PlaceOsmType.UNKNOWN
Flags:: READABLE, WRITABLE

The OpenStreetMap type of the place.

GeocodeGlib.Place.props.place_type¶

Name:: place-type
Type:: GeocodeGlib.PlaceType
Default Value:: GeocodeGlib.PlaceType.UNKNOWN
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The type of the place.

GeocodeGlib.Place.props.postal_code¶

Name:: postal-code
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The postal code.

GeocodeGlib.Place.props.state¶

Name:: state
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The state.

GeocodeGlib.Place.props.street¶

Name:: street
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The street name.

GeocodeGlib.Place.props.street_address¶

Name:: street-address
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The street address.

GeocodeGlib.Place.props.town¶

Name:: town
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The town.