CEikFileNameLabel Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eikfnlab.h>

Inherits CEikBorderedControl.

Detailed Description

File name label is a bordered control that displays the application name.

Public Member Functions
IMPORT_C  CEikFileNameLabel ()
  C++ Default Constructor.
IMPORT_C  ~CEikFileNameLabel ()
  Destructor.
IMPORT_C void  ConstructL ()
  Second phase constructor.
IMPORT_C void  UpdateL ()
  Updates the file name label with the name of the application.
IMPORT_C void  GetColorUseListL (CArrayFix< TCoeColorUse > &aColorUseList) const
  Not used in S60.
IMPORT_C void  HandleResourceChange (TInt aType)
  Handles a change to the control's resources.
IMPORT_C TSize  MinimumSize ()
  Sets the control's minimum required size.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  Handles pointer events.

Protected Member Functions
IMPORT_C void  Draw (const TRect &aRect) const
  Draws the borders of the control.

Constructor & Destructor Documentation

IMPORT_C CEikFileNameLabel::CEikFileNameLabel (   ) 
 

C++ Default Constructor.

Sets the default border.

IMPORT_C CEikFileNameLabel::~CEikFileNameLabel (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C void CEikFileNameLabel::ConstructL (   ) 
 

Second phase constructor.

Completes the construction of a file name label control.

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

Draws the borders of the control.

The screen appearance of derived classes can be changed by overriding this method. By default, this draws a border of the appropriate type around the control.

From CCoeControl.

Parameters:
aRect  Not used.

Reimplemented from CEikBorderedControl.

IMPORT_C void CEikFileNameLabel::GetColorUseListL (  CArrayFix< TCoeColorUse > &  aColorUseList  )  const
 

Not used in S60.

From CCoeControl

Parameters:
aColorUseList  Not used.

Reimplemented from CEikBorderedControl.

IMPORT_C void CEikFileNameLabel::HandlePointerEventL (  const TPointerEvent &  aPointerEvent  ) 
 

Handles pointer events.

This function gets called whenever a pointer event occurs in the control, i.e. when the pointer is within the control's extent, or when the control has grabbed the pointer.

If the pointer event occurs within this control, the function will launch the task swapper.

If overriding this method, the implementation must include a base call to this method.

From CCoeControl.

Parameters:
aPointerEvent  The pointer event.

Reimplemented from CEikBorderedControl.

IMPORT_C void CEikFileNameLabel::HandleResourceChange (  TInt  aType  ) 
 

Handles a change to the control's resources.

The types of resources handled are those which are shared across the environment, e.g. colours or fonts. For colour scheme changes, DrawDeferred() is called in order to redraw the control.

If overriding this method, the implementation must include a base call to this method.

From CCoeControl.

Parameters:
aType  The type of resource that has changed.

Reimplemented from CEikBorderedControl.

IMPORT_C TSize CEikFileNameLabel::MinimumSize (   ) 
 

Sets the control's minimum required size.

This function should be overridden by the concrete control class if the control is to be displayed inside a dialog.

Dialogs set the size and position of their components automatically, and use this function to enquire the minimum size that a control requires.

Other container controls that automatically calculate the layout of their components may also use this function.

From CCoeControl.

Returns:
The minimum size required by the control.
IMPORT_C void CEikFileNameLabel::UpdateL (   ) 
 

Updates the file name label with the name of the application.

If the application is file-based, then the file name of the main document will be shown. Otherwise the label will be the application's caption.

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