CAknNaviLabel Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknnavilabel.h>

Inherits CAknControl.

Detailed Description

Label control to the status pane's navigation pane.

Public Types
enum   TNaviLabelType { ENavigationLabel, EAdditionalInfoLabel, EHintText }

Public Member Functions
IMPORT_C  CAknNaviLabel ()
  Constructor.
IMPORT_C  ~CAknNaviLabel ()
  Destructor.
IMPORT_C void  SetNaviLabelType (TNaviLabelType aNaviLabelType)
  Set type of the label.
IMPORT_C TNaviLabelType  NaviLabelType ()
  Returns type of the label.
IMPORT_C void  SetTextL (const TDesC &aText)
  Sets navigation label text.
const TDesC *  Text () const
  Returns the current label text.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl.

Protected Member Functions
virtual IMPORT_C void  SizeChanged ()
  From CCoeControl.
IMPORT_C void  Draw (const TRect &aRect) const
  From CCoeControl.

Member Enumeration Documentation

enum CAknNaviLabel::TNaviLabelType
 
Enumerator:
ENavigationLabel 
EAdditionalInfoLabel 
EHintText 

Constructor & Destructor Documentation

IMPORT_C CAknNaviLabel::CAknNaviLabel (   ) 
 

Constructor.

IMPORT_C CAknNaviLabel::~CAknNaviLabel (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C void CAknNaviLabel::Draw (  const TRect &  aRect  )  const [protected]
 

From CCoeControl.

Draw a control.

Parameters:
aRect  The region of the control to be redrawn.
IMPORT_C void CAknNaviLabel::HandlePointerEventL (  const TPointerEvent &  aPointerEvent  ) 
 

From CCoeControl.

Handles pointer event.

Parameters:
aPointerEvent  Pointer event to be handled.
IMPORT_C TNaviLabelType CAknNaviLabel::NaviLabelType (   ) 
 

Returns type of the label.

Returns:
navigation label type.
IMPORT_C void CAknNaviLabel::SetNaviLabelType (  TNaviLabelType  aNaviLabelType  ) 
 

Set type of the label.

Parameters:
aNaviLabelType  navigation label type.
IMPORT_C void CAknNaviLabel::SetTextL (  const TDesC &  aText  ) 
 

Sets navigation label text.

Parameters:
aText  reference to the navigation text.
virtual IMPORT_C void CAknNaviLabel::SizeChanged (   )  [protected, virtual]
 

From CCoeControl.

Handle the size change events.

const TDesC * CAknNaviLabel::Text (   )  const [inline]
 

Returns the current label text.

Returns:
label text. Ownership of the text is not transfered.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top