Qtopia Home - Classes - Hierachy - Annotated - Functions - Licenses - Reference

PhoneBook Class Reference

The PhoneBook class provides an interface to the phonebook of a device. More...

#include <phonebook.h>

Inherits QObject.

List of all member functions.

Public Members

PhoneLine & line () const
void getEntries ( const QString & store = "SM" )
void add ( const QString & number, const QString & text, const QString & store = "SM", bool flush = TRUE )
void remove ( uint index, const QString & store = "SM", bool flush = TRUE )
void update ( uint index, const QString & number, const QString & text, const QString & store = "SM", bool flush = TRUE )
void flush ( const QString & store = "SM" )
void setPassword ( const QString & store, const QString & passwd )
void clearPassword ( const QString & store )

Signals

void entries ( const PhoneLine & line, const QString & store, const QValueList<PhoneBookEntry> & list )

Detailed Description

The PhoneBook class provides an interface to the phonebook of a device.

See also PhoneBookEntry and Qtopia Phone Classes.

Phone devices contain a number of internal phone books. The principal one of these is SM, representing the phone book on the user's SIM card. The PhoneBook class allows applications to access the contents of such phone books.

Member Function Documentation

void PhoneBook::add ( const QString & number, const QString & text, const QString & store = "SM", bool flush = TRUE )

Add an entry to a storage area. If flush is TRUE, then flush the modifications immediately; otherwise wait for an explicit call to the PhoneBook::flush method.

void PhoneBook::clearPassword ( const QString & store )

Clear a store password that was set using "setPassword". This should be called after "flush".

void PhoneBook::entries ( const PhoneLine & line, const QString & store, const QValueList<PhoneBookEntry> & list ) `[signal]`

Signal that is emitted to deliver the list of entries in a particular storage area. Occurs whenever the list is explicitly requested with PhoneBook::getEntries, or the list is modified by PhoneBook::add, PhoneBook::remove, or PhoneBook::update.

void PhoneBook::flush ( const QString & store = "SM" )

Flush all pending operations on a storage area.

void PhoneBook::getEntries ( const QString & store = "SM" )

Get all entries in a particular storage area. The most common storage area is called SM, indicating the phone book on the user's SIM card.

PhoneLine & PhoneBook::line () const

Returns the phone line that this phone book manager is associated with.

void PhoneBook::remove ( uint index, const QString & store = "SM", bool flush = TRUE )

Remove an entry from a storage area. If flush is TRUE, then flush the modifications immediately; otherwise wait for an explicit call to the PhoneBook::flush method.

void PhoneBook::setPassword ( const QString & store, const QString & passwd )

Set the password to use to access a particular store. This is typically the SIM PIN2 password for the "FD" (fixed dialing) store. This should be called before the first call on "getEntries", "add", etc.

void PhoneBook::update ( uint index, const QString & number, const QString & text, const QString & store = "SM", bool flush = TRUE )

Update an entry in a storage area. If flush is TRUE, then flush the modifications immediately; otherwise wait for an explicit call to the PhoneBook::flush method.

Trademarks

Qtopia version 2.2.0