KContacts::Address

View on LXR

KContacts
Address

#include <address.h>

Public Types
typedef QVector< Address >	List

typedef QFlags< TypeFlag >	Type

enum	TypeFlag { Dom = 1, Intl = 2, Postal = 4, Parcel = 8, Home = 16, Work = 32, Pref = 64 }

typedef QList< TypeFlag >	TypeList

Properties
QString	country

QString	extended

QString	formattedAddress

KContacts::Geo	geo

QString	id

bool	isEmpty

QString	label

QString	locality

QString	postalCode

QString	postOfficeBox

QString	region

QString	street

Type	type

QString	typeLabel

Public Member Functions
	Address ()

	Address (Type type)

	Address (const Address &address)

	~Address ()

void	clear ()

QString	country () const

QString	extended () const

QString	formattedAddress (const QString &realName=QString(), const QString &orgaName=QString()) const

Geo	geo () const

QString	id () const

bool	isEmpty () const

QString	label () const

QString	locality () const

bool	operator!= (const Address &other) const

Address &	operator= (const Address &other)

bool	operator== (const Address &other) const

QString	postalCode () const

QString	postOfficeBox () const

QString	region () const

void	setCountry (const QString &country)

void	setExtended (const QString &extended)

void	setGeo (const Geo &geo)

void	setId (const QString &identifier)

void	setLabel (const QString &label)

void	setLocality (const QString &locality)

void	setPostalCode (const QString &code)

void	setPostOfficeBox (const QString &postOfficeBox)

void	setRegion (const QString &region)

void	setStreet (const QString &street)

void	setType (Type type)

QString	street () const

QString	toString () const

Type	type () const

QString	typeLabel () const

Static Public Member Functions
static QString	countryLabel ()

static QString	countryToISO (const QString &cname)

static QString	extendedLabel ()

static QString	ISOtoCountry (const QString &ISOname)

static QString	labelLabel ()

static QString	localityLabel ()

static QString	postalCodeLabel ()

static QString	postOfficeBoxLabel ()

static QString	regionLabel ()

static QString	streetLabel ()

static QString	typeFlagLabel (TypeFlag type)

static QString	typeLabel (Type type)

static TypeList	typeList ()

Friends
KCONTACTS_EXPORT QDataStream &	operator<< (QDataStream &s, const Address &addr)

KCONTACTS_EXPORT QDataStream &	operator>> (QDataStream &s, Address &addr)

Detailed Description

Postal address information.

This class represents information about a postal address.

Definition at line 27 of file address.h.

Member Typedef Documentation

typedef QVector<Address> KContacts::Address::List

List of addresses.

Definition at line 58 of file address.h.

typedef QFlags< TypeFlag > KContacts::Address::Type

Stores a combination of TypeFlag values.

Definition at line 77 of file address.h.

typedef QList<TypeFlag> KContacts::Address::TypeList

List of address types.

Definition at line 83 of file address.h.

Member Enumeration Documentation

enum KContacts::Address::TypeFlag

Address types:

See also: Type

Enumerator
Dom	domestic
Intl	international
Postal	postal
Parcel	parcel
Home	home address
Work	address at work
Pref	preferred address

Definition at line 64 of file address.h.

Property Documentation

QString KContacts::Address::formattedAddress

read

Country-specific formatted address without an addressee.

This is the same as calling formattedAddress() with empty arguments.

See also: formattedAddress()

Since: 5.12

Definition at line 52 of file address.h.

Constructor & Destructor Documentation

Address::Address ( )

Creates an empty address.

Definition at line 216 of file address.cpp.

Address::Address ( Type type )

Creates an address of the given type.

Definition at line 221 of file address.cpp.

Address::Address ( const Address & address )

Copy constructor.

Definition at line 227 of file address.cpp.

Address::~Address ( )

Destroys the address.

Definition at line 232 of file address.cpp.

Member Function Documentation

void Address::clear ( )

Clears all entries of the address.

Definition at line 295 of file address.cpp.

QString KContacts::Address::country ( ) const

Returns the country.

QString Address::countryLabel ( )

static

Returns the translated label for country field.

Definition at line 478 of file address.cpp.

QString Address::countryToISO ( const QString & cname )

static

Returns ISO code for a localized country name.

Only localized country names will be understood.

Parameters

cname name of the country

Returns: two digit ISO code, empty string if the country was not recognized

Definition at line 642 of file address.cpp.

QString KContacts::Address::extended ( ) const

Returns the extended address information.

QString Address::extendedLabel ( )

static

Returns the translated label for extended field.

Definition at line 398 of file address.cpp.

QString Address::formattedAddress	(	const QString &	realName = `QString()`,
		const QString &	orgaName = `QString()`
	)		const

Returns this address formatted according to the country-specific address formatting rules.

The formatting rules applied depend on either the addresses country field, or (if the latter is empty) on the system country setting. If companyName is provided, an available business address format will be preferred.

Parameters

realName	the formatted name of the contact
orgaName	the name of the organization or company

Returns: the formatted address (containing newline characters)

Definition at line 579 of file address.cpp.

Geo KContacts::Address::geo ( ) const

Return geographic position.

QString KContacts::Address::id ( ) const

Returns the unique identifier.

bool KContacts::Address::isEmpty ( ) const

Returns true, if the address is empty.

QString Address::ISOtoCountry ( const QString & ISOname )

static

Returns a localized country name for a ISO code.

This might be replaced by a KLocale method in the future.

Parameters

ISOname two digit ISO code

Returns: localized name of the country

Definition at line 668 of file address.cpp.

QString KContacts::Address::label ( ) const

Returns the delivery label.

QString Address::labelLabel ( )

static

Returns the translated label for delivery label field.

Definition at line 494 of file address.cpp.

QString KContacts::Address::locality ( ) const

Returns the locality.

QString Address::localityLabel ( )

static

Returns the translated label for locality field.

Definition at line 430 of file address.cpp.

bool Address::operator!= ( const Address & other ) const

Not-equal operator.

Parameters

addr	the address to compare to

Returns: true if this and addr are not equal, otherwise false

Definition at line 285 of file address.cpp.

Address & Address::operator= ( const Address & other )

Assignment operator.

Parameters

addr	the address data to assign to `this`

Returns: a reference to this

Definition at line 236 of file address.cpp.

bool Address::operator== ( const Address & other ) const

Equality operator.

Parameters

addr	the address to compare to

Returns: true if this and addr are equal, otherwise false

Definition at line 245 of file address.cpp.

QString KContacts::Address::postalCode ( ) const

Returns the postal code.

QString Address::postalCodeLabel ( )

static

Returns the translated label for postal code field.

Definition at line 462 of file address.cpp.

QString KContacts::Address::postOfficeBox ( ) const

Returns the post office box.

QString Address::postOfficeBoxLabel ( )

static

Returns the translated label for post office box field.

Definition at line 382 of file address.cpp.

QString KContacts::Address::region ( ) const

Returns the region.

QString Address::regionLabel ( )

static

Returns the translated label for region field.

Definition at line 446 of file address.cpp.

void Address::setCountry ( const QString & country )

Sets the country.

Definition at line 467 of file address.cpp.

void Address::setExtended ( const QString & extended )

Sets the extended address information.

Definition at line 387 of file address.cpp.

void Address::setGeo ( const Geo & geo )

Set geographic position.

Definition at line 531 of file address.cpp.

void Address::setId ( const QString & identifier )

Sets the unique identifier.

Definition at line 300 of file address.cpp.

void Address::setLabel ( const QString & label )

Sets the delivery label.

This is the literal text to be used as label.

Parameters

label the string to use for delivery labels

Definition at line 483 of file address.cpp.

void Address::setLocality ( const QString & locality )

Sets the locality, e.g.

city.

Parameters

locality the locality of the address, e.g. city

Definition at line 419 of file address.cpp.

void Address::setPostalCode ( const QString & code )

Sets the postal code.

Definition at line 451 of file address.cpp.

void Address::setPostOfficeBox ( const QString & postOfficeBox )

Sets the post office box.

Definition at line 371 of file address.cpp.

void Address::setRegion ( const QString & region )

Sets the region, e.g.

state.

Parameters

region the region the address falls into, e.g. state

Definition at line 435 of file address.cpp.

void Address::setStreet ( const QString & street )

Sets the street (including house number).

Definition at line 403 of file address.cpp.

void Address::setType ( Type type )

Sets the type of address.

See enum for definiton of types.

Parameters

type	type, can be a bitwise or of multiple types.

Definition at line 311 of file address.cpp.

QString KContacts::Address::street ( ) const

Returns the street.

QString Address::streetLabel ( )

static

Returns the translated label for street field.

Definition at line 414 of file address.cpp.

QString Address::toString ( ) const

Returns a string representation of the address.

Definition at line 542 of file address.cpp.

Type KContacts::Address::type ( ) const

Returns the type of address.

Can be a bitwise or of multiple types.

QString KContacts::Address::typeLabel ( ) const

Returns a translated string of all types the address has.

QString Address::typeLabel ( Type type )

static

Returns the translated label for the given type.

Definition at line 322 of file address.cpp.

Address::TypeList Address::typeList ( )

static

Returns the list of available types.

Definition at line 499 of file address.cpp.

Friends And Related Function Documentation

KCONTACTS_EXPORT QDataStream& operator<<	(	QDataStream &	s,
		const Address &	addr
	)

friend

Serializes the address object into the stream.

KCONTACTS_EXPORT QDataStream& operator>>	(	QDataStream &	s,
		Address &	addr
	)

friend

Initializes the address object from the stream.

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

KDE's Doxygen guidelines are available online.

KContacts::Address

Public Types

Properties

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Property Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation