Home · All Classes · Grouped Classes · Annotated · Functions

QSimCommand Class Reference

The QSimCommand class specifies the details of a SIM toolkit command message. More...

    #include <QSimCommand>

Public Types

Public Functions

Static Public Members


Detailed Description

The QSimCommand class specifies the details of a SIM toolkit command message.

Applications that run within a SIM send commands to the host program to interact with the user. These commands might entail choosing an item from a menu, asking if it is OK to dial a phone number, asking for a line of input, displaying text messages, etc.

The QSimCommand class encapsulates a single SIM toolkit command, containing all of the information about it. QSimCommand objects are delivered to the host program by way of the QSimToolkit::command() signal.

In Qtopia, the host program is simapp.

See also QSimToolkit, QSimMenuItem, and QSimTerminalResponse.


Member Type Documentation

enum QSimCommand::BrowserLaunchMode

This enum defines the launch mode to use when displaying web pages in the browser.

ConstantValueDescription
QSimCommand::IfNotAlreadyLaunched0Launch browser, if not already launched.
QSimCommand::UseExisting2Use the existing browser, but not if it is running a secured session.
QSimCommand::CloseExistingAndLaunch3Close the existing browser session and launch a new browser session.

enum QSimCommand::CallClass

This enum defines the class of call that is being created by a SetupCall command.

ConstantValueDescription
QSimCommand::Voice0Voice call
QSimCommand::Data1Data call
QSimCommand::Fax2Fax call

enum QSimCommand::Device

This enum defines the source or destination device for a SIM command, according to 3GPP TS 11.14, section 12.7.

ConstantValueDescription
QSimCommand::Keypad0x01Keypad device
QSimCommand::Display0x02Display device
QSimCommand::Earpiece0x03Earpiece device
QSimCommand::CardReader00x10Additional card reader 0
QSimCommand::CardReader10x11Additional card reader 1
QSimCommand::CardReader20x12Additional card reader 2
QSimCommand::CardReader30x13Additional card reader 3
QSimCommand::CardReader40x14Additional card reader 4
QSimCommand::CardReader50x15Additional card reader 5
QSimCommand::CardReader60x16Additional card reader 6
QSimCommand::CardReader70x17Additional card reader 7
QSimCommand::Channel10x21Data channel 1
QSimCommand::Channel20x22Data channel 2
QSimCommand::Channel30x23Data channel 3
QSimCommand::Channel40x24Data channel 4
QSimCommand::Channel50x25Data channel 5
QSimCommand::Channel60x26Data channel 6
QSimCommand::Channel70x27Data channel 7
QSimCommand::SIM0x81SIM device
QSimCommand::ME0x82ME (mobile equipment) device
QSimCommand::Network0x83Source or destination is the network

enum QSimCommand::Disposition

This enum defines the disposition of other calls when a SetupCall command is executed by the SIM toolkit application.

ConstantValueDescription
QSimCommand::IfNoOtherCalls0Perform the setup only if there are no other calls.
QSimCommand::PutOnHold1Put other calls on hold when the new call is setup.
QSimCommand::Disconnect2Disconnect other calls when the new call is setup.

enum QSimCommand::Event

This enum defines the types of events that the SIM expects to be reported.

ConstantValueDescription
QSimCommand::NoEvent0No event type specified.
QSimCommand::IdleScreen1Report an event when the system is idle.
QSimCommand::UserActivity2Report an event when there is user activity.
QSimCommand::Both3Report for both system idle and user activity.
QSimCommand::Cancel4Cancel event reporting.

enum QSimCommand::MenuPresentation

This enum defines the type of presentation to use for SIM toolkit menus.

ConstantValueDescription
QSimCommand::AnyPresentation0The user interface may use any presentation it wishes.
QSimCommand::DataValuesPresentation1The user interface should present the menu as a choice of several data values.
QSimCommand::NavigationOptionsPresentation2The user interface should present the menu as a choice of several navigation options.

enum QSimCommand::RefreshType

This enum defines the type of refresh that was performed by the SIM.

ConstantValueDescription
QSimCommand::InitAndFullFileChange0SIM initialization and full file change notification.
QSimCommand::FileChange1File change notification.
QSimCommand::InitAndFileChange2SIM initialization and file change notification.
QSimCommand::Initialization3SIM initialization.
QSimCommand::Reset4SIM reset.

enum QSimCommand::ToPduOptions

This enum defines additional options to use when encoding SIM commands with QSimCommand::toPdu().

ConstantValueDescription
QSimCommand::NoPduOptions0x00No additional options.
QSimCommand::NoBerWrapper0x01Do not include the outermost BER wrapper around the command parameters.
QSimCommand::PackedStrings0x02Encode text strings in the packed 7-bit GSM alphabet instead of the unpacked 8-bit GSM alphabet. If a text string cannot be encoded with the GSM alphabet, UCS-2 will be used.
QSimCommand::UCS2Strings0x04Encode text strings in the UCS-2 alphabet, even if it could otherwise be encoded in the packed 7-bit or unpacked 8-bit GSM alphabet.
QSimCommand::EncodeEmptyStrings0x08Encode empty strings in the actual character set, instead of using the shorthand encoding.

enum QSimCommand::Tone

This enum defines the tones that can be played by a PlayTone command.

ConstantValueDescription
QSimCommand::ToneNone-1No tone specified.
QSimCommand::ToneDial0x01Currently dialing
QSimCommand::ToneBusy0x02Called party is busy
QSimCommand::ToneCongestion0x03Network is congested
QSimCommand::ToneRadioAck0x04Radio acknowledged
QSimCommand::ToneDropped0x05Connection has been dropped
QSimCommand::ToneError0x06An error occurred
QSimCommand::ToneCallWaiting0x07An incoming call is waiting
QSimCommand::ToneRinging0x08Ring to indicate and incoming call
QSimCommand::ToneGeneralBeep0x10A general beep tone
QSimCommand::TonePositiveBeep0x11A beep indicating a positive outcome
QSimCommand::ToneNegativeBeep0x12A beep indicating a negative outcome

enum QSimCommand::Type

This enum defines the type of a SIM toolkit message within a QSimCommand object.

ConstantValueDescription
QSimCommand::NoCommand-1No command type currently set.
QSimCommand::Timeout-2Indicate that an operation has timed out.
QSimCommand::Refresh0x01Notification of a SIM refresh.
QSimCommand::MoreTime0x02The SIM toolkit application is asking for more time. This command type is handled automatically by the modem or the modem vendor plugin, so client applications will not see this command type via QSimToolkit::command().
QSimCommand::PollInterval0x03The SIM toolkit application is setting the polling interval for new commands. This command type is handled automatically by the modem or the modem vendor plugin, so client applications will not see this command type via QSimToolkit::command().
QSimCommand::PollingOff0x04This SIM toolkit application is asking for polling to be turned off. This command type is handled automatically by the modem or the modem vendor plugin, so client applications will not see this command type via QSimToolkit::command().
QSimCommand::SetupEventList0x05Set up the list of events to be reported to the SIM toolkit application.
QSimCommand::SetupCall0x10Set up a phone call to a specific number.
QSimCommand::SendSS0x11Notification that the application is sending a SS message.
QSimCommand::SendSMS0x13Notification that the application is sending a SMS message.
QSimCommand::SendUSSD0x12Notification that the application is sending a USSD message.
QSimCommand::SendDTMF0x14Notification that the application is sending a DTMF tone.
QSimCommand::LaunchBrowser0x15Launch a Web browser on a URL.
QSimCommand::PlayTone0x20Play a tone to the user.
QSimCommand::DisplayText0x21Display a text message.
QSimCommand::GetInkey0x22Get a single key of input.
QSimCommand::GetInput0x23Get a line of input.
QSimCommand::SelectItem0x24Process a submenu within a SIM toolkit application.
QSimCommand::SetupMenu0x25Process the main menu of a SIM toolkit application.
QSimCommand::ProvideLocalInformation0x26The SIM toolkit application is asking for local information to be supplied. This command type is handled automatically by the modem or the modem vendor plugin, so client applications will not see this command type via QSimToolkit::command().
QSimCommand::TimerManagement0x27The SIM toolkit application is activating or deactivating timers. This command type is handled automatically by the modem or the modem vendor plugin, so client applications will not see this command type via QSimToolkit::command().
QSimCommand::SetupIdleModeText0x28Set the text to be displayed when the phone is idle.
QSimCommand::PerformCardAPDU0x30Send an APDU to the additional card reader. This command type is handled automatically by the modem or the modem vendor plugin, so client applications will not see this command type via QSimToolkit::command().
QSimCommand::PowerOnCard0x31Power on an additional card reader. This command type is handled automatically by the modem or the modem vendor plugin, so client applications will not see this command type via QSimToolkit::command().
QSimCommand::PowerOffCard0x32Power off an additional card reader. This command type is handled automatically by the modem or the modem vendor plugin, so client applications will not see this command type via QSimToolkit::command().
QSimCommand::GetReaderStatus0x33Get the status of an additional card reader. This command type is handled automatically by the modem or the modem vendor plugin, so client applications will not see this command type via QSimToolkit::command().
QSimCommand::RunATCommand0x34Run an AT command against the modem
QSimCommand::LanguageNotification0x35Inform the user about the language the SIM toolkit application will be displaying messages in.
QSimCommand::OpenChannel0x40Open a data channel.
QSimCommand::CloseChannel0x41Close a data channel.
QSimCommand::ReceiveData0x42Receive data on a data channel.
QSimCommand::SendData0x43Send data on a data channel.
QSimCommand::GetChannelStatus0x44Get the current status of a data channel.
QSimCommand::EndSession0x81Indicate that the SIM toolkit session has ended
QSimCommand::SetupMainMenuSetupMenuAlias for SetupMenu, provided for backwards compatiblity.
QSimCommand::SetupSubMenuSelectItemAlias for SelectItem, provided for backwards compatiblity.


Member Function Documentation

QSimCommand::QSimCommand ()

Construct a new SIM toolkit command object with default parameters.

QSimCommand::QSimCommand ( const QSimCommand & value )

Construct a new SIM toolkit command object as a copy of value.

QSimCommand::~QSimCommand ()

Destruct a SIM toolkit command object.

void QSimCommand::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.

Applies to: all commands.

See also extensionField().

QSimCommand::BrowserLaunchMode QSimCommand::browserLaunchMode () const

Returns the browser launch mode. The default value is IfNotAlreadyLaunched.

Applies to: LaunchBrowser.

See also setBrowserLaunchMode().

QSimCommand::CallClass QSimCommand::callClass () const

Returns the class of call to be setup (Voice, Data, or Fax). The default value is Voice.

Applies to: SetupCall.

See also setCallClass().

bool QSimCommand::clearAfterDelay () const

Returns true if the text should be automatically cleared after a small delay (usually 3 seconds); otherwise returns false. If this is false, then the client must call QSimToolkit::clearText() to move on to the next SIM application state. The default value is true.

Applies to: DisplayText.

Note: in Qtopia 4.3 and newer, the default value is true. If Qtopia 4.2 and older, the default value was false. The change was due to the introduction of the qualifier() value.

See also setClearAfterDelay().

int QSimCommand::commandNumber () const

Returns the SIM command number. The default value is 1. The command number may be something other than 1 if more than one SIM command is being processed simultaneously, but this is a fairly rare occurence. The main use for command numbers is to match commands and responses.

Applies to: all commands

See also setCommandNumber().

uint QSimCommand::defaultItem () const

Returns the index of the default item in the menu, or zero if no default.

Applies to: SelectItem.

See also setDefaultItem().

QString QSimCommand::defaultText () const

Returns the default text for GetInput commands.

Applies to: GetInput

See also setDefaultText().

QSimCommand::Device QSimCommand::destinationDevice () const

Returns the destination device for the command. The default value is ME.

Applies to: all commands.

See also setDestinationDevice().

QSimCommand::Disposition QSimCommand::disposition () const

Returns the disposition of other calls when a call setup occurs. The default value is IfNoOtherCalls.

Applies to: SetupCall.

See also setDisposition().

uint QSimCommand::duration () const

Returns the number of milliseconds to play a tone or the poll interval. The default value is zero, indicating that the default duration should be used.

Applies to: PlayTone, PollInterval.

See also setDuration() and tone().

bool QSimCommand::echo () const

Returns true if input should be echoed; otherwise returns false. The default value is true.

Applies to: GetInput.

Note: in Qtopia 4.3 and newer, the default value is true. If Qtopia 4.2 and older, the default value was false. The change was due to the introduction of the qualifier() value.

See also setEcho().

QSimCommand::Event QSimCommand::events () const

Returns the events to be reported.

Applies to: SetupEventList.

Note: this function can only return information about IdleScreen and UserActivity events. To access information about all SIM toolkit events in the command, use extensionField() with a tag value of 0x99.

See also setEvents().

QByteArray QSimCommand::extensionData () const

Returns the extension data for this SIM command. The extension data consists of zero or more BER tag-length-value fields for fields that are not otherwise handled by some other method in this class.

Applies to: all commands.

See also setExtensionData() and extensionField().

QByteArray QSimCommand::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. As an example, the following code extracts the "SMS TPDU" information from a SendSMS SIM command:

    QSimCommand cmd;
    ...
    QByteArray tpdu = cmd.extensionField(0x8B);

Applies to: all commands.

See also addExtensionField().

QSimCommand QSimCommand::fromPdu ( const QByteArray & pdu )   [static]

Decode a SIM command from its raw binary pdu form, as according to 3GPP TS 11.14. The binary data is assumed to be in BER form, starting with the command tag. If the data starts with a "Proactive SIM" BER command wrapper, it will be skipped. Returns the decoded SIM command.

See also toPdu().

bool QSimCommand::hasHelp () const

Returns true if there is help available for this command; otherwise returns false. The help flag is the most significant bit of the qualifier() byte.

Applies to: SetupMenu, GetInkey, GetInput, SelectItem.

See also setHasHelp().

bool QSimCommand::highPriority () const

Returns true if a DisplayText command should attempt to display the text as high priority (true) or normal priority (false). The default value is false.

Applies to: DisplayText.

See also setHighPriority().

uint QSimCommand::iconId () const

Returns the icon identifier associated with this command. Returns zero if there is no icon.

Applies to: DisplayText, GetInkey, GetInput, PlayTone, SelectItem, SendSMS, SendSS, SetupCall, SetupMenu, LaunchBrowser, SetupIdleModeText

See also setIconId().

bool QSimCommand::iconSelfExplanatory () const

Returns true if the icon specified by iconId() is self-explanatory without the display of text(). If this function returns false, then text() should be displayed next to the icon. If iconId() returns zero, then iconSelfExplanatory() should be ignored.

Applies to: DisplayText, GetInkey, GetInput, PlayTone, SelectItem, SendSMS, SendSS, SetupCall, SetupMenu, LaunchBrowser, SetupIdleModeText

See also setIconSelfExplanatory().

bool QSimCommand::immediateResponse () const

Returns true if a DisplayText command should result in an immediate response to the SIM without asking the user to confirm the text first; or false if the user should confirm, or the response should be sent after the usual delay if clearAfterDelay() is set. The default value is false.

Applies to: DisplayText

See also setImmediateResponse() and clearAfterDelay().

uint QSimCommand::maximumLength () const

Returns the maximum text length for input. The default value is 255, which indicates that the text is unlimited in length.

Applies to: GetInput.

See also setMaximumLength().

QList<QSimMenuItem> QSimCommand::menuItems () const

Returns the list of menu items in the menu.

Applies to: SetupMenu, SelectItem.

See also setMenuItems().

QSimCommand::MenuPresentation QSimCommand::menuPresentation () const

Returns the menu presentation type to use for SelectItem commands. The default value is AnyPresentation.

Applies to: SelectItem.

See also setMenuPresentation() and softKeysPreferred().

uint QSimCommand::minimumLength () const

Returns the minimum text length for input. The default value is 0.

Applies to: GetInput.

See also setMinimumLength().

QString QSimCommand::number () const

Returns the phone number for SetupCall, address for SendSMS, the supplementary service string for SendSS, the unstructured supplementary service string for SendUSSD, or the sequence of DTMF digits for SendDTMF.

Applies to: SetupCall, SendSMS, SendSS, SendUSSD, SendDTMF.

See also setNumber().

uint QSimCommand::otherIconId () const

Returns the other icon identifier associated with this command. Returns zero if there is no icon. This is typically used with SetupCall commands to specify the icon to be displayed during the call setup phase, when iconId() is used for the user confirmation phase.

Applies to: SetupCall

See also setOtherIconId().

bool QSimCommand::otherIconSelfExplanatory () const

Returns true if the icon specified by otherIconId() is self-explanatory without the display of otherText(). If this function returns false, then otherText() should be displayed next to the icon. If otherIconId() returns zero, then otherIconSelfExplanatory() should be ignored.

Applies to: SetupCall

See also setOtherIconSelfExplanatory().

QString QSimCommand::otherText () const

Returns the other text to be displayed as a message. This is typically used with SetupCall commands to specify the text to be displayed during the call setup phase, when text() is used for the user confirmation phase.

Applies to: SetupCall

See also setOtherText().

bool QSimCommand::packedInput () const

Returns true if the GetInput command should return packed 7-bit input strings to the SIM; false if the commands should return strings in the unpacked 8-bit alphabet instead. The default value is false.

This setting is ignored if either wantYesNo() or ucs2Input() returns true.

Applies to: GetInput

See also setPackedInput(), wantYesNo(), and ucs2Input().

int QSimCommand::qualifier () const

Returns the qualifier byte from the header of the SIM command. The qualifier byte contains flags that modify the behavior of the command from its default. The default value is zero.

Other functions such as hasHelp(), wantDigits(), highPriority(), etc provide a more convenient method to access the bits within the qualifier byte.

Applies to: all commands.

See also setQualifier().

QSimCommand::RefreshType QSimCommand::refreshType () const

Returns the type of refresh to that was performed by the SIM. The default value is InitAndFullFileChange.

Applies to: Refresh.

See also setRefreshType().

void QSimCommand::setBrowserLaunchMode ( QSimCommand::BrowserLaunchMode value )

Sets the browser launch mode to value.

Applies to: LaunchBrowser.

See also browserLaunchMode().

void QSimCommand::setCallClass ( QSimCommand::CallClass value )

Sets the class of call to be setup (Voice, Data, or Fax) to value.

Applies to: SetupCall.

See also callClass().

void QSimCommand::setClearAfterDelay ( bool value )

Sets the clear after delay flag for text display to value. If type() is not DisplayText, the request is ignored.

Applies to: DisplayText.

See also clearAfterDelay().

void QSimCommand::setCommandNumber ( int value )

Sets the SIM command number to value. The usual value for the command number is 1. The command number may be set to something other than 1 if more than one SIM command is being processed simultaneously, but this is a fairly rare occurence. The main use for command numbers is to match commands and responses.

Applies to: all commands

See also commandNumber().

void QSimCommand::setDefaultItem ( uint value )

Sets the index of the default item in the menu, or zero if no default, to value.

Applies to: SelectItem.

See also defaultItem().

void QSimCommand::setDefaultText ( const QString & value )

Sets the default text for GetInput commands to value.

Applies to: GetInput

See also defaultText().

void QSimCommand::setDestinationDevice ( QSimCommand::Device value )

Sets the destination device for the command to value.

Applies to: all commands.

See also destinationDevice().

void QSimCommand::setDisposition ( QSimCommand::Disposition value )

Sets the disposition of other calls when a call setup occurs to value.

Applies to: SetupCall.

See also disposition().

void QSimCommand::setDuration ( uint value )

Sets the duration of a poll interval or to play a tone to value milliseconds.

Applies to: PlayTone, PollInterval.

See also duration() and tone().

void QSimCommand::setEcho ( bool value )

Sets the flag that determines if input should be echoed to value.

Applies to: GetInput.

See also echo().

void QSimCommand::setEvents ( QSimCommand::Event value )

Sets the events to be reported to value.

Applies to: SetupEventList.

Note: this function can only set information about IdleScreen and UserActivity events. To set information about other SIM toolkit events, use setExtensionField() with a tag value of 0x99.

See also events().

void QSimCommand::setExtensionData ( QByteArray value )

Sets the extension data for this SIM command to value. The extension data consists of zero or more BER tag-length-value fields for fields that are not otherwise handled by some other method in this class.

Applies to: all commands.

See also extensionData() and addExtensionField().

void QSimCommand::setHasHelp ( bool value )

Sets the flag that determines if there is help available for this command to value. The help flag is the most significant bit of the qualifier() byte.

Applies to: SetupMenu, GetInkey, GetInput, SelectItem.

See also hasHelp().

void QSimCommand::setHighPriority ( bool value )

Sets the high priority text display flag to value. If type() is not DisplayText, then the request is ignored.

Applies to: DisplayText.

See also highPriority().

void QSimCommand::setIconId ( uint value )

Sets the icon identifier associated with this menu item to value.

Applies to: DisplayText, GetInkey, GetInput, PlayTone, SelectItem, SendSMS, SendSS, SetupCall, SetupMenu, LaunchBrowser, SetupIdleModeText

See also iconId().

void QSimCommand::setIconSelfExplanatory ( bool value )

Sets the self-explanatory flag to value.

Applies to: DisplayText, GetInkey, GetInput, PlayTone, SelectItem, SendSMS, SendSS, SetupCall, SetupMenu, LaunchBrowser, SetupIdleModeText

See also iconSelfExplanatory().

void QSimCommand::setImmediateResponse ( bool value )

Sets the immediate response flag to value. If value is true, then the DisplayText command should result in an immediate response to the SIM without asking the user to confirm the text first. If value is false, the user should confirm, or the response should be sent after the usual delay if clearAfterDelay() is set.

Applies to: DisplayText

See also immediateResponse() and clearAfterDelay().

void QSimCommand::setMaximumLength ( uint value )

Sets the maximum text length for input to value.

Applies to: GetInput.

See also maximumLength().

void QSimCommand::setMenuItems ( const QList<QSimMenuItem> & value )

Sets the list of menu items in the menu to value.

Applies to: SetupMenu, SelectItem.

See also menuItems().

void QSimCommand::setMenuPresentation ( QSimCommand::MenuPresentation value )

Sets the menu presentation type to use for SelectItem commands to value.

Applies to: SelectItem.

See also menuPresentation() and softKeysPreferred().

void QSimCommand::setMinimumLength ( uint value )

Sets the minimum text length for input to value.

Applies to: GetInput.

See also minimumLength().

void QSimCommand::setNumber ( const QString & value )

Sets the phone number for SetupCall, address for SendSMS, the supplementary service string for SendSS, unstructured supplementary service string for SendUSSD, to value, or the sequence of DTMF digits for SendDTMF.

Applies to: SetupCall, SendSMS, SendSS, SendUSSD, SendDTMF.

See also number().

void QSimCommand::setOtherIconId ( uint value )

Sets the other icon identifier associated with this menu item to value. This is typically used with SetupCall commands to specify the icon to be displayed during the call setup phase, when iconId() is used for the user confirmation phase.

Applies to: SetupCall

See also otherIconId().

void QSimCommand::setOtherIconSelfExplanatory ( bool value )

Sets the self-explanatory flag for the icon specified by otherIconId to value.

Applies to: SetupCall

See also otherIconSelfExplanatory().

void QSimCommand::setOtherText ( const QString & value )

Sets the other text to be displayed to value. This is typically used with SetupCall commands to specify the text to be displayed during the call setup phase, when text() is used for the user confirmation phase.

Applies to: SetupCall

See also otherText().

void QSimCommand::setPackedInput ( bool value )

Sets the packed input flag to value. If value is true, then the GetInput command should send packed 7-bit input strings to the SIM. If value is false, then the commands should send strings in the unpacked 8-bit alphabet instead.

This setting is ignored if either wantYesNo() or ucs2Input() returns true, of if type() is not GetInput.

Applies to: GetInput

See also packedInput(), wantYesNo(), and ucs2Input().

void QSimCommand::setQualifier ( int value )

Sets the qualifier byte in the header of the SIM command to value. The qualifier byte contains flags that modify the behavior of the command from its default.

Other functions such as setHasHelp(), setWantDigits(), setHighPriority(), etc provide a more convenient method to set the bits within the qualifier byte.

Applies to: all commands.

See also qualifier().

void QSimCommand::setRefreshType ( QSimCommand::RefreshType value )

Sets the type of refresh to that was performed by the SIM to value. The request is ignored if type() is not Refresh.

Applies to: Refresh.

See also refreshType().

void QSimCommand::setSmsPacking ( bool value )

Sets the SMS packing flag to value. If value is true, then SMS packing should be performed when sending an SMS message for the SendSMS command. If value is false, then no packing is required.

Many modems or modem vendor plugins will consume this value and remove it from the SIM command before it reaches the client application layer. Client applications should not rely upon this value being present.

Applies to: SendSMS

See also smsPacking().

void QSimCommand::setSoftKeysPreferred ( bool value )

Sets the soft key preferred option to value. If value is true then the icons for menu items should be displayed on the device's soft keys if the number of icons is less than or equal to the number of soft keys. If there are more icons than soft keys, then regular menu selection should be used. If value is false, then regular menu selection is always used.

Applies to: SetupMenu, SelectItem.

See also softKeysPreferred() and menuPresentation().

void QSimCommand::setSourceDevice ( QSimCommand::Device value )

Sets the source device that originated the command to value. Usually this is SIM.

Applies to: all commands.

See also sourceDevice().

void QSimCommand::setSubAddress ( const QString & value )

Sets the sub-address (e.g. extension) for a call setup to value.

Applies to: SetupCall.

See also subAddress().

void QSimCommand::setSuppressUserFeedback ( bool value )

Sets the user feedback suppression flag to value.

This option controls what should happen when text() is an empty string for the SendSS, SendSMS, SendUSSD, and PlayTone commands. If value is true, then the command should be performed without any notification to the user. If value is false, then generic feedback should be provided to the user to indicate that a command is being performed.

Applies to: SendSS, SendSMS, SendUSSD, PlayTone.

See also suppressUserFeedback() and text().

void QSimCommand::setText ( const QString & value )

Sets the text to be displayed by this command to value.

Applies to: DisplayText, GetInkey, GetInput, SendSS, SendSMS, SendUSSD, PlayTone.

See also text().

void QSimCommand::setTitle ( const QString & value )

Sets the title to be displayed on a menu to value.

Applies to: SetupMenu, SelectItem.

See also title().

void QSimCommand::setTone ( QSimCommand::Tone value )

Sets the tone to be played by a PlayTone command to value.

Applies to: PlayTone

See also tone() and duration().

void QSimCommand::setToneTime ( uint value )

Sets the number of milliseconds to play a tone to value.

Applies to: PlayTone.

Note: this function is obsoleted by setDuration().

See also setDuration(), toneTime(), and tone().

void QSimCommand::setType ( QSimCommand::Type value )

Sets the type of this command to value.

Applies to: all commands.

See also type().

void QSimCommand::setUcs2Input ( bool value )

Sets the UCS2 input flag to value. If value is true, then the GetInkey and GetInput commands should send UCS2 input strings to the SIM. If value is false, then the commands should send strings in the default SMS alphabet instead.

This setting is ignored if either wantYesNo() returns true, and this setting always overrides packedInput().

See also ucs2Input(), wantYesNo(), and packedInput().

void QSimCommand::setUrl ( const QString & value )

Sets the URL to launch in the browser to value.

Applies to: LaunchBrowser.

See also url().

void QSimCommand::setWantDigits ( bool value )

Sets the flag that determines if GetInkey or GetInput wants input that consists only of digits (true), or any character combination (false), to value.

Applies to: GetInkey, GetInput.

See also wantDigits().

void QSimCommand::setWantYesNo ( bool value )

Sets the flag that determines if GetInkey wants input that consists of a Yes or No answer, to value.

Applies to: GetInkey

See also wantYesNo().

void QSimCommand::setWithRedial ( bool value )

Sets the with-redial modifier for call setup disposition to value.

Applies to: SetupCall.

See also withRedial().

bool QSimCommand::smsPacking () const

Returns true if SMS packing should be performed when sending an SMS message for the SendSMS command; or false if packing is not required. The default value is false.

Many modems or modem vendor plugins will consume this value and remove it from the SIM command before it reaches the client application layer. Client applications should not rely upon this value being present.

Applies to: SendSMS

See also setSmsPacking().

bool QSimCommand::softKeysPreferred () const

Returns true if icons for menu items should be displayed on the device's soft keys if the number of icons is less than or equal to the number of soft keys. If there are more icons than soft keys, then regular menu selection should be used. Returns false for regular menu selection. The default value is false.

Applies to: SetupMenu, SelectItem.

See also setSoftKeysPreferred() and menuPresentation().

QSimCommand::Device QSimCommand::sourceDevice () const

Returns the source device that originated the command. The default value is SIM.

Applies to: all commands.

See also setSourceDevice().

QString QSimCommand::subAddress () const

Returns the sub-address (e.g. extension) for a call setup.

Applies to: SetupCall.

See also setSubAddress().

bool QSimCommand::suppressUserFeedback () const

Returns true if user feedback should be suppressed. The default value is false.

This option controls what should happen when text() is an empty string for the SendSS, SendSMS, SendUSSD, and PlayTone commands. If suppressUserFeedback() returns true, then the command should be performed without any notification to the user. If suppressUserFeedback() is false, then generic feedback should be provided to the user to indicate that a command is being performed.

Applies to: SendSS, SendSMS, SendUSSD, PlayTone.

See also setSuppressUserFeedback() and text().

QString QSimCommand::text () const

Returns the text to be displayed as either a message, a prompt, or an SMS.

Applies to: DisplayText, GetInkey, GetInput, SendSS, SendSMS, SendUSSD, PlayTone, LanguageNotification.

See also setText().

QString QSimCommand::title () const

Returns the title to be displayed on a menu.

Applies to: SetupMenu, SelectItem.

See also setTitle().

QByteArray QSimCommand::toPdu ( QSimCommand::ToPduOptions options = NoPduOptions ) const

Encode a SIM command into its raw binary PDU form, as described in 3GPP TS 11.14. The resulting PDU form may be modified by the supplied options.

See also fromPdu().

QSimCommand::Tone QSimCommand::tone () const

Returns the tone to be played by a PlayTone command. The default value is ToneNone.

Applies to: PlayTone

See also setTone() and duration().

uint QSimCommand::toneTime () const

Returns the number of milliseconds to play a tone. The default value is zero, indicating that the default duration for the tone should be used.

Applies to: PlayTone.

Note: this function is obsoleted by duration(), and will return the same value as duration().

See also duration(), setToneTime(), and tone().

Type QSimCommand::type () const

Returns the type of this command. The default value is NoCommand.

Applies to: all commands.

See also setType().

bool QSimCommand::ucs2Input () const

Returns true if the GetInkey and GetInput commands should return UCS2 input strings to the SIM; false if the commands should return strings in the default SMS alphabet instead. The default value is false.

This setting is ignored if either wantYesNo() returns true, and this setting always overrides packedInput().

Applies to: GetInkey, GetInput

See also setUcs2Input(), wantYesNo(), and packedInput().

QString QSimCommand::url () const

Returns the URL to launch in the browser.

Applies to: LaunchBrowser.

See also setUrl().

bool QSimCommand::wantDigits () const

Returns true if GetInkey or GetInput wants input that consists only of digits (true), or any character combination (false). The allowable digits are 0-9, #, *, and +. The default value is true.

Applies to: GetInkey, GetInput.

Note: in Qtopia 4.3 and newer, the default value is true. If Qtopia 4.2 and older, the default value was false. The change was due to the introduction of the qualifier() value.

See also setWantDigits().

bool QSimCommand::wantYesNo () const

Returns true if GetInkey wants input that consists of a Yes or No answer. The default value is false.

Applies to: GetInkey

See also setWantYesNo().

bool QSimCommand::withRedial () const

Returns true if with-redial modifier is set for call setup disposition(); otherwise returns false. The default value is false.

Applies to: SetupCall.

See also setWithRedial().

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

Copy the QSimCommand object value.


Copyright © 2008 Nokia Trademarks
Qtopia 4.3.3