CEikStatusPaneLayoutTree Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eikspmod.h>

Detailed Description

This class calculates and stores the screen area available for each layout tree.

Public Types
enum   TDirection { EHorizontal, EVertical }

Public Member Functions
  ~CEikStatusPaneLayoutTree ()
  Destructor.
CEikStatusPaneLayoutTree *  Find (const TPaneId &aPaneId)
  Finds the layout tree with a given pane id.
void  AcceptL (MEikStatusPaneLayoutTreeVisitor *aVisitor)
  Calls given visitor objects VisitL, method.
TPaneId  Id () const
  Gets pane id.
TRect  Rect () const
  Gets rectagle of the layout tree.
TRect  AknLayoutRect (TInt aLayoutResourceId, TPaneId aPaneId)
  This method maps given layout resource id and subpane UID to correct layout lines in the AknLayout system.

Static Public Member Functions
static CEikStatusPaneLayoutTree *  NewL (CEikStatusPaneLayout *aLayout, TResourceReader &aResource, TDirection aDefaultDirection=EHorizontal)
  Two phase constructor.

Friends
class  CEikStatusPaneLayout

Member Enumeration Documentation

enum CEikStatusPaneLayoutTree::TDirection
 
Enumerator:
EHorizontal  Horizontal direction.
EVertical  Vertical direction.

Constructor & Destructor Documentation

CEikStatusPaneLayoutTree::~CEikStatusPaneLayoutTree (   ) 
 

Destructor.

Member Function Documentation

void CEikStatusPaneLayoutTree::AcceptL (  MEikStatusPaneLayoutTreeVisitor *  aVisitor  ) 
 

Calls given visitor objects VisitL, method.

Additionally calls AcceptL -method of each sub pane layouts inside this layout tree.

Parameters:
aVisitor  A visitor object to be visited.
TRect CEikStatusPaneLayoutTree::AknLayoutRect (  TInt  aLayoutResourceId,
TPaneId  aPaneId
) 
 

This method maps given layout resource id and subpane UID to correct layout lines in the AknLayout system.

Parameters:
aLayoutResourceId  Id of a statuspane layout.
aPaneId  Uid of a statuspane subpane.
Returns:
A rectangle which specifies the given subpane size and position in the given layout.
CEikStatusPaneLayoutTree* CEikStatusPaneLayoutTree::Find (  const TPaneId &  aPaneId  ) 
 

Finds the layout tree with a given pane id.

Parameters:
aPaneId  A id of the pane.
Returns:
If layout tree was found, a pointer to layout tree with given id. Otherwise NULL is returned.
TPaneId CEikStatusPaneLayoutTree::Id (   )  const [inline]
 

Gets pane id.

Returns:
id of the pane.
static CEikStatusPaneLayoutTree* CEikStatusPaneLayoutTree::NewL (  CEikStatusPaneLayout *  aLayout,
TResourceReader &  aResource,
TDirection  aDefaultDirection = EHorizontal
)  [static]
 

Two phase constructor.

Parameters:
aLayout  Layout data
aResource  Resource of layout tree.
aDefaultDirection  Default direction of the layout tree.
TRect CEikStatusPaneLayoutTree::Rect (   )  const [inline]
 

Gets rectagle of the layout tree.

Returns:
Rectangle of the layout tree.

Friends And Related Function Documentation

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