KContacts::AddressFormat Class Reference

#include <addressformat.h>

Properties
QString	country
QList< KContacts::AddressFormatElement >	elements
QString	postalCodeRegularExpression
KContacts::AddressFormatFields	requiredFields
KContacts::AddressFormatFields	upperCaseFields
KContacts::AddressFormatFields	usedFields

Public Member Functions
	AddressFormat (const AddressFormat &)
QString	country () const
const std::vector< AddressFormatElement > &	elements () const
AddressFormat &	operator= (const AddressFormat &)
QString	postalCodeRegularExpression () const
AddressFormatFields	requiredFields () const
AddressFormatFields	upperCaseFields () const
AddressFormatFields	usedFields () const

Detailed Description

Information on how addresses are formatted in a specific country/language.

This is primarily used for displaying or printing addresses, but is also useful for country specific adjustment in address edit forms, or for parsing textual addresses.

Since

5.92

See also

AddressFormatRepository

Definition at line 68 of file addressformat.h.

Property Documentation

country

QString KContacts::AddressFormat::country

read

Definition at line 71 of file addressformat.h.

elements

QList<KContacts::AddressFormatElement> KContacts::AddressFormat::elements

read

Definition at line 72 of file addressformat.h.

postalCodeRegularExpression

QString KContacts::AddressFormat::postalCodeRegularExpression

read

Definition at line 76 of file addressformat.h.

requiredFields

KContacts::AddressFormatFields KContacts::AddressFormat::requiredFields

read

Definition at line 73 of file addressformat.h.

upperCaseFields

KContacts::AddressFormatFields KContacts::AddressFormat::upperCaseFields

read

Definition at line 75 of file addressformat.h.

usedFields

KContacts::AddressFormatFields KContacts::AddressFormat::usedFields

read

Definition at line 74 of file addressformat.h.

Constructor & Destructor Documentation

AddressFormat()

AddressFormat::AddressFormat

(

)

Definition at line 55 of file addressformat.cpp.

Member Function Documentation

country()

QString AddressFormat::country

(

)

const

ISO 3166-1 alpha2 code of the country this format is for.

Definition at line 91 of file addressformat.cpp.

elements()

const std::vector< AddressFormatElement > & AddressFormat::elements

(

)

const

A sequence of field/literal/separator elements for this address format.

Definition at line 64 of file addressformat.cpp.

postalCodeRegularExpression()

QString AddressFormat::postalCodeRegularExpression

(

)

const

Regular expression matching the postal codes of this format.

Definition at line 86 of file addressformat.cpp.

requiredFields()

AddressFormatFields AddressFormat::requiredFields

(

)

const

The address fields that are required by this format for a valid address.

Note

This information is not available for all formats.

Definition at line 69 of file addressformat.cpp.

upperCaseFields()

AddressFormatFields AddressFormat::upperCaseFields

(

)

const

Fields that should be printed in upper case regardless of the input casing.

Definition at line 81 of file addressformat.cpp.

usedFields()

AddressFormatFields AddressFormat::usedFields

(

)

const

The address fields that are used by this format.

This is a superset of requiredFields(), and this information is available for all formats.

Definition at line 74 of file addressformat.cpp.

---

The documentation for this class was generated from the following files:

• addressformat.h
• addressformat.cpp