Class CEikStatusPane

CEikStatusPane

Support

Supported from 6.0

Description

Client-side view of the status pane. Status panes are server-side objects; this class synchronises the server-side status pane layout with the application’s status pane layout. Synchronisation is necessary as the server may need to change its status pane to reflect changes made by an application to its status pane.

To ensure status pane synchronisation, an application must call the ApplyCurrentSettingsL() method whenever it switches to the foreground.

Derivation

CBase Base class for all classes to be instantiated on the heap CEikStatusPane Client-side view of the status pane CEikStatusPaneBase The base class for the concrete status pane class CEikStatusPane

Defined in CEikStatusPane:
ApplyCurrentSettingsL(), HandleResourceChange(), MakeVisible(), NewL(), SetDimmed(), SetFaded(), ~CEikStatusPane()

Inherited from CBase:
operator new()

Inherited from CEikStatusPaneBase:
ContainerControlL(), ControlL(), IsDimmed(), IsFaded(), IsVisible(), PaneCapabilities(), PaneRectL(), ReduceRect(), SetFlags(), SetObserver(), SwapControlL(), SwitchLayoutL(), TPaneCapabilities

static CEikStatusPane* NewL (CEikonEnv& aEikEnv, RWindowGroup* aParent, TInt aCoreStatusPaneModelResId, TInt aAppStatusPaneModelId);

Description

Static factory method for the application-side status pane.

Parameters

CEikonEnv& aEikEnv The Uikon environment the application will use. RWindowGroup* aParent Parent window group. TInt aCoreStatusPaneModelResId Resource ID of the core status pane model. TInt aAppStatusPaneModelId Resource ID of the application status pane model.

Return value

CEikStatusPane* A newly-constructed status pane object.

~CEikStatusPane();

Description

Destructor

void ApplyCurrentSettingsL();

Description

Synchronises the server-side status pane layout with the application’s status pane layout.

virtual void MakeVisible(TBool aVisible);

Description

Hides or reveals all the controls in the application’s status pane.

Parameters

TBool aVisible If ETrue, the application’s status pane is made visible.

See also:

• CEikStatusPaneBase

void SetDimmed(TBool aDimmed);

Description

Dims all the controls in the application’s status pane. Use SetDimmed() to prevent acceptance of user input and to display the status pane in a lighter or darker shade of grey.

Parameters

TBool aDimmed If ETrue, the application’s status pane is dimmed.

See also:

• CEikStatusPaneBase

void SetFaded(TBool aFaded);

Description

Fades all the controls in the application’s status pane. Use SetFaded() to display the status pane in a lighter or darker colour. The aim of fading is to give the window with focus greater emphasis by contrast with the surrounding windows.

Parameters

TBool aFaded If ETrue, the application’s status pane is faded.

See also:

• CEikStatusPaneBase

void HandleResourceChange(TInt aType);

Support

Supported from 6.1

Description

Handles changes to the visibility of the entire status pane according to the message type identified by the argument aType. Passes the HandleResourceChange() signal to all components of the status pane. Additionally handles KEikMessageEmbedLevelChange messages.

Parameters

TInt aType Message type. These are defined in eikdef.h, for instance KEikMessageFadeAllWindows and KEikMessageColorSchemeChange.