Symbian^3 Application Developer Library >

RWidgetRegistryClientSession Class Reference

class RWidgetRegistryClientSession : public RSessionBase

Inherits from

Public Member Functions
RWidgetRegistryClientSession ()
IMPORT_C TInt Connect ()
IMPORT_C void DeRegisterWidgetL (const TUid &)
IMPORT_C TInt Disconnect ()
IMPORT_C TUid GetAvailableUidL ( TUint )
IMPORT_C void GetLprojName ( TDes &)
IMPORT_C void GetWidgetBundleId (const TUid &, TDes &)
IMPORT_C void GetWidgetBundleName (const TUid &, TDes &)
IMPORT_C void GetWidgetPath (const TUid &, TDes &)
IMPORT_C CWidgetPropertyValue * GetWidgetPropertyValueL (const TUid &, TWidgetPropertyId )
IMPORT_C TInt GetWidgetUidForUrl (const TDesC &)
IMPORT_C TInt GetWidgetUidL (const TDesC &)
IMPORT_C TInt InstalledWidgetsL ( RWidgetInfoArray &)
IMPORT_C TBool IsBlanketPermGranted (const TUid &)
IMPORT_C TBool IsWidget (const TUid &)
IMPORT_C TBool IsWidgetInFullView (const TUid &)
IMPORT_C TBool IsWidgetInMiniView (const TUid &)
IMPORT_C TBool IsWidgetRunning (const TUid &)
IMPORT_C void RegisterWidgetL (const RPointerArray < CWidgetPropertyValue > &)
IMPORT_C TInt RunningWidgetsL ( RWidgetInfoArray &)
IMPORT_C TInt SecurityPolicyId ()
IMPORT_C void SetActive (const TUid &, TInt )
IMPORT_C void SetBlanketPermissionL (const TUid &, TInt )
IMPORT_C void SetFullViewL (const TUid &, TInt )
IMPORT_C void SetMiniViewL (const TUid &, TInt )
IMPORT_C TVersion Version ()
IMPORT_C TInt WidgetCount ( TInt &)
IMPORT_C TBool WidgetExistsL (const TDesC &)
IMPORT_C TInt WidgetSapiAccessState (const TUid &)
Private Member Functions
void DeserializeWidgetInfoL ( RReadStream &, RWidgetInfoArray &, TInt )
CBufFlat * MarshalPropertyValuesL (const RPointerArray < CWidgetPropertyValue > &)
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::Close()
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()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
TIpcArgs iMesgArgs
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RWidgetRegistryClientSession()

IMPORT_C RWidgetRegistryClientSession ( )

Constructor

Member Functions Documentation

Connect()

IMPORT_C TInt Connect ( )

Connect to widgetregistry server

DeRegisterWidgetL(const TUid &)

IMPORT_C void DeRegisterWidgetL ( const TUid & aUid )

Deregister the widget

Parameters

const TUid & aUid

DeserializeWidgetInfoL(RReadStream &, RWidgetInfoArray &, TInt)

void DeserializeWidgetInfoL ( RReadStream & aStream,
RWidgetInfoArray & aWidgetInfoArr,
TInt aCount
) [private]

Read data from aStream

Parameters

RReadStream & aStream
RWidgetInfoArray & aWidgetInfoArr
TInt aCount

Disconnect()

IMPORT_C TInt Disconnect ( )

Disconnect from widgetregistry server

GetAvailableUidL(TUint)

IMPORT_C TUid GetAvailableUidL ( TUint aDriveLetter )

Get next availble uid

Parameters

TUint aDriveLetter

GetLprojName(TDes &)

IMPORT_C void GetLprojName ( TDes & aLprojName )

Get the language project name which is the directory to hold localized resources

Parameters

TDes & aLprojName

GetWidgetBundleId(const TUid &, TDes &)

IMPORT_C void GetWidgetBundleId ( const TUid & aUid,
TDes & aWidgetBundleId
)

Returns bundle Id of the widget with a particular UId

Parameters

const TUid & aUid
TDes & aWidgetBundleId

GetWidgetBundleName(const TUid &, TDes &)

IMPORT_C void GetWidgetBundleName ( const TUid & aUid,
TDes & aWidgetBundleName
)

Returns bundle name of the widget with a particular UId

Parameters

const TUid & aUid
TDes & aWidgetBundleName

GetWidgetPath(const TUid &, TDes &)

IMPORT_C void GetWidgetPath ( const TUid & aUid,
TDes & aWidgetPath
)

Returns path of the widget with a particular UId

Parameters

const TUid & aUid
TDes & aWidgetPath

GetWidgetPropertyValueL(const TUid &, TWidgetPropertyId)

IMPORT_C CWidgetPropertyValue * GetWidgetPropertyValueL ( const TUid & aUid,
TWidgetPropertyId aPropertyId
)

Gets property value for a widget by UId, leaves on error

Parameters

const TUid & aUid
TWidgetPropertyId aPropertyId

GetWidgetUidForUrl(const TDesC &)

IMPORT_C TInt GetWidgetUidForUrl ( const TDesC & aUrl )

Returns UId of the widget with a particular Url

Parameters

const TDesC & aUrl

GetWidgetUidL(const TDesC &)

IMPORT_C TInt GetWidgetUidL ( const TDesC & aBundleId )

Returns uid of the widget with a particular bundle identifier

Parameters

const TDesC & aBundleId

InstalledWidgetsL(RWidgetInfoArray &)

IMPORT_C TInt InstalledWidgetsL ( RWidgetInfoArray & aWidgetInfoArr )

Returns widget info for all the installed widgets.

Parameters

RWidgetInfoArray & aWidgetInfoArr

IsBlanketPermGranted(const TUid &)

IMPORT_C TBool IsBlanketPermGranted ( const TUid & aUid )

Returns true if the blanket permission is granted

Parameters

const TUid & aUid

IsWidget(const TUid &)

IMPORT_C TBool IsWidget ( const TUid & aUid )

Returns true if the Uid falls within the range specified for widgets.

Parameters

const TUid & aUid

IsWidgetInFullView(const TUid &)

IMPORT_C TBool IsWidgetInFullView ( const TUid & aUid )

Returns true if the widget is in FullView.

Parameters

const TUid & aUid

IsWidgetInMiniView(const TUid &)

IMPORT_C TBool IsWidgetInMiniView ( const TUid & aUid )

Returns true if the widget is in MiniView.

Parameters

const TUid & aUid

IsWidgetRunning(const TUid &)

IMPORT_C TBool IsWidgetRunning ( const TUid & aUid )

Returns true if the widget is running.

Parameters

const TUid & aUid

MarshalPropertyValuesL(const RPointerArray< CWidgetPropertyValue > &)

CBufFlat * MarshalPropertyValuesL ( const RPointerArray < CWidgetPropertyValue > & aPropertyValues ) const [private]

Creates and returns heap descriptor which holds contents of RWidgetDataArray or CWidgetInfo based on the datatype passed

Parameters

const RPointerArray < CWidgetPropertyValue > & aPropertyValues

RegisterWidgetL(const RPointerArray< CWidgetPropertyValue > &)

IMPORT_C void RegisterWidgetL ( const RPointerArray < CWidgetPropertyValue > & aPropertyValues )

Registers the widget

Parameters

const RPointerArray < CWidgetPropertyValue > & aPropertyValues

RunningWidgetsL(RWidgetInfoArray &)

IMPORT_C TInt RunningWidgetsL ( RWidgetInfoArray & aWidgetInfoArr )

Returns widget info for all the running widgets.

Parameters

RWidgetInfoArray & aWidgetInfoArr

SecurityPolicyId()

IMPORT_C TInt SecurityPolicyId ( )

Returns security policyId.

SetActive(const TUid &, TInt)

IMPORT_C void SetActive ( const TUid & aUid,
TInt aStatus
)

Set/Reset active status of the widget

Parameters

const TUid & aUid
TInt aStatus

SetBlanketPermissionL(const TUid &, TInt)

IMPORT_C void SetBlanketPermissionL ( const TUid & aUid,
TInt aStatus
)

Set/Reset blaket permission for widgets

Parameters

const TUid & aUid
TInt aStatus

SetFullViewL(const TUid &, TInt)

IMPORT_C void SetFullViewL ( const TUid & aUid,
TInt aStatus
)

Set/Reset Full view status of widget

Parameters

const TUid & aUid
TInt aStatus

SetMiniViewL(const TUid &, TInt)

IMPORT_C void SetMiniViewL ( const TUid & aUid,
TInt aStatus
)

Set/Reset Mini view launched status of widget

Parameters

const TUid & aUid
TInt aStatus

Version()

IMPORT_C TVersion Version ( ) const

Returns the version

WidgetCount(TInt &)

IMPORT_C TInt WidgetCount ( TInt & aCount )

Returns count of widgets installed.

Parameters

TInt & aCount

WidgetExistsL(const TDesC &)

IMPORT_C TBool WidgetExistsL ( const TDesC & aBundleId )

Returns true if the widget is installed

Parameters

const TDesC & aBundleId

WidgetSapiAccessState(const TUid &)

IMPORT_C TInt WidgetSapiAccessState ( const TUid & aUid )

Returns if widget sapi access is prompted, promptless or denied.

Parameters

const TUid & aUid

Member Data Documentation

TIpcArgs iMesgArgs

TIpcArgs iMesgArgs [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.