Search for usage in LXR

KContacts::AddressFormat Class Reference

#include <addressformat.h>


QString country
QList< KContacts::AddressFormatElementelements
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
AddressFormatoperator= (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.

See also

Definition at line 68 of file addressformat.h.

Member Function Documentation

◆ country()

QString KContacts::AddressFormat::country ( ) const

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

◆ elements()

const std::vector<AddressFormatElement>& KContacts::AddressFormat::elements ( ) const

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

◆ postalCodeRegularExpression()

QString KContacts::AddressFormat::postalCodeRegularExpression ( ) const

Regular expression matching the postal codes of this format.

◆ requiredFields()

AddressFormatFields KContacts::AddressFormat::requiredFields ( ) const

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

This information is not available for all formats.

◆ upperCaseFields()

AddressFormatFields KContacts::AddressFormat::upperCaseFields ( ) const

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

◆ usedFields()

AddressFormatFields KContacts::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.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Dec 11 2023 03:48:48 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.