Collapse all Symbian^3 Product Developer Library

RSat::TMenuItemBaseV5 Class Reference

class RSat::TMenuItemBaseV5 : public RSat::TMenuItemBaseV1

Base class for menu item based classes.

The SET UP MENU and SELECT ITEM proactive commands both provide menus that are displayed to the user. When the user chooses one of the menu's options, you should tell the UICC which option was chosen.

In Symbian OS versions < 9.2, the proactive command contains menus in classes derived from RSat::TMenuItemBaseV1. For SET UP MENU they are RSat::TSetUpMenuV1, RSat::TSetUpMenuV2 etc. For SELECT ITEM these classes are RSat::TSelectItemV1, RSat::TSelectItemV2 etc.

In Symbian OS version 9.2, the proactive command contains menus in classes derived from RSat::TMenuItemBaseV5 which itself derives from RSat::TMenuItemBaseV5. For SET UP MENU they are RSat::TSetUpMenuV5. For SELECT ITEM these classes are RSat::TSelectItemV5.

The description of the SET UP MENU and SELECT ITEM commands describes how to display the menu and what to do when the user makes a selection; see RSat::NotifySetUpMenuPCmd() and RSat::NotifySelectItemPCmd().

RSat::TMenuItemBaseV1 provides methods to add and get the menu items, to return the number of items, and to get a description of the menu's content.

This class extends that functionality by providing support for text attributes for the menu item text.

For more details on how to read menu items, see RSat::TMenuItemBaseV1

TMenuItemBaseV1

Inherits from

RSat::TMenuItemBaseV5
- RSat::TMenuItemBaseV1
  - RSat::TSatPCmdBase
    - RSat::TSatBase

Public Member Functions
	TMenuItemBaseV5()
IMPORT_C TInt	AddItem(const TItem &, const TTextAttribute &)
IMPORT_C TInt	AddItem(const TItem &, const TTextAttribute &, TUint)
IMPORT_C TInt	AddItem(const TItem &, const TTextAttribute &, TUint, TUint)
IMPORT_C TInt	AddItemIcon(const TItem &, const TTextAttribute &, TUint)
IMPORT_C TInt	GetItem(TUint, TItem &, TTextAttribute &)
IMPORT_C TInt	GetItem(TUint, TItem &, TTextAttribute &, TInt &)
IMPORT_C TInt	GetItem(TUint, TItem &, TTextAttribute &, TInt &, TInt &)
IMPORT_C TInt	GetItemIcon(TUint, TItem &, TTextAttribute &, TInt &)

Inherited Functions
	RSat::TMenuItemBaseV1::AddItem(const TItem &)
	RSat::TMenuItemBaseV1::AddItem(const TItem &,TUint)
	RSat::TMenuItemBaseV1::AddItem(const TItem &,TUint,TUint)
	RSat::TMenuItemBaseV1::AddItemIcon(const TItem &,TUint)
	RSat::TMenuItemBaseV1::FindItemInBuffer(TUint,TInt &)const
	RSat::TMenuItemBaseV1::GetItem(TUint,TItem &)const
	RSat::TMenuItemBaseV1::GetItem(TUint,TItem &,TInt &)const
	RSat::TMenuItemBaseV1::GetItem(TUint,TItem &,TInt &,TInt &)const
	RSat::TMenuItemBaseV1::GetItemIcon(TUint,TItem &,TInt &)const
	RSat::TMenuItemBaseV1::IsRemoveMenu()const
	RSat::TMenuItemBaseV1::MenuContent()const
	RSat::TMenuItemBaseV1::NumberOfItems()const
	RSat::TMenuItemBaseV1::Reset()
	RSat::TMenuItemBaseV1::TMenuItemBaseV1()
	RSat::TSatBase::ExtensionId()const
	RSat::TSatBase::TSatBase()
	RSat::TSatPCmdBase::PCmdNumber()const
	RSat::TSatPCmdBase::SetPCmdNumber(TUint8)
	RSat::TSatPCmdBase::TSatPCmdBase()

Inherited Enumerations
	RSat::TMenuItemBaseV1:@104
	RSat::TMenuItemBaseV1:@105
	RSat::TMenuItemBaseV1:@106
	RSat::TMenuItemBaseV1:@107
	RSat::TMenuItemBaseV1:TBitMask
	RSat::TMenuItemBaseV1:TMenuItemHeader

Inherited Attributes
	RSat::TMenuItemBaseV1::iBuf
	RSat::TMenuItemBaseV1::iMenuContent
	RSat::TMenuItemBaseV1::iNumberOfItems
	RSat::TSatBase::iExtensionId
	RSat::TSatPCmdBase::iPCmdNumber

Constructor & Destructor Documentation

TMenuItemBaseV5()

IMPORT_C

TMenuItemBaseV5

(

)

Default constructor.

Member Functions Documentation

AddItem(const TItem &, const TTextAttribute &)

IMPORT_C TInt	AddItem	(	const TItem &	aItem,
			const TTextAttribute &	aTextAttribute
		)

This method is an overloaded method of AddItem(TItem aItem) It adds a menu item and a text attribute to the menu.

It is only possible to add a menu item and text attribute if the menu is either empty or already contains items all with text attributes only. If the existing menu items contain icons or item next actions, then an icon/next action for the menu item must also be specified by adding the item using one of the other overloaded methods of AddItem(TItem aItem). If the existing menu items do not have text attributes specified, then it is not possible to specify a text attribute for the new menu item and one of the other overloaded methods of AddItem(TItem aItem) that does not contain a TTextAttribute parameter must be used.

It is not needed by RSat clients, only the TSY.

Parameters

const TItem & aItem	Item to be added to iBuf.
const TTextAttribute & aTextAttribute	Item text attribute which applies to aItem to be added to iBuf.

AddItem(const TItem &, const TTextAttribute &, TUint)

IMPORT_C TInt	AddItem	(	const TItem &	aItem,
			const TTextAttribute &	aTextAttribute,
			TUint	aAction
		)

This method is an overloaded method of AddItem(TItem aItem) It adds a menu item,a text attribute and an item next action to the menu.

It is only possible to add a menu item, text attribute and item next action if the menu is either empty or already contains items ALL with text attributes and item next actions only. If the existing menu items contain icons, all new menu items must also contain icons, therefore, this function cannot be used to add items to the menu. One of the other overloaded methods of AddItem(TItem aItem) which allow an icon to be specified should be used.

It is not needed by RSat clients, only the TSY.

Parameters

const TItem & aItem	Item to be added to iBuf.
const TTextAttribute & aTextAttribute	Item text attribute which applies to aItem to be added to iBuf.
TUint aAction	Item next action.

AddItem(const TItem &, const TTextAttribute &, TUint, TUint)

IMPORT_C TInt	AddItem	(	const TItem &	aItem,
			const TTextAttribute &	aTextAttribute,
			TUint	aAction,
			TUint	aIconId
		)

This method is an overloaded method of AddItem(TItem aItem) It adds a menu item,a text attribute and an item next action and icon to the menu.

It is only possible to add a menu item with all the associated information if the menu is either empty or already contains items ALL of which also contain text attributes, item icons, and item next actions. If the existing menu items do not contain all of these, this function cannot be used to add items to the menu. One of the other overloaded methods of AddItem(TItem aItem) which allow an item next action to be specified should be used instead.

It is not needed by RSat clients, only the TSY.

Parameters

const TItem & aItem	Item to be added to iBuf.
const TTextAttribute & aTextAttribute	Item text attribute which applies to aItem to be added to iBuf.
TUint aAction	Item next action to be added to iBuf.
TUint aIconId

AddItemIcon(const TItem &, const TTextAttribute &, TUint)

IMPORT_C TInt	AddItemIcon	(	const TItem &	aItem,
			const TTextAttribute &	aTextAttribute,
			TUint	aIconId
		)

This method is an overloaded method of RSat::TMenuItemBaseV1::AddItemIcon(TItem aItem) It adds a menu item,a text attribute and an item next action to the menu.

It is only possible to add a menu item, text attribute and item icon if the menu is either empty or already contains items ALL with text attributes and item icons only. If the existing menu items contain item next actions, all new menu items must also contain icons, therefore, this function cannot be used to add items to the menu. One of the other overloaded methods of AddItem(TItem aItem) which allow an item next action to be specified should be used instead.

It is not needed by RSat clients, only the TSY.

Parameters

const TItem & aItem	Item to be added to iBuf.
const TTextAttribute & aTextAttribute	Item text attribute which applies to aItem to be added to iBuf.
TUint aIconId

GetItem(TUint, TItem &, TTextAttribute &)

IMPORT_C TInt	GetItem	(	TUint	aIndex,
			TItem &	aItem,
			TTextAttribute &	aTextAttribute
		)	const

This method is an overloaded method of RSat::TMenuItemBaseV1::GetItem(TUint aIndex, TItem& aItem). It returns the menu item's text attribute (if available) as well as the requested menu item. RSat::TMenuItemBaseV1::MenuContent() tells you whether a menu's items are accompanied by text attributes.

Parameters

TUint aIndex	Index of the menu item. Index range starts at 1. RSat::TMenuItemBaseV1::NumberOfItems() returns the total number of items.
TItem & aItem	Item from the menu, designated by aIndex.
TTextAttribute & aTextAttribute	Text attribute of the item at aIndex in the menu.

GetItem(TUint, TItem &, TTextAttribute &, TInt &)

IMPORT_C TInt	GetItem	(	TUint	aIndex,
			TItem &	aItem,
			TTextAttribute &	aTextAttribute,
			TInt &	aAction
		)	const

Parameters

TUint aIndex	Index of the menu item. Index range starts at 1. RSat::TMenuItemBaseV1::NumberOfItems() returns the total number of items.
TItem & aItem	Item from the menu, designated by aIndex.
TTextAttribute & aTextAttribute	Text attribute of the item at aIndex in the menu.
TInt & aAction	Action associated with the item.

GetItem(TUint, TItem &, TTextAttribute &, TInt &, TInt &)

IMPORT_C TInt	GetItem	(	TUint	aIndex,
			TItem &	aItem,
			TTextAttribute &	aTextAttribute,
			TInt &	aAction,
			TInt &	aIconId
		)	const

This method is an overloaded method of RSat::TMenuItemBaseV1::GetItem(TUint aIndex, TItem& aItem). It returns the menu item's text attribute, item next action and icon if they are available as well as the requested menu item. RSat::TMenuItemBaseV1::MenuContent() tells you whether a menu's items are accompanied by text attributes, item next actions, and icons.

Parameters

TUint aIndex	Index of the menu item. Index range starts at 1. RSat::TMenuItemBaseV1::NumberOfItems() returns the total number of items.
TItem & aItem	Item from the menu, designated by aIndex.
TTextAttribute & aTextAttribute	Text attribute of the item at aIndex in the menu.
TInt & aAction	Action associated with the item.
TInt & aIconId

GetItemIcon(TUint, TItem &, TTextAttribute &, TInt &)

IMPORT_C TInt	GetItemIcon	(	TUint	aIndex,
			TItem &	aItem,
			TTextAttribute &	aTextAttribute,
			TInt &	aIconId
		)	const

Parameters

TUint aIndex	Index of the menu item. Index range starts at 1. RSat::TMenuItemBaseV1::NumberOfItems() returns the total number of items.
TItem & aItem	Item from the menu, designated by aIndex.
TTextAttribute & aTextAttribute	Text attribute of the item at aIndex in the menu.
TInt & aIconId