class QGeoAddress#

The QGeoAddress class represents an address of a QGeoLocation . More

Inheritance diagram of PySide6.QtPositioning.QGeoAddress

Synopsis#

Methods#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

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:

__init__(other)#
Parameters:

otherQGeoAddress

Constructs a copy of other.

__init__()

Default constructor.

city()#
Return type:

str

Returns the city.

See also

setCity()

clear()#

Clears all of the address’ data fields.

country()#
Return type:

str

Returns the country name.

See also

setCountry()

countryCode()#
Return type:

str

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

See also

setCountryCode()

county()#
Return type:

str

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

See also

setCounty()

district()#
Return type:

str

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

See also

setDistrict()

isEmpty()#
Return type:

bool

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

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()

__ne__(rhs)#
Parameters:

rhsQGeoAddress

Return type:

bool

Returns true if lhs address is not equal to rhs, otherwise returns false.

__eq__(rhs)#
Parameters:

rhsQGeoAddress

Return type:

bool

Returns true if lhs address is equal to rhs, otherwise returns false.

postalCode()#
Return type:

str

Returns the postal code.

See also

setPostalCode()

setCity(city)#
Parameters:

city – str

Sets the city.

See also

city()

setCountry(country)#
Parameters:

country – str

Sets the country name.

See also

country()

setCountryCode(countryCode)#
Parameters:

countryCode – str

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

See also

countryCode()

setCounty(county)#
Parameters:

county – str

Sets the county.

See also

county()

setDistrict(district)#
Parameters:

district – str

Sets the district.

See also

district()

setPostalCode(postalCode)#
Parameters:

postalCode – str

Sets the postalCode.

See also

postalCode()

setState(state)#
Parameters:

state – str

Sets the state.

See also

state()

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.

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.

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()

state()#
Return type:

str

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

See also

setState()

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.

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.

swap(other)#
Parameters:

otherQGeoAddress

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 text() 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 text(), setStreet() , text() may return different strings for each invocation of text().

If a non-empty string is provided to setText() , then isTextGenerated() will be set to false and text() 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 text().

See also

setText()