KABC::AddresseeHelper Class Reference

#include <addresseehelper.h>

Inherits QObject.

Public Slots
void	initSettings ()

Public Member Functions
bool	containsPrefix (const QString &prefix) const
bool	containsSuffix (const QString &suffix) const
bool	containsTitle (const QString &title) const
bool	tradeAsFamilyName () const

Static Public Member Functions
static AddresseeHelper *	self ()

Detailed Description

This singleton class stores static data, which is shared by all Addressee objects.

It maintains three lists of strings, which can be queried using this class:

• a list of honoric prefixes, like "Mrs.", "Prof." etc, see containsTitle()
• a list of inclusions, such as "van" or "de", see containsPrefix()
• a list of honoric suffixes, such as "I" or "Jr.", see containsSuffix()

All of these lists have a hardcoded and a configurable part. The configurable part is found in kabcrc, group General, fields Prefixes, Inclusions, and Suffixes.

In addition to the above, this class stores one conveniece setting: it stores whether or not a single name component should be interpreted as a family name (see tradeAsFamilyName()). The corresponding configuration field is TradeAsFamilyName.

Definition at line 54 of file addresseehelper.h.

Member Function Documentation

bool AddresseeHelper::containsPrefix

(

const QString &

prefix

)

const

Queries the list of inclusions.

Parameters

prefix

the inclusion to search for

Returns

true, if prefix was found in the list, false otherwise

Definition at line 103 of file addresseehelper.cpp.

bool AddresseeHelper::containsSuffix

(

const QString &

suffix

)

const

Queries the list of honoric suffixes.

Parameters

suffix

the honoric suffix to search for

Returns

true, if suffix was found in the list, false otherwise

Definition at line 108 of file addresseehelper.cpp.

bool AddresseeHelper::containsTitle

(

const QString &

title

)

const

Queries the list of honoric prefixes.

Parameters

title

the honoric prefix to search for

Returns

true, if title was found in the list, false otherwise

Definition at line 98 of file addresseehelper.cpp.

void AddresseeHelper::initSettings ( )

slot

Recreates the static data and reparses the configuration.

Definition at line 66 of file addresseehelper.cpp.

AddresseeHelper * AddresseeHelper::self ( )

static

Singleton interface to this class.

Returns

a pointer to the unique instance of this class.

Definition at line 34 of file addresseehelper.cpp.

bool AddresseeHelper::tradeAsFamilyName

(

)

const

Returns whether or not a single name component should be interpreted as a family name.

Returns

true if single name component is a family name, false otherwise.

Definition at line 113 of file addresseehelper.cpp.

---

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

• addresseehelper.h
• addresseehelper.cpp