Symbian^3 Application Developer Library >

CESMRPolicy Class Reference

class CESMRPolicy : public CBase

CESMRPolicy defines ESMR policy. ES MR policies are relates to different roles and task scenarions. Policies are used by user interface views and tasks.

Policies can be defined in resource file with STRUCT ESMR_POLICY resource structure.

esmrservices.rh esmrpolicy.lib

Inherits from

Public Member Functions
~CESMRPolicy ()
IMPORT_C TESMRUsingApp AllowedApp ()
IMPORT_C TESMRCalendarEventType EventType ()
IMPORT_C const TESMREntryField & FieldL ( TESMREntryFieldId )
IMPORT_C const RArray < TESMREntryField > & Fields ()
IMPORT_C TBool IsAdditionalCommand ( TInt )
IMPORT_C TBool IsDefaultCommand ( TInt )
IMPORT_C TBool IsFieldIncluded ( TESMREntryFieldId )
IMPORT_C TBool IsRoleIncluded ( TESMRRole )
IMPORT_C CESMRPolicy * NewL ()
IMPORT_C CESMRPolicy * NewL ( RResourceFile &, TResourceReader &)
IMPORT_C TESMRPolicyID PolicyId ()
IMPORT_C void ReadFromResourceL ( RResourceFile &, TResourceReader &)
IMPORT_C TESMRViewMode ViewMode ()
Private Member Functions
CESMRPolicy ()
void ConstructL ( RResourceFile &, TResourceReader &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
RArray < TESMRCommand > iAdditionalCommands
TESMRUsingApp iAllowedApp
RArray < TESMRCommand > iDefaultCommands
TESMRCalendarEventType iEventType
RArray < TESMREntryField > iMRFields
TESMRPolicyID iPolicyId
TBitFlags16 iRoleFlags
TESMRViewMode iViewMode

Constructor & Destructor Documentation

CESMRPolicy()

CESMRPolicy ( ) [private, inline]

~CESMRPolicy()

IMPORT_C ~CESMRPolicy ( )

C++ destructor.

Member Functions Documentation

AllowedApp()

IMPORT_C TESMRUsingApp AllowedApp ( ) const

Fetches the allowed applicatio for this policy

ConstructL(RResourceFile &, TResourceReader &)

void ConstructL ( RResourceFile & aRFile,
TResourceReader & aReader
) [private]

Parameters

RResourceFile & aRFile
TResourceReader & aReader

EventType()

IMPORT_C TESMRCalendarEventType EventType ( ) const

Returns the event type

FieldL(TESMREntryFieldId)

IMPORT_C const TESMREntryField & FieldL ( TESMREntryFieldId aFieldId ) const

Fetches field matching field if from policy.

Parameters

TESMREntryFieldId aFieldId Field id.

Fields()

IMPORT_C const RArray < TESMREntryField > & Fields ( ) const

Fetches default fields.

IsAdditionalCommand(TInt)

IMPORT_C TBool IsAdditionalCommand ( TInt aCommand ) const

Checks if command belongs to additional commands

Parameters

TInt aCommand Command id

IsDefaultCommand(TInt)

IMPORT_C TBool IsDefaultCommand ( TInt aCommand ) const

Checks if <aCommand> belongs to default command list

Parameters

TInt aCommand Command id

IsFieldIncluded(TESMREntryFieldId)

IMPORT_C TBool IsFieldIncluded ( TESMREntryFieldId aFieldId ) const

Checks, if field is included in policy.

Parameters

TESMREntryFieldId aFieldId Field id.

IsRoleIncluded(TESMRRole)

IMPORT_C TBool IsRoleIncluded ( TESMRRole aRole ) const

Tests, if specific ES MR role is included in policy.

Parameters

TESMRRole aRole Role of user

NewL()

IMPORT_C CESMRPolicy * NewL ( ) [static]

Two-phased constructor. Creates new CESMRPolicy object. Ownership is tranferred to caller.

NewL(RResourceFile &, TResourceReader &)

IMPORT_C CESMRPolicy * NewL ( RResourceFile & aRFile,
TResourceReader & aReader
) [static]

Two-phased constructor. Reads esmr policy definition from resource. Caller is responsible for filling the resource reader with correct information.

Parameters

RResourceFile & aRFile Resource file object.
TResourceReader & aReader Resource reader object.

PolicyId()

IMPORT_C TESMRPolicyID PolicyId ( ) const

Fetches policy id. TESMRPolicyID

ReadFromResourceL(RResourceFile &, TResourceReader &)

IMPORT_C void ReadFromResourceL ( RResourceFile & aRFile,
TResourceReader & aReader
)

Reads policy definition from resource file. Caller is responsible for filling the resource reader with correct information.

Parameters

RResourceFile & aRFile Resource file object.
TResourceReader & aReader Resource reader object.

ViewMode()

IMPORT_C TESMRViewMode ViewMode ( ) const

Fetches policy view mode. TESMRViewMode

Member Data Documentation

RArray< TESMRCommand > iAdditionalCommands

RArray < TESMRCommand > iAdditionalCommands [private]

TESMRUsingApp iAllowedApp

TESMRUsingApp iAllowedApp [private]

RArray< TESMRCommand > iDefaultCommands

RArray < TESMRCommand > iDefaultCommands [private]

TESMRCalendarEventType iEventType

TESMRCalendarEventType iEventType [private]

RArray< TESMREntryField > iMRFields

RArray < TESMREntryField > iMRFields [private]

TESMRPolicyID iPolicyId

TESMRPolicyID iPolicyId [private]

TBitFlags16 iRoleFlags

TBitFlags16 iRoleFlags [private]

TESMRViewMode iViewMode

TESMRViewMode iViewMode [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.