Home · All Classes · Annotated · Functions

QPhoneLine Class Reference

The QPhoneLine class provides an interface to a phone line More...

#include <QPhoneLine>

Inherits QObject.

• List of all members, including inherited members

Public Types

• class ForwardRec
• class OperatorInfo
• class PreferredOperatorInfo
• enum CallerIdRestrictionOption { Subscription, Invoked, Suppressed }
• enum ClassX { Voice, Data, Fax, Sms, ..., DedicatedPADAccess }
• enum DataState { PPPdStarted, PPPdStopped, PPPdFailed, DataActive, ..., ConnectFailed }
• enum QueryType { Number, Manufacturer, Model, Revision, ..., HandsFree }

Public Functions

• QPhoneLine ( const QString & name = QString(), QObject * parent = 0, bool mergedHandlers = false )
• ~QPhoneLine ()
• QPhoneCall active () const
• QList<QPhoneCall> calls () const
• QPhoneCall createCall ()
• QPhoneCall createCall ( QPhoneCall::CallType type )
• void modify ( QPhoneLine::QueryType type, const QString & value )
• QString name () const
• QPhoneBook * phoneBook ()
• void query ( QPhoneLine::QueryType type ) const
• QRawModem * rawModem ()
• void shutdown ()
• QSimToolkit * simToolkit ()
• QSMSRequest * sms ()
• void startData ( const QPPPdOptions & options )
• void startup ()
• void stopData ()

• 36 public functions inherited from QObject

Signals

• void newCall ( const QPhoneCall & call )
• void notification ( QPhoneLine::QueryType type, const QString & value )
• void queryResult ( QPhoneLine::QueryType type, const QString & value )

• 1 signal inherited from QObject

Static Public Members

• QString formatBarring ( bool enable, const QString & password = QString() )
• QString formatCallWaiting ( bool enable, int classx )
• QString formatCallerIdRestriction ( CallerIdRestrictionOption option )
• QString formatChangePassword ( const QString & oldPassword, const QString & newPassword )
• QString formatChannels ( QList<int> channels )
• QString formatForwarding ( bool enable, int classx, const QString & number )
• QString formatOperator ( bool automatic, const QString & opid = QString() )
• QString formatPreferredOperatorModify ( const PreferredOperatorInfo & oper )
• QString formatServiceCenter ( const QString & number )
• QList<OperatorInfo> parseAvailableOperators ( const QString & v )
• int parseCallWaiting ( const QString & v )
• QPhoneLine::CallerIdRestrictionOption parseCallerIdRestriction ( const QString & v, bool * modifiable = 0 )
• QPhoneLine::DataState parseDataState ( const QString & value )
• QList<ForwardRec> parseForwarding ( const QString & v )
• OperatorInfo parseOperator ( const QString & v, bool * automatic )
• QList<OperatorInfo> parseOperatorNames ( const QString & v )
• QList<PreferredOperatorInfo> parsePreferredOperatorList ( const QString & v )
• QString parseServiceCenter ( const QString & v )
• QList<PreferredOperatorInfo> resolveOperatorNames ( QList<PreferredOperatorInfo> & opers, QList<OperatorInfo> & names )

• 4 static public members inherited from QObject

Additional Inherited Members

• 1 property inherited from QObject
• 1 public slot inherited from QObject
• 8 protected functions inherited from QObject
• 2 protected variables inherited from QObject
• 1 static protected member inherited from QObject

Detailed Description

The QPhoneLine class provides an interface to a phone line

The QPhoneLine class abstracts the idea of a single "line" on the local device. Phones will normally only have one line, but it is theoretically possible to have multiple lines, each with its own list of calls. QString() is used in the constructor to refer to the default line.

The QPhoneLine class keeps a list of all "active" calls: those that are dialing, incoming, or connected. Idle and dropped calls are not reported in this list, and the underlying object will disappear when the last QPhoneCall reference is dropped.

[Aside: identifier instances are used to represent calls because of race conditions. e.g. a pending call arrives, the user accepts, but before the request can be fully processed, the other party hangs up and the real call object disappears. The identifier system avoids dangling references to deallocated objects. Requests to inactive calls will always "fail safe".]

Because of race conditions, callers should not assume that a request (hangup, accept, etc) succeeded without error. Callers should use the state() function to query the actual state after the request.

See also QPhoneCall and QPhoneUtils.

Member Type Documentation

enum QPhoneLine::CallerIdRestrictionOption

enum QPhoneLine::ClassX

This enum lists values that may appear in QPhoneLine::ForwardRec::classx.

enum QPhoneLine::DataState

This enum lists the flags that may be returned from QPhoneLine::parseDataState()

enum QPhoneLine::QueryType

This enum defines a number of phone features whose values can be queried or modified by applications. Unless otherwise specified, the format of the queried values will follow the GSM 07.07 and GSM 07.05 response specifications for the AT commands listed in parentheses.

Member Function Documentation

QPhoneLine::QPhoneLine ( const QString & name = QString(), QObject * parent = 0, bool mergedHandlers = false )

Create a new phone line object attached to parent. Normally name will be QString() in application programs.

The mergedHandlers parameter is temporary, and will be removed in future versions of the phone library. It creates a merged client handler that manages requests for both GSM and VoIP.

QPhoneLine::~QPhoneLine ()

Destruct a QPhoneLine object.

QPhoneCall QPhoneLine::active () const

Returns the currently active call. That is, the call that is connected and not on hold. QPhoneCall::null if there is no active call.

QList<QPhoneCall> QPhoneLine::calls () const

Returns a list of all active calls on this line. Active calls are those that are dialing, incoming, or connected. Idle and dropped calls are not included in this list.

QPhoneCall QPhoneLine::createCall ()

Create a new call in the "idle" state, ready to dial. This will not appear in the "calls()" list until it is actually dialed. The call type will be QPhoneCall::Voice.

QPhoneCall QPhoneLine::createCall ( QPhoneCall::CallType type )

This is an overloaded member function, provided for convenience.

Create a new call in the "idle" state, ready to dial. This will not appear in the "calls()" list until it is actually dialed. The call will be created with the specific type.

QString QPhoneLine::formatBarring ( bool enable, const QString & password = QString() )   [static]

Format a request for a modify operation on one of the barr settings (BarrAllOutgoing, BarrIncomingWhenRoaming, etc). The enable flag indicates if barring should be eanbled or disabled. The password parameter is the call barring password, for security purposes.

QString QPhoneLine::formatCallWaiting ( bool enable, int classx )   [static]

Format the value to use in a QPhoneLine::CallWaiting modify to enable or disable a call waiting feature. The classx parameter should be one of QPhoneLine::Voice, QPhoneLine::Data, or QPhoneLine::Fax. The enable flag indicates whether call waiting should be enabled or not.

QString QPhoneLine::formatCallerIdRestriction ( CallerIdRestrictionOption option )   [static]

QString QPhoneLine::formatChangePassword ( const QString & oldPassword, const QString & newPassword )   [static]

Format the value to use in a password modification request. The password is changed from oldPassword to newPassword.

QString QPhoneLine::formatChannels ( QList<int> channels )   [static]

Format a list of cell broadcast channels for a QPhoneLine::Channels modify.

QString QPhoneLine::formatForwarding ( bool enable, int classx, const QString & number )   [static]

Format the value for a modify on a forwarding setting (ForwardingUnconditional, ForwardingMobileBusy, etc). The enable flag indicates if forwarding should be enabled or disabled. The classx parameter indicates the class of calls the forwarding rule should apply to (voice, data, fax, etc). The number parameter indicates the phone number to forward calls to.

QString QPhoneLine::formatOperator ( bool automatic, const QString & opid = QString() )   [static]

Format the value to use in a QPhoneLine::Operator modify. The opid is the identifier for the operator to select, which usually comes from the id field of a QPhoneLine::OperatorInfo object. If automatic is true, then the operator will be selected automatically. Otherwise the operator will be selected manually.

QString QPhoneLine::formatPreferredOperatorModify ( const PreferredOperatorInfo & oper )   [static]

Format a modification request for the preferred operator list, to update the details associated with oper.

QString QPhoneLine::formatServiceCenter ( const QString & number )   [static]

Format a phone number for a QPhoneLine::ServiceCenter modify.

void QPhoneLine::modify ( QPhoneLine::QueryType type, const QString & value )

Modify a particular piece of information for this line. The information identified by type is set to value.

QString QPhoneLine::name () const

Return the name of this line.

void QPhoneLine::newCall ( const QPhoneCall & call )   [signal]

Notification of a new call being added to the "calls()" list.

void QPhoneLine::notification ( QPhoneLine::QueryType type, const QString & value )   [signal]

Asynchronous notification of an interesting value that wasn't explicitly requested by a query call. The type parameter indicates the type of notification and its new value is value.

QList<OperatorInfo> QPhoneLine::parseAvailableOperators ( const QString & v )   [static]

Parse the value v returned from a QPhoneLine::AvailableOperators query into a list of QPhoneLine::OperatorInfo objects.

int QPhoneLine::parseCallWaiting ( const QString & v )   [static]

Parse the value v returned by a QPhoneLine::CallWaiting query. The return value contains the flags QPhoneLine::Voice, QPhoneLine::Data, and QPhoneLine::Fax, indicating which classes of calls have call waiting enabled.

QPhoneLine::CallerIdRestrictionOption QPhoneLine::parseCallerIdRestriction ( const QString & v, bool * modifiable = 0 )   [static]

Parse the value v returned by a QPhoneLine::CallerIdRestriction query. Returns the current status and the modifiable parameter is set to true if the caller ID restriction can be modified.

QPhoneLine::DataState QPhoneLine::parseDataState ( const QString & value )   [static]

Parse the value from a DataStateUpdate notification into a set of QPhoneLine::DataState flags.

QList<ForwardRec> QPhoneLine::parseForwarding ( const QString & v )   [static]

Parse the value v returned by a query on a forwarding setting (ForwardingUnconditional, ForwardingMobileBusy, etc).

OperatorInfo QPhoneLine::parseOperator ( const QString & v, bool * automatic )   [static]

Parse the value v returned by a QPhoneLine::Operator query. The automatic parameter will be set to true if the phone will register automatically to the network operator.

QList<OperatorInfo> QPhoneLine::parseOperatorNames ( const QString & v )   [static]

Parse the list v of operator names that resulted from an "OperatorNames" query. The "status" field in the returned structures is unused.

QList<PreferredOperatorInfo> QPhoneLine::parsePreferredOperatorList ( const QString & v )   [static]

Parse the preferred operator list v that resulted from a "PreferredOperatorList" query.

QString QPhoneLine::parseServiceCenter ( const QString & v )   [static]

Parse the value v returned by a QPhoneLine::ServiceCenter query.

QPhoneBook * QPhoneLine::phoneBook ()

Returns the phone book manager for the phone line.

void QPhoneLine::query ( QPhoneLine::QueryType type ) const

Sends a query for a particular piece of information as specified by type about this line. The requested information is returned by the signal queryResult.

See also QueryType.

void QPhoneLine::queryResult ( QPhoneLine::QueryType type, const QString & value )   [signal]

Notification of a value that was being queried for. The type parameter indicates the type that was supplied to QPhoneLine::query(), and its new value is value.

QRawModem * QPhoneLine::rawModem ()

Returns the raw modem handler for the phone line.

QList<PreferredOperatorInfo> QPhoneLine::resolveOperatorNames ( QList<PreferredOperatorInfo> & opers, QList<OperatorInfo> & names )   [static]

Resolve numeric operator identifiers within the opers list using the name associations in names. The names list is typically the result of the "OperatorNames" query.

void QPhoneLine::shutdown ()

Perform a power saving shutdown on the modem.

QSimToolkit * QPhoneLine::simToolkit ()

Returns the SIM toolkit handler for the phone line.

QSMSRequest * QPhoneLine::sms ()

Returns the SMS request handler for the phone line.

void QPhoneLine::startData ( const QPPPdOptions & options )

Start a new data call with the specified options.

void QPhoneLine::startup ()

Perform a startup on the modem after a power save.

void QPhoneLine::stopData ()

Stop an active data call, killing the protocol module (e.g. pppd) that is handling it.