|
Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions | |
The QSimCommand class specifies the details of a SIM toolkit command message. More...
#include <QSimCommand>
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.
This enum defines the launch mode to use when displaying web pages in the browser.
| Constant | Value | Description |
|---|---|---|
| QSimCommand::IfNotAlreadyLaunched | 0 | Launch browser, if not already launched. |
| QSimCommand::UseExisting | 2 | Use the existing browser, but not if it is running a secured session. |
| QSimCommand::CloseExistingAndLaunch | 3 | Close the existing browser session and launch a new browser session. |
This enum defines the class of call that is being created by a SetupCall command.
| Constant | Value | Description |
|---|---|---|
| QSimCommand::Voice | 0 | Voice call |
| QSimCommand::Data | 1 | Data call |
| QSimCommand::Fax | 2 | Fax call |
This enum defines the source or destination device for a SIM command, according to 3GPP TS 11.14, section 12.7.
| Constant | Value | Description |
|---|---|---|
| QSimCommand::Keypad | 0x01 | Keypad device |
| QSimCommand::Display | 0x02 | Display device |
| QSimCommand::Earpiece | 0x03 | Earpiece device |
| QSimCommand::CardReader0 | 0x10 | Additional card reader 0 |
| QSimCommand::CardReader1 | 0x11 | Additional card reader 1 |
| QSimCommand::CardReader2 | 0x12 | Additional card reader 2 |
| QSimCommand::CardReader3 | 0x13 | Additional card reader 3 |
| QSimCommand::CardReader4 | 0x14 | Additional card reader 4 |
| QSimCommand::CardReader5 | 0x15 | Additional card reader 5 |
| QSimCommand::CardReader6 | 0x16 | Additional card reader 6 |
| QSimCommand::CardReader7 | 0x17 | Additional card reader 7 |
| QSimCommand::Channel1 | 0x21 | Data channel 1 |
| QSimCommand::Channel2 | 0x22 | Data channel 2 |
| QSimCommand::Channel3 | 0x23 | Data channel 3 |
| QSimCommand::Channel4 | 0x24 | Data channel 4 |
| QSimCommand::Channel5 | 0x25 | Data channel 5 |
| QSimCommand::Channel6 | 0x26 | Data channel 6 |
| QSimCommand::Channel7 | 0x27 | Data channel 7 |
| QSimCommand::SIM | 0x81 | SIM device |
| QSimCommand::ME | 0x82 | ME (mobile equipment) device |
| QSimCommand::Network | 0x83 | Source or destination is the network |
This enum defines the disposition of other calls when a SetupCall command is executed by the SIM toolkit application.
| Constant | Value | Description |
|---|---|---|
| QSimCommand::IfNoOtherCalls | 0 | Perform the setup only if there are no other calls. |
| QSimCommand::PutOnHold | 1 | Put other calls on hold when the new call is setup. |
| QSimCommand::Disconnect | 2 | Disconnect other calls when the new call is setup. |
This enum defines the types of events that the SIM expects to be reported.
| Constant | Value | Description |
|---|---|---|
| QSimCommand::NoEvent | 0 | No event type specified. |
| QSimCommand::IdleScreen | 1 | Report an event when the system is idle. |
| QSimCommand::UserActivity | 2 | Report an event when there is user activity. |
| QSimCommand::Both | 3 | Report for both system idle and user activity. |
| QSimCommand::Cancel | 4 | Cancel event reporting. |
This enum defines the type of presentation to use for SIM toolkit menus.
| Constant | Value | Description |
|---|---|---|
| QSimCommand::AnyPresentation | 0 | The user interface may use any presentation it wishes. |
| QSimCommand::DataValuesPresentation | 1 | The user interface should present the menu as a choice of several data values. |
| QSimCommand::NavigationOptionsPresentation | 2 | The user interface should present the menu as a choice of several navigation options. |
This enum defines the type of refresh that was performed by the SIM.
| Constant | Value | Description |
|---|---|---|
| QSimCommand::InitAndFullFileChange | 0 | SIM initialization and full file change notification. |
| QSimCommand::FileChange | 1 | File change notification. |
| QSimCommand::InitAndFileChange | 2 | SIM initialization and file change notification. |
| QSimCommand::Initialization | 3 | SIM initialization. |
| QSimCommand::Reset | 4 | SIM reset. |
| QSimCommand::NaaApplicationReset | 5 | NAA application reset. This is only applicable for a 3G platform. Since Qtopia 4.4. Compliant with ETSI TS 102 223. |
| QSimCommand::NaaSessionReset | 6 | NAA session reset. This is only applicable for a 3G platform. Since Qtopia 4.4. Compliant with ETSI TS 102 223. |
This enum defines additional options to use when encoding SIM commands with QSimCommand::toPdu().
| Constant | Value | Description |
|---|---|---|
| QSimCommand::NoPduOptions | 0x00 | No additional options. |
| QSimCommand::NoBerWrapper | 0x01 | Do not include the outermost BER wrapper around the command parameters. |
| QSimCommand::PackedStrings | 0x02 | Encode 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::UCS2Strings | 0x04 | Encode 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::EncodeEmptyStrings | 0x08 | Encode empty strings in the actual character set, instead of using the shorthand encoding. |
This enum defines the tones that can be played by a PlayTone command.
| Constant | Value | Description |
|---|---|---|
| QSimCommand::ToneNone | -1 | No tone specified. |
| QSimCommand::ToneDial | 0x01 | Currently dialing |
| QSimCommand::ToneBusy | 0x02 | Called party is busy |
| QSimCommand::ToneCongestion | 0x03 | Network is congested |
| QSimCommand::ToneRadioAck | 0x04 | Radio acknowledged |
| QSimCommand::ToneDropped | 0x05 | Connection has been dropped |
| QSimCommand::ToneError | 0x06 | An error occurred |
| QSimCommand::ToneCallWaiting | 0x07 | An incoming call is waiting |
| QSimCommand::ToneRinging | 0x08 | Ring to indicate and incoming call |
| QSimCommand::ToneGeneralBeep | 0x10 | A general beep tone |
| QSimCommand::TonePositiveBeep | 0x11 | A beep indicating a positive outcome |
| QSimCommand::ToneNegativeBeep | 0x12 | A beep indicating a negative outcome |
This enum defines the type of a SIM toolkit message within a QSimCommand object.
| Constant | Value | Description |
|---|---|---|
| QSimCommand::NoCommand | -1 | No command type currently set. |
| QSimCommand::Timeout | -2 | Indicate that an operation has timed out. |
| QSimCommand::Refresh | 0x01 | Notification of a SIM refresh. |
| QSimCommand::MoreTime | 0x02 | The 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::PollInterval | 0x03 | The 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::PollingOff | 0x04 | This 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::SetupEventList | 0x05 | Set up the list of events to be reported to the SIM toolkit application. |
| QSimCommand::SetupCall | 0x10 | Set up a phone call to a specific number. |
| QSimCommand::SendSS | 0x11 | Notification that the application is sending a SS message. |
| QSimCommand::SendSMS | 0x13 | Notification that the application is sending a SMS message. |
| QSimCommand::SendUSSD | 0x12 | Notification that the application is sending a USSD message. |
| QSimCommand::SendDTMF | 0x14 | Notification that the application is sending a DTMF tone. |
| QSimCommand::LaunchBrowser | 0x15 | Launch a Web browser on a URL. |
| QSimCommand::PlayTone | 0x20 | Play a tone to the user. |
| QSimCommand::DisplayText | 0x21 | Display a text message. |
| QSimCommand::GetInkey | 0x22 | Get a single key of input. |
| QSimCommand::GetInput | 0x23 | Get a line of input. |
| QSimCommand::SelectItem | 0x24 | Process a submenu within a SIM toolkit application. |
| QSimCommand::SetupMenu | 0x25 | Process the main menu of a SIM toolkit application. |
| QSimCommand::ProvideLocalInformation | 0x26 | The 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::TimerManagement | 0x27 | The 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::SetupIdleModeText | 0x28 | Set the text to be displayed when the phone is idle. |
| QSimCommand::PerformCardAPDU | 0x30 | Send 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::PowerOnCard | 0x31 | Power 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::PowerOffCard | 0x32 | Power 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::GetReaderStatus | 0x33 | Get 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::RunATCommand | 0x34 | Run an AT command against the modem |
| QSimCommand::LanguageNotification | 0x35 | Inform the user about the language the SIM toolkit application will be displaying messages in. |
| QSimCommand::OpenChannel | 0x40 | Open a data channel. |
| QSimCommand::CloseChannel | 0x41 | Close a data channel. |
| QSimCommand::ReceiveData | 0x42 | Receive data on a data channel. |
| QSimCommand::SendData | 0x43 | Send data on a data channel. |
| QSimCommand::GetChannelStatus | 0x44 | Get the current status of a data channel. |
| QSimCommand::ServiceSearch | 0x45 | Search for the availability of a service in the environment of the terminal. Since Qtopia 4.4. Compliant with ETSI TS 102 223. |
| QSimCommand::GetServiceInformation | 0x46 | Get the complete service record related to a service. Since Qtopia 4.4. Compliant with ETSI TS 102 223. |
| QSimCommand::DeclareService | 0x47 | Declare a service that is provided by the SIM. Since Qtopia 4.4. Compliant with ETSI TS 102 223. |
| QSimCommand::SetFrames | 0x50 | Divide the screen into multiple, scrollable rectangular regions in order to present multiple information at once. Since Qtopia 4.4. Compliant with ETSI TS 102 223. |
| QSimCommand::GetFramesStatus | 0x51 | Get the status on the frames supported by the SIM. Since Qtopia 4.4. Compliant with ETSI TS 102 223. |
| QSimCommand::RetrieveMultimediaMessage | 0x60 | Retrieve a multimedia message from the network. Since Qtopia 4.4. Compliant with ETSI TS 102 223. |
| QSimCommand::SubmitMultimediaMessage | 0x61 | Submit a multimedia message to the network. Since Qtopia 4.4. Compliant with ETSI TS 102 223. |
| QSimCommand::DisplayMultimediaMessage | 0x62 | Display a multimedia message. Since Qtopia 4.4. Compliant with ETSI TS 102 223. |
| QSimCommand::EndSession | 0x81 | Indicate that the SIM toolkit session has ended |
| QSimCommand::SetupMainMenu | SetupMenu | Alias for SetupMenu, provided for backwards compatiblity. |
| QSimCommand::SetupSubMenu | SelectItem | Alias for SelectItem, provided for backwards compatiblity. |
Construct a new SIM toolkit command object with default parameters.
Construct a new SIM toolkit command object as a copy of value.
Destruct a SIM toolkit command object.
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().
Returns the browser launch mode. The default value is IfNotAlreadyLaunched.
Applies to: LaunchBrowser.
See also setBrowserLaunchMode().
Returns the class of call to be setup (Voice, Data, or Fax). The default value is Voice.
Applies to: SetupCall.
See also setCallClass().
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, DisplayMultimediaMessage.
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().
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().
Returns the index of the default item in the menu, or zero if no default.
Applies to: SelectItem.
See also setDefaultItem().
Returns the default text for GetInput commands.
Applies to: GetInput
See also setDefaultText().
Returns the destination device for the command. The default value is ME.
Applies to: all commands.
See also setDestinationDevice().
Returns the disposition of other calls when a call setup occurs. The default value is IfNoOtherCalls.
Applies to: SetupCall.
See also setDisposition().
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().
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().
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().
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().
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().
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().
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().
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, DisplayMultimediaMessage.
See also setHighPriority().
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, ServiceSearch, GetServiceInformation, RetrieveMultimediaMessage, SubmitMultimediaMessage
See also setIconId().
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, ServiceSearch, GetServiceInformation, RetrieveMultimediaMessage, SubmitMultimediaMessage
See also setIconSelfExplanatory().
Returns true if a DisplayText or DisplayMultimediaMessage 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, DisplayMultimediaMessage
See also setImmediateResponse() and clearAfterDelay().
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().
Returns the list of menu items in the menu.
Applies to: SetupMenu, SelectItem.
See also setMenuItems().
Returns the menu presentation type to use for SelectItem commands. The default value is AnyPresentation.
Applies to: SelectItem.
See also setMenuPresentation() and softKeysPreferred().
Returns the minimum text length for input. The default value is 0.
Applies to: GetInput.
See also setMinimumLength().
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().
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().
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().
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().
Returns the text attributes to use to format otherText().
Applies to: SetupCall
This function was introduced in Qtopia 4.4.
See also setOtherTextAttribute(), otherText(), and otherTextHtml().
Returns otherText() formatted as HTML according to the attributes in otherTextAttribute().
Applies to: SetupCall
This function was introduced in Qtopia 4.4.
See also otherText() and otherTextAttribute().
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().
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().
Returns the type of refresh to that was performed by the SIM. The default value is InitAndFullFileChange.
Applies to: Refresh.
See also setRefreshType().
Sets the browser launch mode to value.
Applies to: LaunchBrowser.
See also browserLaunchMode().
Sets the class of call to be setup (Voice, Data, or Fax) to value.
Applies to: SetupCall.
See also callClass().
Sets the clear after delay flag for text display to value. If type() is not DisplayText or DisplayMultimediaMessage, the request is ignored.
Applies to: DisplayText, DisplayMultimediaMessage.
See also clearAfterDelay().
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().
Sets the index of the default item in the menu, or zero if no default, to value.
Applies to: SelectItem.
See also defaultItem().
Sets the default text for GetInput commands to value.
Applies to: GetInput
See also defaultText().
Sets the destination device for the command to value.
Applies to: all commands.
See also destinationDevice().
Sets the disposition of other calls when a call setup occurs to value.
Applies to: SetupCall.
See also disposition().
Sets the duration of a poll interval or to play a tone to value milliseconds.
Applies to: PlayTone, PollInterval.
See also duration() and tone().
Sets the flag that determines if input should be echoed to value.
Applies to: GetInput.
See also echo().
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().
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().
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().
Sets the high priority text display flag to value. If type() is not DisplayText or DisplayMultimediaMessage, then the request is ignored.
Applies to: DisplayText, DisplayMultimediaMessage.
See also highPriority().
Sets the icon identifier associated with this menu item to value.
Applies to: DisplayText, GetInkey, GetInput, PlayTone, SelectItem, SendSMS, SendSS, SetupCall, SetupMenu, LaunchBrowser, SetupIdleModeText, ServiceSearch, GetServiceInformation, RetrieveMultimediaMessage, SubmitMultimediaMessage
See also iconId().
Sets the self-explanatory flag to value.
Applies to: DisplayText, GetInkey, GetInput, PlayTone, SelectItem, SendSMS, SendSS, SetupCall, SetupMenu, LaunchBrowser, SetupIdleModeText, ServiceSearch, GetServiceInformation, RetrieveMultimediaMessage, SubmitMultimediaMessage
See also iconSelfExplanatory().
Sets the immediate response flag to value. If value is true, then the DisplayText or DisplayMultimediaMessage 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, DisplayMultimediaMessage
See also immediateResponse() and clearAfterDelay().
Sets the maximum text length for input to value.
Applies to: GetInput.
See also maximumLength().
Sets the list of menu items in the menu to value.
Applies to: SetupMenu, SelectItem.
See also menuItems().
Sets the menu presentation type to use for SelectItem commands to value.
Applies to: SelectItem.
See also menuPresentation() and softKeysPreferred().
Sets the minimum text length for input to value.
Applies to: GetInput.
See also minimumLength().
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().
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().
Sets the self-explanatory flag for the icon specified by otherIconId to value.
Applies to: SetupCall
See also otherIconSelfExplanatory().
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().
Sets the text attributes to use to format otherText() to value.
Applies to: SetupCall
This function was introduced in Qtopia 4.4.
See also otherTextAttribute(), otherText(), and otherTextHtml().
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().
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().
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().
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().
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().
Sets the source device that originated the command to value. Usually this is SIM.
Applies to: all commands.
See also sourceDevice().
Sets the sub-address (e.g. extension) for a call setup to value.
Applies to: SetupCall.
See also subAddress().
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().
Sets the text to be displayed by this command to value.
Applies to: DisplayText, GetInkey, GetInput, SendSS, SendSMS, SendUSSD, PlayTone, ServiceSearch, GetServiceInformation, RetrieveMultimediaMessage, SubmitMultimediaMessage.
See also text().
Sets the text attributes to be applied to text() for formatting to value.
Applies to: DisplayText, GetInkey, GetInput, SendSS, SendSMS, SendUSSD, PlayTone, ServiceSearch, GetServiceInformation, RetrieveMultimediaMessage, SubmitMultimediaMessage.
This function was introduced in Qtopia 4.4.
See also textAttribute(), text(), and textHtml().
Sets the title to be displayed on a menu to value.
Applies to: SetupMenu, SelectItem.
See also title().
Sets the text attribute to use to format title() to value.
Applies to: SetupMenu, SelectItem.
This function was introduced in Qtopia 4.4.
See also titleAttribute(), title(), and titleHtml().
Sets the tone to be played by a PlayTone command to value.
Applies to: PlayTone
See also tone() and duration().
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().
Sets the type of this command to value.
Applies to: all commands.
See also type().
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().
Sets the URL to launch in the browser to value.
Applies to: LaunchBrowser.
See also url().
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().
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().
Sets the with-redial modifier for call setup disposition to value.
Applies to: SetupCall.
See also withRedial().
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().
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().
Returns the source device that originated the command. The default value is SIM.
Applies to: all commands.
See also setSourceDevice().
Returns the sub-address (e.g. extension) for a call setup.
Applies to: SetupCall.
See also setSubAddress().
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().
Returns the text to be displayed as either a message, a prompt, or an SMS.
Applies to: DisplayText, GetInkey, GetInput, SendSS, SendSMS, SendUSSD, PlayTone, ServiceSearch, GetServiceInformation, RetrieveMultimediaMessage, SubmitMultimediaMessage.
See also setText().
Returns the text attributes to be applied to text() for formatting.
Applies to: DisplayText, GetInkey, GetInput, SendSS, SendSMS, SendUSSD, PlayTone, ServiceSearch, GetServiceInformation, RetrieveMultimediaMessage, SubmitMultimediaMessage.
This function was introduced in Qtopia 4.4.
See also setTextAttribute() and text().
Returns text() formatted as HTML according to the attributes in textAttribute().
Applies to: DisplayText, GetInkey, GetInput, SendSS, SendSMS, SendUSSD, PlayTone, ServiceSearch, GetServiceInformation, RetrieveMultimediaMessage, SubmitMultimediaMessage.
This function was introduced in Qtopia 4.4.
See also text() and textAttribute().
Returns the title to be displayed on a menu.
Applies to: SetupMenu, SelectItem.
See also setTitle().
Returns the text attribute to use to format title().
Applies to: SetupMenu, SelectItem.
This function was introduced in Qtopia 4.4.
See also setTitleAttribute(), title(), and titleHtml().
Returns title() formatted as HTML according to the attributes in titleAttribute().
Applies to: SetupMenu, SelectItem.
This function was introduced in Qtopia 4.4.
See also title() and titleAttribute().
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().
Returns the tone to be played by a PlayTone command. The default value is ToneNone.
Applies to: PlayTone
See also setTone() and duration().
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().
Returns the type of this command. The default value is NoCommand.
Applies to: all commands.
See also setType().
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().
Returns the URL to launch in the browser.
Applies to: LaunchBrowser.
See also setUrl().
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().
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().
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().
Copy the QSimCommand object value.
| Copyright © 2009 Nokia | Trademarks | Qt Extended 4.4.3 |