RSat::TIconId Struct Reference

struct RSat::TIconId

Some types of proactive command can include an icon identifier. Commands that can include an icon will have an RSat::TIconId field. Icons are intended to provide graphical information to the user, although the display of icons is optional.

If RSat::TIconId::iQualifier is RSat::ENoIconId then the proactive command does not provide an icon.

Otherwise, an icon is provided. The alpha identifier or text string in the proactive command will be present and will not be a null string.

  • If RSat::TIconId.iQualifier is RSat::ENotSelfExplanatory then both icon and the alpha identifier or text string should be displayed. If you are not able to display both (such as when the screen is too small) then display just the alpha identifier or text string.

RSat::TIconId does not contain the icon itself. Instead it contains an icon identifier, RSat::TIconId::iIdentifier. Use RSat::GetIcon() followed by RSat::GetImageInstance() to get the icon from the UICC.

There are two error cases related to icons:

  • If the UICC provides an icon identifier with a proactive command but you cannot display the icon for any reason, then inform the UICC by sending the general result "Command performed successfully, but requested icon could not be displayed"; see RSat::KSuccessRequestedIconNotDisplayed.

  • If you receive an icon, and either an empty or no alpha identifier/text string is given by the UICC, than reject the command with general result "Command data not understood by terminal"; see RSat::KCmdDataNotUnderstood.

RSat::GetIcon() RSat::GetImageInstance()RMobileCall::TIconId

Member Data Documentation

TUint8 iIdentifier

TUint8 iIdentifier

Icon identifier, addresses a record in EF IMG.

TIconQualifier iQualifier

TIconQualifier iQualifier

Describes the state of the icon.