CEikStatusPane Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eikspane.h>

Inherits CEikStatusPaneBase.

Detailed Description

Application side status pane class.

CEikStatusPane is the interface through which applications use the status pane. This class synchronises the status pane layout with the server side status pane object. To do this, the ApplyCurrentSettingsL() method must be called whenever the owner application switches to the foreground.


Public Member Functions
IMPORT_C  ~CEikStatusPane ()
  Destructor.
IMPORT_C void  ApplyCurrentSettingsL ()
  Synchronises the server status pane layout with the application status pane.
IMPORT_C void  PrepareForAppExit ()
  Prepares the status pane for the application exit.
virtual IMPORT_C void  MakeVisible (TBool aVisible)
  Sets the visiblility of the status pane and its contents.
virtual IMPORT_C void  SetDimmed (TBool aDimmed)
  Sets the status pane and its contents to dimmed state.
virtual IMPORT_C void  SetFaded (TBool aFaded)
  Not implemented.
virtual IMPORT_C void  HandleResourceChange (TInt aType)
  Handles changes in resources which are shared across the environment.
virtual IMPORT_C TBool  OkToChangeStatusPaneNow ()
  Returns always ETrue.

Static Public Member Functions
static IMPORT_C CEikStatusPane *  NewL (CEikonEnv &aEikEnv, RWindowGroup *aParent, TInt aCoreStatusPaneModelResId, TInt aAppStatusPaneModelResId=EEikStatusPaneUseDefaults)
  Two-phased constructor.

Constructor & Destructor Documentation

IMPORT_C CEikStatusPane::~CEikStatusPane (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C void CEikStatusPane::ApplyCurrentSettingsL (   ) 
 

Synchronises the server status pane layout with the application status pane.

virtual IMPORT_C void CEikStatusPane::HandleResourceChange (  TInt  aType  )  [virtual]
 

Handles changes in resources which are shared across the environment.

This function responds to the changes in resources by propagating them to sub-parts of the status pane. From CEikStatusPaneBase.

Parameters:
aType  A message type.

Reimplemented from CEikStatusPaneBase.

virtual IMPORT_C void CEikStatusPane::MakeVisible (  TBool  aVisible  )  [virtual]
 

Sets the visiblility of the status pane and its contents.

From CEikStatusPaneBase.

Parameters:
aVisible  If ETrue the status pane and its contents are set visible.

Reimplemented from CEikStatusPaneBase.

static IMPORT_C CEikStatusPane* CEikStatusPane::NewL (  CEikonEnv &  aEikEnv,
RWindowGroup *  aParent,
TInt  aCoreStatusPaneModelResId,
TInt  aAppStatusPaneModelResId = EEikStatusPaneUseDefaults
)  [static]
 

Two-phased constructor.

Parameters:
aEikEnv  An environment for creating controls and utility functions for manipulating them.
aParent  Pointer to the parent window group.
aCoreStatusPaneModelResId  Status pane core resource ID.
aAppStatusPaneModelResId  Resource ID of the application's status pane.
Returns:
Pointer to the created CEikStatusPane object.
virtual IMPORT_C TBool CEikStatusPane::OkToChangeStatusPaneNow (   )  [virtual]
 

Returns always ETrue.

From CEikStatusPaneBase.

Returns:
ETrue.

Reimplemented from CEikStatusPaneBase.

IMPORT_C void CEikStatusPane::PrepareForAppExit (   ) 
 

Prepares the status pane for the application exit.

Clears the status pane.

virtual IMPORT_C void CEikStatusPane::SetDimmed (  TBool  aDimmed  )  [virtual]
 

Sets the status pane and its contents to dimmed state.

From CEikStatusPaneBase.

Parameters:
aDimmed  If ETrue the status pane and its contents are set to dimmed state.

Reimplemented from CEikStatusPaneBase.

virtual IMPORT_C void CEikStatusPane::SetFaded (  TBool  aFaded  )  [virtual]
 

Not implemented.

From CEikStatusPaneBase.

Parameters:
aFaded  Not used.

Reimplemented from CEikStatusPaneBase.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top