Qtopia Home - Classes - Hierachy - Annotated - Functions - Licenses - Reference

SimCommand Class Reference

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

#include <simtoolkit.h>

List of all member functions.

Public Members

SimCommand ()
SimCommand ( const SimCommand & value )
~SimCommand ()
enum Type { SetupMainMenu = 0, DisplayText = 1, GetInkey = 2, GetInput = 3, SetupCall = 4, PlayTone = 5, SetupSubMenu = 6, Refresh = 7, SendSS = 8, SendSMS = 9, SendUSSD = 10, SetupEventList = 11, Timeout = 98, EndSession = 99, LaunchBrowser = 200, SetupIdleModeText = 201 }
enum Disposition { IfNoOtherCalls = 0, PutOnHold = 1, Disconnect = 2 }
enum CallClass { Voice = 0, Data = 1, Fax = 2 }
enum Tone { ToneDial = 0, ToneBusy = 1, ToneCongestion = 2, ToneRadioAck = 3, ToneDropped = 4, ToneError = 5, ToneCallWaiting = 6, ToneRinging = 7, ToneGeneralBeep = 8, TonePositiveBeep = 9, ToneNegativeBeep = 10 }
enum RefreshType { InitAndFullFileChange = 0, FileChange = 1, InitAndFileChange = 2, Initialization = 3, Reset = 4 }
enum Event { IdleScreen = 1, UserActivity = 2, Both = 3, Cancel = 4 }
enum BrowserLaunchMode { IfNotAlreadyLaunched = 0, UseExisting = 2, CloseExistingAndLaunch = 3 }
Type type () const
void setType ( Type value )
bool hasHelp () const
void setHasHelp ( bool value )
QString text () const
void setText ( const QString & value )
bool highPriority () const
void setHighPriority ( bool value )
bool clearAfterDelay () const
void setClearAfterDelay ( bool value )
bool wantDigits () const
void setWantDigits ( bool value )
bool wantYesNo () const
void setWantYesNo ( bool value )
uint minimumLength () const
void setMinimumLength ( uint value )
uint maximumLength () const
void setMaximumLength ( uint value )
bool echo () const
void setEcho ( bool value )
Disposition disposition () const
void setDisposition ( Disposition value )
bool withRedial () const
void setWithRedial ( bool value )
QString number () const
void setNumber ( const QString & value )
QString subAddress () const
void setSubAddress ( const QString & value )
CallClass callClass () const
void setCallClass ( CallClass value )
Tone tone () const
void setTone ( Tone value )
uint toneTime () const
void setToneTime ( uint value )
QString title () const
void setTitle ( const QString & value )
uint defaultItem () const
void setDefaultItem ( uint value )
QValueList<SimMenuItem> menuItems () const
void setMenuItems ( const QValueList<SimMenuItem> & value )
RefreshType refreshType () const
void setRefreshType ( RefreshType value )
Event events () const
void setEvents ( Event value )
BrowserLaunchMode browserLaunchMode () const
void setBrowserLaunchMode ( BrowserLaunchMode value )
QString url () const
void setUrl ( const QString & value )
SimCommand & operator= ( const SimCommand & 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 SimCommand class encapsulates a single SIM toolkit command, containing all of the information about it. SimCommand objects are delivered to the host program by way of the SimToolkit::command signal.

In Qtopia, the host program is "simapp".

See also SimToolkit, SimMenuItem, and Qtopia Phone Classes.

Member Type Documentation

SimCommand::BrowserLaunchMode

SimCommand::IfNotAlreadyLaunched - Launch browser, if not already launched.
SimCommand::UseExisting - Use the existing browser, but not if it is running a secured session.
SimCommand::CloseExistingAndLaunch - Close the existing browswer session and launch a new browser session.

SimCommand::CallClass

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

SimCommand::Voice - Voice call
SimCommand::Data - Data call
SimCommand::Fax - Fax call

SimCommand::Disposition

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

SimCommand::IfNoOtherCalls - Perform the setup only if there are no other calls.
SimCommand::PutOnHold - Put other calls on hold when the new call is setup.
SimCommand::Disconnect - Disconnect other calls when the new call is setup.

SimCommand::Event

SimCommand::IdleScreen - Report an event when the system is idle.
SimCommand::UserActivity - Report an event when there is user activity.
SimCommand::Both - Report for both system idle and user activity.
SimCommand::Cancel - Cancel event reporting.

SimCommand::RefreshType

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

SimCommand::InitAndFullFileChange - SIM initialization and full file change notification.
SimCommand::FileChange - File change notification.
SimCommand::InitAndFileChange - SIM initialization and file change notification.
SimCommand::Initialization - SIM initialization.
SimCommand::Reset - SIM reset.

SimCommand::Tone

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

SimCommand::ToneDial - Currently dialing
SimCommand::ToneBusy - Called party is busy
SimCommand::ToneCongestion - Network is congested
SimCommand::ToneRadioAck - Radio acknowledged
SimCommand::ToneDropped - Connection has been dropped
SimCommand::ToneError - An error occurred
SimCommand::ToneCallWaiting - An incoming call is waiting
SimCommand::ToneRinging - Ring to indicate and incoming call
SimCommand::ToneGeneralBeep - A general beep tone
SimCommand::TonePositiveBeep - A beep indicating a positive outcome
SimCommand::ToneNegativeBeep - A beep indicating a negative outcome

SimCommand::Type

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

SimCommand::SetupMainMenu - Process the main menu of a SIM toolkit application
SimCommand::DisplayText - Display a text message
SimCommand::GetInkey - Get a single key of input
SimCommand::GetInput - Get a line of input
SimCommand::SetupCall - Set up a phone call to a specific number
SimCommand::PlayTone - Play a tone to the user
SimCommand::SetupSubMenu - Process a submenu within a SIM toolkit application
SimCommand::Refresh - Notification of a SIM refresh
SimCommand::SendSS - Notification that the application is sending a SS message.
SimCommand::SendSMS - Notification that the application is sending a SMS message
SimCommand::SendUSSD - Notification that the application is sending a USSD message
SimCommand::SetupEventList - Set up the list of events to be reported to the SIM toolkit application
SimCommand::Timeout - Indicate that an operation has timed out
SimCommand::EndSession - Indicate that the SIM toolkit session has ended
SimCommand::LaunchBrowser - Launch a Web browser on a URL
SimCommand::SetupIdleModeText - Set the text to be displayed when the phone is idle

Member Function Documentation

SimCommand::SimCommand ()

Construct a new SIM toolkit command object with default parameters.

SimCommand::SimCommand ( const SimCommand & value )

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

SimCommand::~SimCommand ()

Destruct a SIM toolkit command object.

BrowserLaunchMode SimCommand::browserLaunchMode () const

Get the browser launch mode.

Applies to: LaunchBrowser.

CallClass SimCommand::callClass () const

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

Applies to: SetupCall.

bool SimCommand::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 SimToolkit::clearText() to move on to the next SIM application state.

Applies to: DisplayText.

uint SimCommand::defaultItem () const

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

Applies to: SetupSubMenu.

Disposition SimCommand::disposition () const

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

Applies to: SetupCall.

bool SimCommand::echo () const

Determine if input should be echoed.

Applies to: GetInput.

Event SimCommand::events () const

Get the events to be reported.

Applies to: SetupEventList.

bool SimCommand::hasHelp () const

Determine if there is help available for this command.

Applies to: SetupMainMenu, GetInkey, GetInput, SetupSubMenu.

bool SimCommand::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 SimCommand::maximumLength () const

Get the maximum text length for input.

Applies to: GetInput.

QValueList<SimMenuItem> SimCommand::menuItems () const

Get the list of menu items in the menu.

Applies to: SetupMainMenu, SetupSubMenu.

uint SimCommand::minimumLength () const

Get the minimum text length for input.

Applies to: GetInput.

QString SimCommand::number () const

Get the phone number for a call setup.

Applies to: SetupCall.

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

Copy a SimCommand object.

RefreshType SimCommand::refreshType () const

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

Applies to: Refresh.

void SimCommand::setClearAfterDelay ( bool value )

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

Applies to: DisplayText.

void SimCommand::setDefaultItem ( uint value )

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

Applies to: SetupSubMenu.

void SimCommand::setEcho ( bool value )

Set the flag that determines if input should be echoed.

Applies to: GetInput.

void SimCommand::setHasHelp ( bool value )

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

Applies to: SetupMainMenu, GetInkey, GetInput, SetupSubMenu.

void SimCommand::setHighPriority ( bool value )

Set the high priority text display flag.

Applies to: DisplayText.

void SimCommand::setMaximumLength ( uint value )

Set the maximum text length for input.

Applies to: GetInput.

void SimCommand::setMenuItems ( const QValueList<SimMenuItem> & value )

Set the list of menu items in the menu.

Applies to: SetupMainMenu, SetupSubMenu.

void SimCommand::setMinimumLength ( uint value )

Set the minimum text length for input.

Applies to: GetInput.

void SimCommand::setNumber ( const QString & value )

Set the phone number for a call setup.

Applies to: SetupCall.

void SimCommand::setSubAddress ( const QString & value )

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

Applies to: SetupCall.

void SimCommand::setText ( const QString & value )

Set the text to be displayed by this command.

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

void SimCommand::setTitle ( const QString & value )

Set the title to be displayed on a menu.

Applies to: SetupMainMenu, SetupSubMenu.

void SimCommand::setToneTime ( uint value )

Set the number of milliseconds to play a tone.

Applies to: PlayTone.

void SimCommand::setUrl ( const QString & value )

Set the URL to launch in the browser.

Applies to: LaunchBrowser.

void SimCommand::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).

Applies to: GetInkey, GetInput.

void SimCommand::setWantYesNo ( bool value )

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

Applies to: GetInkey

void SimCommand::setWithRedial ( bool value )

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

Applies to: SetupCall.

QString SimCommand::subAddress () const

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

Applies to: SetupCall.

QString SimCommand::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 SimCommand::title () const

Get the title to be displayed on a menu.

Applies to: SetupMainMenu, SetupSubMenu.

Tone SimCommand::tone () const

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

Applies to: PlayTone

uint SimCommand::toneTime () const

Get the number of milliseconds to play a tone.

Applies to: PlayTone.

Type SimCommand::type () const

Get the type of this command.

Applies to: all commands.

QString SimCommand::url () const

Get the URL to launch in the browser.

Applies to: LaunchBrowser.

bool SimCommand::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 SimCommand::wantYesNo () const

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

Applies to: GetInkey

bool SimCommand::withRedial () const

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

Applies to: SetupCall.

Trademarks

Qtopia version 2.2.0