CEikAlignedControl Class Reference

API published in: S60 1st Ed

Link against: eikcoctl.lib avkon.lib

Capability Information

Required Capabilities

None

#include <eikalign.h>

Inherits CAknControl.

Inherited by CEikImage, and CEikLabel.

Detailed Description

Extends CAknControl to support control alignment and margins.

Public Member Functions
IMPORT_C  CEikAlignedControl ()
  C++ default constructor.
IMPORT_C  ~CEikAlignedControl ()
  Destructor.
IMPORT_C void  SetAllMarginsTo (TInt aValue)
  Sets all of the control's margins.
IMPORT_C void  SetAlignment (TGulAlignmentValue aAlign)
  Sets the control's alignment.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  Handles pointer events.

Data Fields
TMargins8  iMargin
  The control's margins.
TGulAlignment  iAlignment
  The control's alignment.

Protected Member Functions
IMPORT_C void  WriteInternalStateL (RWriteStream &aWriteStream) const
  Writes the internal state of the control and its components to aWriteStream.

Constructor & Destructor Documentation

IMPORT_C CEikAlignedControl::CEikAlignedControl (   ) 
 

C++ default constructor.

IMPORT_C CEikAlignedControl::~CEikAlignedControl (   ) 
 

Destructor.

Member Function Documentation

IMPORT_C void CEikAlignedControl::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. The control should implement this function to handle pointer events.

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

From CCoeControl.

Parameters:
aPointerEvent  The pointer event.

Reimplemented in CEikImage, and CEikLabel.

IMPORT_C void CEikAlignedControl::SetAlignment (  TGulAlignmentValue  aAlign  ) 
 

Sets the control's alignment.

Parameters:
aAlign  The alignment to be set to the control.
IMPORT_C void CEikAlignedControl::SetAllMarginsTo (  TInt  aValue  ) 
 

Sets all of the control's margins.

Parameters:
aValue  The number of pixels to which all margins will be set.
IMPORT_C void CEikAlignedControl::WriteInternalStateL (  RWriteStream &  aWriteStream  )  const [protected]
 

Writes the internal state of the control and its components to aWriteStream.

Does nothing in release mode. Designed to be overridden and base called from subclasses.

From CCoeControl.

Parameters:
[in,out]  aWriteStream  A connected write stream.

Reimplemented in CEikImage, and CEikLabel.

Field Documentation

TGulAlignment CEikAlignedControl::iAlignment
 

The control's alignment.

TMargins8 CEikAlignedControl::iMargin
 

The control's margins.

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