MAknsDataContext Class Reference

API published in: S60 2nd Ed

Link against: aknskins.lib aknskinsrv.lib aknswallpaperutils.lib

Capability Information

Required Capabilities

None

#include <aknsdatacontext.h>

Detailed Description

Interface that provides context sensitive control over data allocation.

MAknsDataContext can be used to indicate need for specific skin items and thus to ensure that they are allocated before first use.

This is a public class with exported functions. The class is not usually intended for user derivation - concrete classes implementing the interface are provided by the library. See AknsUtils::CreateDataContextForContainerL() for further details.


Public Member Functions
  DECLARE_TYPE_ID (0x10005a28) public
  Destructor.
virtual void  ReserveItemL (const TAknsItemID &aID)=0
  Reserves and allocates specified item.
virtual void  ReleaseItem (const TAknsItemID &aID)=0
  Indicates that specified item will no longer be used.

Static Public Member Functions
static IMPORT_C TTypeUid::Ptr  SupplyMopObject (TTypeUid aId, MAknsDataContext *aContext)
  Returns type UID pointer that can be used in MopSupplyObject.

Protected Member Functions
virtual TInt  Reserved1 ()
  Reserved for future use.
virtual TInt  Reserved2 ()
  Reserved for future use.

Member Function Documentation

MAknsDataContext::DECLARE_TYPE_ID (  0x10005a28   )  [inline]
 

Destructor.

Destructor is only provided to enable deletion using base class pointer. Caller should never delete context retrieved using MObjectProvider interface.

virtual void MAknsDataContext::ReleaseItem (  const TAknsItemID &  aID  )  [pure virtual]
 

Indicates that specified item will no longer be used.

Instructs the data context that the specified item will not be used by caller anymore. Exact behavior (e.g. whether cached instance is deallocated) depends on the cache policy of data context and skin instance. Controls should not usually call this method, but instead allow data context (in most cases implemented by a container) go out of scope.

Parameters:
aID  Item ID of the item to be released.
virtual TInt MAknsDataContext::Reserved1 (   )  [protected, virtual]
 

Reserved for future use.

virtual TInt MAknsDataContext::Reserved2 (   )  [protected, virtual]
 

Reserved for future use.

virtual void MAknsDataContext::ReserveItemL (  const TAknsItemID &  aID  )  [pure virtual]
 

Reserves and allocates specified item.

Instructs the data context that the specified item will be used by caller and should be allocated and cached by skin instance. Any control using cached skin items should reserve them, preferably in ConstructL(), by calling this method. Note that reservation does not guarantee that the item will be available in cache - it's only a tentative request for allocation.

Parameters:
aID  Item ID of the item to be reserved.
Exceptions:
If item data allocation fails, function leaves with error code.
static IMPORT_C TTypeUid::Ptr MAknsDataContext::SupplyMopObject (  TTypeUid  aId,
MAknsDataContext *  aContext
)  [static]
 

Returns type UID pointer that can be used in MopSupplyObject.

Parameters:
aId  Type UID, should be the same that was given as aId parameter of MopSupplyObject.
aContext  Pointer to an MAknsDataContext instance.
Returns:
Type UID pointer containing aContext, or NULL type UID pointer if given type UID does not match MAknsDataContext or aContext is NULL.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top