CEikStatusPaneModelBase Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eikspmod.h>

Inherited by CEikAppStatusPaneModel.

Detailed Description

Base class for status pane model.

Public Member Functions
IMPORT_C  ~CEikStatusPaneModelBase ()
  Destructor.
CEikStatusPaneSetInit *  PaneInits () const
  Gets the pane inits of the status pane.
virtual IMPORT_C void  SetLayoutL (TInt aLayoutResId, TBool aChangeStatusPaneNow=ETrue)
  Sets the status pane layout.
CEikStatusPaneLayout *  CurrentLayout () const
  Gets the current layout.
IMPORT_C TInt  CurrentLayoutResId () const
  Gets the current layout resource id.
void  AknLayoutRefresh ()
  Re-reads layout data for all existing layouts from AknLayout system.
TBool  AknLayoutUsed (TInt aLayoutId)
  This method tells if given layout is using AknLayout system for placing and sizing the statuspane subpanes.

Protected Types
typedef CArrayPtrFlat< CIdLayoutPair >  CLayoutIdSet
typedef CArrayFixFlat< TInt >  CIdSet

Protected Member Functions
IMPORT_C  CEikStatusPaneModelBase (CEikonEnv &aEikEnv)
  Constructor.
IMPORT_C void  BaseConstructL (TInt aCoreResId)
  Base constructor for 2nd phase construction.
IMPORT_C CEikStatusPaneLayout *  LoadLayoutL (TInt aLayoutResId)
  Loads given layout from resource.
CIdSet *  LegalIds () const
  Returns set of legal layout ids.
TBool  IsLegalId (TInt aLayoutResId) const
  Checks if given layout id is allowed.

Protected Attributes
CLayoutIdSet *  iLayouts
TInt  iCurrentResId
CEikonEnv &  iEikEnv

Data Structures
class   CIdLayoutPair
  Internal class to CEikStatusPaneModel, which ties layout resource IDs to layout structures. More...
class   TLayoutChecker

Member Typedef Documentation

typedef CArrayFixFlat<TInt> CEikStatusPaneModelBase::CIdSet [protected]
 
typedef CArrayPtrFlat<CIdLayoutPair> CEikStatusPaneModelBase::CLayoutIdSet [protected]
 

Constructor & Destructor Documentation

IMPORT_C CEikStatusPaneModelBase::~CEikStatusPaneModelBase (   ) 
 

Destructor.

IMPORT_C CEikStatusPaneModelBase::CEikStatusPaneModelBase (  CEikonEnv &  aEikEnv  )  [protected]
 

Constructor.

Parameters:
aEikEnv  An environment for creating controls.

Member Function Documentation

void CEikStatusPaneModelBase::AknLayoutRefresh (   ) 
 

Re-reads layout data for all existing layouts from AknLayout system.

The data may have to be refreshed when e.g. screen resolution, orientation or language variant layout is changed on the fly.

TBool CEikStatusPaneModelBase::AknLayoutUsed (  TInt  aLayoutId  ) 
 

This method tells if given layout is using AknLayout system for placing and sizing the statuspane subpanes.

Parameters:
aLayoutId  Layout which layout type is wanted to be known.
Returns:
ETrue if given layout has been initailized to use AknLayout. EFalse if the default statuspane layout system is in use.
IMPORT_C void CEikStatusPaneModelBase::BaseConstructL (  TInt  aCoreResId  )  [protected]
 

Base constructor for 2nd phase construction.

Parameters:
aCoreResId  Status pane core resource id.
CEikStatusPaneLayout * CEikStatusPaneModelBase::CurrentLayout (   )  const [inline]
 

Gets the current layout.

Returns:
The current layout.
IMPORT_C TInt CEikStatusPaneModelBase::CurrentLayoutResId (   )  const
 

Gets the current layout resource id.

Returns:
The current layout resource id.
TBool CEikStatusPaneModelBase::IsLegalId (  TInt  aLayoutResId  )  const [protected]
 

Checks if given layout id is allowed.

Parameters:
aLayoutResId  Layout id to be checked.
Returns:
ETrue if given layout id is allowed.
CEikStatusPaneModelBase::CIdSet * CEikStatusPaneModelBase::LegalIds (   )  const [inline, protected]
 

Returns set of legal layout ids.

Returns:
Set of allowed status pane layout ids.
IMPORT_C CEikStatusPaneLayout* CEikStatusPaneModelBase::LoadLayoutL (  TInt  aLayoutResId  )  [protected]
 

Loads given layout from resource.

Parameters:
aLayoutResId  Layout resource id.
CEikStatusPaneSetInit * CEikStatusPaneModelBase::PaneInits (   )  const [inline]
 

Gets the pane inits of the status pane.

Returns:
Pane inits.
virtual IMPORT_C void CEikStatusPaneModelBase::SetLayoutL (  TInt  aLayoutResId,
TBool  aChangeStatusPaneNow = ETrue
)  [virtual]
 

Sets the status pane layout.

Parameters:
aLayoutResId  Resource id of the status pane layout.
aChangeStatusPaneNow  A flag to indicate immediate status pane layout change.

Reimplemented in CEikAppStatusPaneModel.

Field Documentation

TInt CEikStatusPaneModelBase::iCurrentResId [protected]
 
CEikonEnv& CEikStatusPaneModelBase::iEikEnv [protected]
 
CLayoutIdSet* CEikStatusPaneModelBase::iLayouts [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top