RMenu Class Reference
| class RMenu : public RSessionBase |
Menu session. The menu is an ID-based tree structure of menu folders and items. mcsmenu.lib
- Since
- S60 v5.0
Nested Classes and Structures
| Public Member Functions |
|---|
| RMenu() |
| IMPORT_C void | Close() |
| IMPORT_C void | GetItemsL(RArray< TMenuItem > &, TInt, const CMenuFilter *, TBool) |
| IMPORT_C void | GetRunningAppsL(RArray< TUid > &) |
| IMPORT_C CMenuOperation * | MoveToFolderL(const RArray< TInt > &, TInt, TInt, TRequestStatus &) |
| IMPORT_C void | OpenL(const TDesC &) |
| IMPORT_C CMenuOperation * | RemoveL(TInt, TRequestStatus &) |
| IMPORT_C CMenuOperation * | ReorderL(TInt, TInt, TRequestStatus &) |
| IMPORT_C void | ResourceCheck() |
| IMPORT_C TInt | ResourceCount() |
| IMPORT_C void | ResourceMark() |
| IMPORT_C TInt | RootFolderL() |
| IMPORT_C void | __DbgSetAllocFail(RAllocator::TAllocFail, TInt) |
| Inherited Functions |
|---|
| | RHandleBase::Attributes()const |
| | RHandleBase::BTraceId()const |
| | RHandleBase::DoExtendedClose() |
| | RHandleBase::Duplicate(const RThread &,TOwnerType) |
| | RHandleBase::FullName()const |
| | RHandleBase::FullName(TDes &)const |
| | RHandleBase::Handle()const |
| | RHandleBase::HandleInfo(THandleInfo *) |
| | RHandleBase::Name()const |
| | RHandleBase::NotifyDestruction(TRequestStatus &) |
| | RHandleBase::Open(const TFindHandleBase &,TOwnerType) |
| | RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt) |
| | RHandleBase::RHandleBase() |
| | RHandleBase::RHandleBase(TInt) |
| | RHandleBase::SetHandle(TInt) |
| | RHandleBase::SetHandleNC(TInt) |
| | RSessionBase::CreateSession(RServer2,const TVersion &) |
| | RSessionBase::CreateSession(RServer2,const TVersion &,TInt) |
| | RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *) |
| | RSessionBase::CreateSession(const TDesC &,const TVersion &) |
| | RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt) |
| | RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *) |
| | RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *) |
| | RSessionBase::Open(RMessagePtr2,TInt,TOwnerType) |
| | RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType) |
| | RSessionBase::Open(TInt,TOwnerType) |
| | RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType) |
| | RSessionBase::Send(TInt)const |
| | RSessionBase::Send(TInt,const TIpcArgs &)const |
| | RSessionBase::SendReceive(TInt)const |
| | RSessionBase::SendReceive(TInt,TRequestStatus &)const |
| | RSessionBase::SendReceive(TInt,const TIpcArgs &)const |
| | RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const |
| | RSessionBase::SetReturnedHandle(TInt) |
| | RSessionBase::SetReturnedHandle(TInt,RHandleBase &) |
| | RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &) |
| | RSessionBase::ShareAuto() |
| | RSessionBase::ShareProtected() |
| Private Attributes |
|---|
| TData * | iData |
Constructor & Destructor Documentation
RMenu()
Constructor.
- Since
- S60 v5.0
- capability
- None.
- Exceptions
-
- panic
- None.
Member Functions Documentation
Close()
Close the session. Safe to call if not open.
- Since
- S60 v5.0
- capability
- None.
- Exceptions
-
- panic
- None.
ConnectSession()
|
TInt
| ConnectSession | ( | ) | [private] |
GetAttributeL(TInt, const TDesC &)
Get item attribute value.
GetAttributeListL(TInt, RArray< TAttributeName > &)
Get item attribute name list.
GetItemsL(RArray< TMenuItem > &, TInt, const CMenuFilter *, TBool)
Get list of items.
- Since
- S60 v5.0
- capability
- ECapabilityReadDeviceData.
- Exceptions
| System-wide |
error codes if an error occurs.
|
- panic
- None.
Parameters
| RArray< TMenuItem > & aItemArray | Array receiving item list. Existing content not touched (new items are appended). |
| TInt aFolder | Get items from this folder. |
| const CMenuFilter * aFilter = NULL | Filter criteria or NULL for unfiltered results. |
| TBool aRecursive = EFalse | ETrue to recurse folders, EFalse for immediate children only. |
GetRunningAppsL(RArray< TUid > &)
| IMPORT_C void | GetRunningAppsL | ( | RArray< TUid > & | aArray | ) | |
Get array of running applications
HandleCommandL(CMenuItem &, const TDesC8 &, const TDesC8 &, TRequestStatus &)
Parameters
| CMenuItem & aItem | Item. |
| const TDesC8 & aCommand | Command. |
| const TDesC8 & aParams | |
| TRequestStatus & aStatus | Observer request status. When the operation completes, this status will be completed with the resulting error code. |
MoveToFolderL(const RArray< TInt > &, TInt, TInt, TRequestStatus &)
Move items to another folder.
- Since
- S60 v5.0
- capability
- ECapabilityWriteDeviceData.
- Exceptions
| System-wide |
error codes if an error occurs.
|
- panic
- None.
Parameters
| const RArray< TInt > & aItems | ID-s of items to be to be moved. All items must be in the same folder. |
| TInt aFolder | Target folder. |
| TInt aMoveBefore | |
| TRequestStatus & aStatus | Observer request status. When the operation completes, this status will be completed with the resulting error code. |
OpenL(const TDesC &)
| IMPORT_C void | OpenL | ( | const TDesC & | aName | ) | |
Open the session.
- Since
- S60 v5.0
- capability
- ECapabilityReadDeviceData.
- Exceptions
| System-wide |
error codes if an error occurs.
|
- panic
- None.
Parameters
| const TDesC & aName | Name of the menu content to open. |
RemoveL(TInt, TRequestStatus &)
Remove item.
- Since
- S60 v5.0
- capability
- ECapabilityWriteDeviceData.
- Exceptions
| System-wide |
error codes if an error occurs.
|
- panic
- None.
Parameters
| TInt aId | ID of item to be removed. |
| TRequestStatus & aStatus | Observer request status. When the operation completes, this status will be completed with the resulting error code. |
ReorderL(TInt, TInt, TRequestStatus &)
Move item to a different position in its current folder.
- Since
- S60 v5.0
- capability
- ECapabilityWriteDeviceData.
- Exceptions
| System-wide |
error codes if an error occurs.
|
- panic
- None.
Parameters
| TInt aId | ID-s of item to be to be reordered. |
| TInt aMoveBefore | |
| TRequestStatus & aStatus | Observer request status. When the operation completes, this status will be completed with the resulting error code. |
ResourceCheck()
| IMPORT_C void | ResourceCheck | ( | ) | |
Check that the number of allocated object through this session matches the same of when the last call to ResourceMark was made.
- Since
- S60 v5.0
- capability
- ECapabilityAllFiles.
- Exceptions
| System-wide |
error codes if an error occurs.
|
- panic
- None.
ResourceCount()
| IMPORT_C TInt | ResourceCount | ( | ) | |
Get number of allocated object through this session.
- Since
- S60 v5.0
- capability
- ECapabilityAllFiles.
- Exceptions
| System-wide |
error codes if an error occurs.
|
- panic
- None.
ResourceMark()
| IMPORT_C void | ResourceMark | ( | ) | |
Start checking the number of allocated object through this session.
- Since
- S60 v5.0
- capability
- ECapabilityAllFiles.
- Exceptions
| System-wide |
error codes if an error occurs.
|
- panic
- None.
RootFolderL()
| IMPORT_C TInt | RootFolderL | ( | ) | |
Get ID of the root folder.
- Since
- S60 v5.0
- capability
- ECapabilityReadDeviceData.
- Exceptions
| System-wide |
error codes if an error occurs.
|
- panic
- None.
__DbgSetAllocFail(RAllocator::TAllocFail, TInt)
Simulate a heap allocation failure for server heap. Has empty implementation for the UDEB server.
- Since
- S60 v5.0
- capability
- ECapabilityAllFiles.
- Exceptions
| System-wide |
error codes if an error occurs.
|
- panic
- None.
Member Data Documentation
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.