QGeoAddress

The QGeoAddress class represents an address of a QGeoLocation . More

Inheritance diagram of PySide6.QtPositioning.QGeoAddress

Synopsis

Functions

Detailed Description

The address’ attributes are normalized to US feature names and can be mapped to the local feature levels (for example State matches “Bundesland” in Germany).

The address contains a text() for displaying purposes and additional properties to access the components of an address:

class PySide6.QtPositioning.QGeoAddress

PySide6.QtPositioning.QGeoAddress(other)

Parameters

otherPySide6.QtPositioning.QGeoAddress

Default constructor.

Constructs a copy of other.

PySide6.QtPositioning.QGeoAddress.city()
Return type

str

Returns the city.

See also

setCity()

PySide6.QtPositioning.QGeoAddress.clear()

Clears all of the address’ data fields.

PySide6.QtPositioning.QGeoAddress.country()
Return type

str

Returns the country name.

See also

setCountry()

PySide6.QtPositioning.QGeoAddress.countryCode()
Return type

str

Returns the country code according to ISO 3166-1 alpha-3

See also

setCountryCode()

PySide6.QtPositioning.QGeoAddress.county()
Return type

str

Returns the county. The county is considered the second subdivision below country.

See also

setCounty()

PySide6.QtPositioning.QGeoAddress.district()
Return type

str

Returns the district. The district is considered the subdivison below city.

See also

setDistrict()

PySide6.QtPositioning.QGeoAddress.isEmpty()
Return type

bool

Returns whether this address is empty. An address is considered empty if all of its fields are empty.

PySide6.QtPositioning.QGeoAddress.isTextGenerated()
Return type

bool

Returns true if text() is automatically generated from address elements, otherwise returns false if text() has been explicitly assigned.

See also

text() setText()

PySide6.QtPositioning.QGeoAddress.__ne__(rhs)
Parameters

rhsPySide6.QtPositioning.QGeoAddress

Return type

bool

PySide6.QtPositioning.QGeoAddress.__eq__(rhs)
Parameters

rhsPySide6.QtPositioning.QGeoAddress

Return type

bool

PySide6.QtPositioning.QGeoAddress.postalCode()
Return type

str

Returns the postal code.

See also

setPostalCode()

PySide6.QtPositioning.QGeoAddress.setCity(city)
Parameters

city – str

Sets the city.

See also

city()

PySide6.QtPositioning.QGeoAddress.setCountry(country)
Parameters

country – str

Sets the country name.

See also

country()

PySide6.QtPositioning.QGeoAddress.setCountryCode(countryCode)
Parameters

countryCode – str

Sets the countryCode according to ISO 3166-1 alpha-3

See also

countryCode()

PySide6.QtPositioning.QGeoAddress.setCounty(county)
Parameters

county – str

Sets the county.

See also

county()

PySide6.QtPositioning.QGeoAddress.setDistrict(district)
Parameters

district – str

Sets the district.

See also

district()

PySide6.QtPositioning.QGeoAddress.setPostalCode(postalCode)
Parameters

postalCode – str

Sets the postalCode.

See also

postalCode()

PySide6.QtPositioning.QGeoAddress.setState(state)
Parameters

state – str

Sets the state.

See also

state()

PySide6.QtPositioning.QGeoAddress.setStreet(street)
Parameters

street – str

Sets the street name to street.

Note

Before Qt6 this could also contain things like a unit number, a building name, or anything else that might be used to distinguish one address from another. Use setStreetNumber() to set this data now.

PySide6.QtPositioning.QGeoAddress.setStreetNumber(streetNumber)
Parameters

streetNumber – str

Sets the street number to streetNumber.

This may also contain things like a unit number, a building name, or anything else that might be used to distinguish one address from another.

Note

Before Qt6 this information was set by setStreet() method.

PySide6.QtPositioning.QGeoAddress.setText(text)
Parameters

text – str

If text is not empty, explicitly assigns text as the string to be returned by text() . isTextGenerated() will return false.

If text is empty, indicates that text() should be automatically generated from the address elements. isTextGenerated() will return true.

See also

text()

PySide6.QtPositioning.QGeoAddress.state()
Return type

str

Returns the state. The state is considered the first subdivision below country.

See also

setState()

PySide6.QtPositioning.QGeoAddress.street()
Return type

str

Returns the street name.

Note

Before Qt6 this could also contain things like a unit number, a building name, or anything else that might be used to distinguish one address from another. Use streetNumber() to obtain this data now.

PySide6.QtPositioning.QGeoAddress.streetNumber()
Return type

str

Returns the street number.

This may also contain things like a unit number, a building name, or anything else that might be used to distinguish one address from another.

Note

Before Qt6 this information was returned by street() method.

PySide6.QtPositioning.QGeoAddress.swap(other)
Parameters

otherPySide6.QtPositioning.QGeoAddress

PySide6.QtPositioning.QGeoAddress.text()
Return type

str

Returns the address as a single formatted string. It is the recommended string to use to display the address to the user. It typically takes the format of an address as found on an envelope, but this is not always necessarily the case.

The address text is either automatically generated or explicitly assigned. This can be determined by checking isTextGenerated .

If an empty string is provided to setText() , then isTextGenerated() will be set to true and will return a string which is locally formatted according to countryCode() and based on the elements of the address such as street, city and so on. Because the text string is generated from the address elements, a sequence of calls such as , setStreet() , may return different strings for each invocation of .

If a non-empty string is provided to setText() , then isTextGenerated() will be set to false and will always return the explicitly assigned string. Calls to modify other elements such as setStreet() , setCity() and so on will not affect the resultant string from .

See also

setText()