CEikSpacer Class Reference

API published in: S60 1st Ed

Link against: eikctl.lib eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eikspace.h>

Inherits CAknControl.

Detailed Description

An invisible control that is used to provide a space between visible controls.

It has a width, a height and a color. The spacer is normally drawn using the background color so that it is invisible.

Its associated resource struct is SPACER and its control factory identifier is EEikCtSpacer.


Public Member Functions
IMPORT_C�	CEikSpacer ()
�	Default C++ constructor.
IMPORT_C�	CEikSpacer (TInt aWidth, TInt aHeight, TRgb aColor)
�	C++ constructor with a width, height and color.
IMPORT_C�	~CEikSpacer ()
�	Destructor.
IMPORT_C void�	SetWidth (TInt aWidth)
�	Sets the spacer's width.
IMPORT_C void�	SetHeight (TInt aHeight)
�	Sets the spacer's height.
IMPORT_C void�	SetColor (TRgb aColor)
�	Sets the spacer's color.
IMPORT_C void�	SetClear (TBool aClear)
�	Specifies whether the spacer is drawn using the standard brush color.
IMPORT_C void�	HandlePointerEventL (const TPointerEvent &aPointerEvent)
�	Handles pointer events.

Constructor & Destructor Documentation

IMPORT_C CEikSpacer::CEikSpacer

(�

�)�

�	Default C++ constructor. The spacer's color is initialised to white.

IMPORT_C CEikSpacer::CEikSpacer	(�	TInt�	aWidth,
		TInt�	aHeight,
		TRgb�	aColor
	)�

�

C++ constructor with a width, height and color.

Parameters:

	aWidth�	The spacer's width.
	aHeight�	The spacer's height.
	aColor�	The spacer's color.

IMPORT_C CEikSpacer::~CEikSpacer

(�

�)�

�	Destructor.

Member Function Documentation

IMPORT_C void CEikSpacer::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 overriding this method, the implementation must include a base call to this method.

From CCoeControl.

Parameters:

aPointerEvent�

The pointer event.

IMPORT_C void CEikSpacer::SetClear

Specifies whether the spacer is drawn using the standard brush color.

If the "Is clear" flag is set, the spacer's color value is ignored, and it is drawn using the brush color defined in the system's standard graphics context. By default, the "Is clear" flag is unset.

Parameters:

aClear� ETrue to set the "Is clear" flag, EFalse to unset it.

IMPORT_C void CEikSpacer::SetColor

Sets the spacer's color.

Parameters:

aColor�

The spacer's color.