Home · All Classes · Annotated · Functions

QSimCommand Class Reference

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

#include <QSimCommand>

List of all members, including inherited members

Public Types

enum BrowserLaunchMode { IfNotAlreadyLaunched, UseExisting, CloseExistingAndLaunch }
enum CallClass { Voice, Data, Fax }
enum Disposition { IfNoOtherCalls, PutOnHold, Disconnect }
enum Event { IdleScreen, UserActivity, Both, Cancel }
enum RefreshType { InitAndFullFileChange, FileChange, InitAndFileChange, Initialization, Reset }
enum Tone { ToneDial, ToneBusy, ToneCongestion, ToneRadioAck, ..., ToneNegativeBeep }
enum Type { SetupMainMenu, DisplayText, GetInkey, GetInput, ..., SetupIdleModeText }

Public Functions

QSimCommand ()
QSimCommand ( const QSimCommand & value )
~QSimCommand ()
QSimCommand::BrowserLaunchMode browserLaunchMode () const
QSimCommand::CallClass callClass () const
bool clearAfterDelay () const
uint defaultItem () const
QSimCommand::Disposition disposition () const
bool echo () const
QSimCommand::Event events () const
bool hasHelp () const
bool highPriority () const
uint maximumLength () const
QList<QSimMenuItem> menuItems () const
uint minimumLength () const
QString number () const
QSimCommand::RefreshType refreshType () const
void setBrowserLaunchMode ( QSimCommand::BrowserLaunchMode value )
void setCallClass ( QSimCommand::CallClass value )
void setClearAfterDelay ( bool value )
void setDefaultItem ( uint value )
void setDisposition ( QSimCommand::Disposition value )
void setEcho ( bool value )
void setEvents ( QSimCommand::Event value )
void setHasHelp ( bool value )
void setHighPriority ( bool value )
void setMaximumLength ( uint value )
void setMenuItems ( const QList<QSimMenuItem> & value )
void setMinimumLength ( uint value )
void setNumber ( const QString & value )
void setRefreshType ( QSimCommand::RefreshType value )
void setSubAddress ( const QString & value )
void setText ( const QString & value )
void setTitle ( const QString & value )
void setTone ( QSimCommand::Tone value )
void setToneTime ( uint value )
void setType ( QSimCommand::Type value )
void setUrl ( const QString & value )
void setWantDigits ( bool value )
void setWantYesNo ( bool value )
void setWithRedial ( bool value )
QString subAddress () const
QString text () const
QString title () const
QSimCommand::Tone tone () const
uint toneTime () const
Type type () const
QString url () const
bool wantDigits () const
bool wantYesNo () const
bool withRedial () const
QSimCommand & operator= ( const QSimCommand & value )

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".

Member Type Documentation

enum QSimCommand::BrowserLaunchMode

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 browswer 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.

Constant	Value	Description
`QSimCommand::Voice`	`0`	Voice call
`QSimCommand::Data`	`1`	Data call
`QSimCommand::Fax`	`2`	Fax call

enum QSimCommand::Disposition

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.

enum QSimCommand::Event

Constant	Value	Description
`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.

enum QSimCommand::RefreshType

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.

enum QSimCommand::Tone

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

Constant	Value	Description
`QSimCommand::ToneDial`	`0`	Currently dialing
`QSimCommand::ToneBusy`	`1`	Called party is busy
`QSimCommand::ToneCongestion`	`2`	Network is congested
`QSimCommand::ToneRadioAck`	`3`	Radio acknowledged
`QSimCommand::ToneDropped`	`4`	Connection has been dropped
`QSimCommand::ToneError`	`5`	An error occurred
`QSimCommand::ToneCallWaiting`	`6`	An incoming call is waiting
`QSimCommand::ToneRinging`	`7`	Ring to indicate and incoming call
`QSimCommand::ToneGeneralBeep`	`8`	A general beep tone
`QSimCommand::TonePositiveBeep`	`9`	A beep indicating a positive outcome
`QSimCommand::ToneNegativeBeep`	`10`	A beep indicating a negative outcome

enum QSimCommand::Type

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

Constant	Value	Description
`QSimCommand::SetupMainMenu`	`0`	Process the main menu of a SIM toolkit application
`QSimCommand::DisplayText`	`1`	Display a text message
`QSimCommand::GetInkey`	`2`	Get a single key of input
`QSimCommand::GetInput`	`3`	Get a line of input
`QSimCommand::SetupCall`	`4`	Set up a phone call to a specific number
`QSimCommand::PlayTone`	`5`	Play a tone to the user
`QSimCommand::SetupSubMenu`	`6`	Process a submenu within a SIM toolkit application
`QSimCommand::Refresh`	`7`	Notification of a SIM refresh
`QSimCommand::SendSS`	`8`	Notification that the application is sending a SS message.
`QSimCommand::SendSMS`	`9`	Notification that the application is sending a SMS message
`QSimCommand::SendUSSD`	`10`	Notification that the application is sending a USSD message
`QSimCommand::SetupEventList`	`11`	Set up the list of events to be reported to the SIM toolkit application
`QSimCommand::Timeout`	`98`	Indicate that an operation has timed out
`QSimCommand::EndSession`	`99`	Indicate that the SIM toolkit session has ended
`QSimCommand::LaunchBrowser`	`200`	Launch a Web browser on a URL
`QSimCommand::SetupIdleModeText`	`201`	Set the text to be displayed when the phone is idle

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.

QSimCommand::BrowserLaunchMode QSimCommand::browserLaunchMode () const

Get the browser launch mode.

Applies to: LaunchBrowser.

QSimCommand::CallClass QSimCommand::callClass () const

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

Applies to: SetupCall.

bool QSimCommand::clearAfterDelay () const

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

Applies to: DisplayText.

uint QSimCommand::defaultItem () const

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

Applies to: SetupSubMenu.

QSimCommand::Disposition QSimCommand::disposition () const

Get the disposition of other calls when a call setup occurs.

Applies to: SetupCall.

bool QSimCommand::echo () const

Determine if input should be echoed.

Applies to: GetInput.

QSimCommand::Event QSimCommand::events () const

Get the events to be reported.

Applies to: SetupEventList.

bool QSimCommand::hasHelp () const

Determine if there is help available for this command.

Applies to: SetupMainMenu, GetInkey, GetInput, SetupSubMenu.

bool QSimCommand::highPriority () const

Determine if a DisplayText command should attempt to display the text as "high priority" (true) or "normal priority" (false).

Applies to: DisplayText.

uint QSimCommand::maximumLength () const

Get the maximum text length for input.

Applies to: GetInput.

QList<QSimMenuItem> QSimCommand::menuItems () const

Get the list of menu items in the menu.

Applies to: SetupMainMenu, SetupSubMenu.

uint QSimCommand::minimumLength () const

Get the minimum text length for input.

Applies to: GetInput.

QString QSimCommand::number () const

Get the phone number for a call setup.

Applies to: SetupCall.

QSimCommand::RefreshType QSimCommand::refreshType () const

Get the type of refresh to that was performed by the SIM.

Applies to: Refresh.

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

Set the browser launch mode to value.

Applies to: LaunchBrowser.

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

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

Applies to: SetupCall.

void QSimCommand::setClearAfterDelay ( bool value )

Set the "clear after delay" flag for text display to value.

Applies to: DisplayText.

void QSimCommand::setDefaultItem ( uint value )

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

Applies to: SetupSubMenu.

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

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

Applies to: SetupCall.

void QSimCommand::setEcho ( bool value )

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

Applies to: GetInput.

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

Set the events to be reported to value.

Applies to: SetupEventList.

void QSimCommand::setHasHelp ( bool value )

Set the flag that determines if there is help available for this command to value.

Applies to: SetupMainMenu, GetInkey, GetInput, SetupSubMenu.

void QSimCommand::setHighPriority ( bool value )

Set the high priority text display flag to value.

Applies to: DisplayText.

void QSimCommand::setMaximumLength ( uint value )

Set the maximum text length for input to value.

Applies to: GetInput.

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

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

Applies to: SetupMainMenu, SetupSubMenu.

void QSimCommand::setMinimumLength ( uint value )

Set the minimum text length for input to value.

Applies to: GetInput.

void QSimCommand::setNumber ( const QString & value )

Set the phone number for a call setup to value.

Applies to: SetupCall.

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

Set the type of refresh to that was performed by the SIM to value.

Applies to: Refresh.

void QSimCommand::setSubAddress ( const QString & value )

Set the subaddress (e.g. extension) for a call setup to value.

Applies to: SetupCall.

void QSimCommand::setText ( const QString & value )

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

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

void QSimCommand::setTitle ( const QString & value )

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

Applies to: SetupMainMenu, SetupSubMenu.

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

Set the tone to be played by a "PlayTone" command to value.

Applies to: PlayTone

void QSimCommand::setToneTime ( uint value )

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

Applies to: PlayTone.

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

Set the type of this command to value.

Applies to: all commands.

void QSimCommand::setUrl ( const QString & value )

Set the URL to launch in the browser to value.

Applies to: LaunchBrowser.

void QSimCommand::setWantDigits ( bool value )

Set 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.

void QSimCommand::setWantYesNo ( bool value )

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

Applies to: GetInkey

void QSimCommand::setWithRedial ( bool value )

Set the "with redial" modifier for call setup disposition to value.

Applies to: SetupCall.

QString QSimCommand::subAddress () const

Get the subaddress (e.g. extension) for a call setup.

Applies to: SetupCall.

QString QSimCommand::text () const

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

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

QString QSimCommand::title () const

Get the title to be displayed on a menu.

Applies to: SetupMainMenu, SetupSubMenu.

QSimCommand::Tone QSimCommand::tone () const

Get the tone to be played by a "PlayTone" command.

Applies to: PlayTone

uint QSimCommand::toneTime () const

Get the number of milliseconds to play a tone.

Applies to: PlayTone.

Type QSimCommand::type () const

Get the type of this command.

Applies to: all commands.

QString QSimCommand::url () const

Get the URL to launch in the browser.

Applies to: LaunchBrowser.

bool QSimCommand::wantDigits () const

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

Applies to: GetInkey, GetInput.

bool QSimCommand::wantYesNo () const

Determine if "GetInkey" wants input that consists of a "Yes" or "No" answer.

Applies to: GetInkey

bool QSimCommand::withRedial () const

Get the "with redial" modifier for call setup disposition.

Applies to: SetupCall.

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

Copy the QSimCommand object value.

Trademarks

Qtopia 4.1.7