Symbian^3 Application Developer Library >

RMenuNotifier Class Reference

class RMenuNotifier : public RSubSessionBase
Menu change notifier. mcsmenu.lib
Since
S60 v5.0

Inherits from

Public Member Functions
RMenuNotifier ()
IMPORT_C void Cancel ()
IMPORT_C void Close ()
IMPORT_C void Notify ( TInt , TInt , TRequestStatus &)
IMPORT_C TInt Open ( RMenu &)
Inherited Functions
RSubSessionBase::CloseSubSession(TInt)
RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::RSubSessionBase()
RSubSessionBase::Send(TInt)const
RSubSessionBase::Send(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt)const
RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSubSessionBase::Session()const
RSubSessionBase::SubSessionHandle()const
Public Member Enumerations
enum TEvent { EItemsNone  = 0, EItemsAddedRemoved  = 0x1, EItemsReordered  = 0x2, EItemAttributeChanged  = 0x4 }
Private Attributes
TData * iData

Constructor & Destructor Documentation

RMenuNotifier()

RMenuNotifier ( ) [inline]
Constructor.
Since
S60 v5.0
capability
None.
Exceptions
None.

panic
None.

Member Functions Documentation

Cancel()

IMPORT_C void Cancel ( )
Cancel notification request.
Since
S60 v5.0
capability
ECapabilityReadDeviceData.
Exceptions
None.

panic
None.

Close()

IMPORT_C void Close ( )
Close the notifier. Safe to call if not open. Outstanding request, if any, is cancelled.
Since
S60 v5.0
capability
ECapabilityReadDeviceData.
Exceptions
None.

panic
None.

Notify(TInt, TInt, TRequestStatus &)

IMPORT_C void Notify ( TInt aFolder,
TInt aEvents,
TRequestStatus & aStatus
)
Request notification of menu events occurring in specified folder.
Since
S60 v5.0
capability
ECapabilityReadDeviceData.
Exceptions
None.

panic
None.

Parameters

TInt aFolder Folder to observe. Pass 0 to observe all folders (the whole menu).
TInt aEvents Events to be notified about. A combination of TEvent bits.
TRequestStatus & aStatus Completes when menu events occur in the specified folder, or on error. Completion value is error code (if negative), or a combination of events specified in aEvents (if positive). Note, more than one event bit can be set.

Open(RMenu &)

IMPORT_C TInt Open ( RMenu & aMenu )
Open the notifier.
Since
S60 v5.0
capability
ECapabilityReadDeviceData.
Exceptions
System-wide

error codes if an error occurs.

panic
None.

Parameters

RMenu & aMenu Menu.

Member Enumerations Documentation

Enum TEvent

Enumerators

EItemsNone = 0
EItemsAddedRemoved = 0x1
EItemsReordered = 0x2
EItemAttributeChanged = 0x4

Member Data Documentation

TData * iData

TData * iData [private]

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.