QSimControlEvent Class Reference
[QtTelephonyModule]

Detailed Description

The QSimControlEvent class specifies the contents of a CALL CONTROL or MO SHORT MESSAGE CONTROL result event.

When the user initiates phone calls or sends SMS messages on a SIM-equipped mobile phone, the SIM can make modifications to the request before it is sent to the network, or deny the request outright. This process is described in section 9 of 3GPP TS 11.14.

Once the SIM has determined whether it will allow the operation to proceed or not, an event is sent to the modem indicating the result. This event may include a text() string to be displayed to the user.

The particular type of SIM control event is specified by the type() function. Other functions, such as result(), text(), etc, are used to specify type-specific parameters for the event.

Events are delivered to client applications via the QSimToolkit::controlEvent() signal.

See also QSimToolkit::controlEvent().

Member Type Documentation

enum QSimControlEvent::Result

This enum defines the result of a SIM control event.

enum QSimControlEvent::Type

This enum defines the type of SIM control event for QSimControlEvent.

Member Function Documentation

QSimControlEvent::QSimControlEvent ()

Construct a new SIM control object with default parameters.

QSimControlEvent::QSimControlEvent ( const QSimControlEvent & value )

Construct a new SIM control object as a copy of value.

QSimControlEvent::~QSimControlEvent ()

Destruct a SIM control object.

void QSimControlEvent::addExtensionField ( int tag, const QByteArray & value )

Adds an extension field to the data from extensionData(). The field will have the specified tag and contents given by value.

See also extensionField().

QByteArray QSimControlEvent::extensionData () const

Returns the extension data for this SIM control event. The extension data is appended after all other fields, and consists of zero or more BER tag-length-value field specifications.

See also setExtensionData() and extensionField().

QByteArray QSimControlEvent::extensionField ( int tag ) const

Returns the contents of an extension field. The tag is an 8-bit value, from 3GPP TS 11.14, that specifies the particular field the caller is interested in. The most significant bit of tag is ignored when searching for the field, as it contains the "must comprehend" status from 3GPP TS 11.14, and is not important for locating the desired field.

This is a simpler method than extensionData() for accessing values within the extension data.

See also addExtensionField().

QSimControlEvent QSimControlEvent::fromPdu ( QSimControlEvent::Type type, const QByteArray & pdu )   [static]

Returns a SIM control event object corresponding to the data in pdu. The type indicates the type of SIM control event that is being decoded from pdu: Call or Sms. The data is decoded as described in 3GPP TS 11.14.

See also toPdu().

QSimControlEvent::Result QSimControlEvent::result () const

Returns the result of this SIM control event.

See also setResult().

void QSimControlEvent::setExtensionData ( QByteArray value )

Sets the extension data for this SIM control event to value. The extension data is appended after all other fields, and consists of zero or more BER tag-length-value field specifications.

See also extensionData() and addExtensionField().

void QSimControlEvent::setResult ( QSimControlEvent::Result value )

Sets the result of this SIM control event to value. The default value is Allowed.

See also result().

void QSimControlEvent::setText ( const QString & value )

Sets the text string associated with this SIM control event to value.

See also text().

void QSimControlEvent::setType ( QSimControlEvent::Type value )

Sets the type of this SIM control event to value.

See also type().

QString QSimControlEvent::text () const

Returns the text string associated with this SIM control event. If this string is not empty, it should be displayed to the user to inform them of the SIM control operation.

See also setText().

QByteArray QSimControlEvent::toPdu () const

Returns the PDU form of this SIM control event, encoded as described in 3GPP TS 11.14.

See also fromPdu().

QSimControlEvent::Type QSimControlEvent::type () const

Returns the type of SIM control event: Call or Sms. The default value is Call.

See also setType().

QSimControlEvent & QSimControlEvent::operator= ( const QSimControlEvent & value )

Copy the QSimControlEvent value.