CEikSpacer Class Reference

#include <mw/eikspace.h>

Link against: eikctl.lib

class CEikSpacer : public CAknControl

Inherits from

CEikSpacer
- CAknControl

Public Member Functions
	CEikSpacer()
	CEikSpacer(TInt, TInt, TRgb)
	~CEikSpacer()
virtual IMPORT_C void	HandlePointerEventL(const TPointerEvent &)
IMPORT_C void	SetClear(TBool)
IMPORT_C void	SetColor(TRgb)
IMPORT_C void	SetHeight(TInt)
IMPORT_C void	SetWidth(TInt)

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize

Inherited Enumerations
	CCoeControl:TZoomType

Inherited Functions
	CAknControl::CAknControl()
	CAknControl::~CAknControl()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CCoeControl::AccumulatedZoom()const
	CCoeControl::ActivateGc()const
	CCoeControl::ActivateL()
	CCoeControl::BackedUpWindow()const
	CCoeControl::Background()const
	CCoeControl::CCoeControl()
	CCoeControl::CCoeControl(CCoeEnv *)
	CCoeControl::CCoeControl(const CCoeControl &)
	CCoeControl::CCoeControlArray
	CCoeControl::CapturesPointer()const
	CCoeControl::ClaimPointerGrab(TBool)
	CCoeControl::ClaimPointerGrab(TInt,TBool)
	CCoeControl::CloseWindow()
	CCoeControl::ComponentArrayExists()const
	CCoeControl::ComponentControl(TInt)const
	CCoeControl::Components()
	CCoeControl::Components()const
	CCoeControl::ControlContext()const
	CCoeControl::ControlEnv()const
	CCoeControl::CopyControlContextFrom(const CCoeControl *)
	CCoeControl::CountComponentControls()const
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
	CCoeControl::CreateWindowL()
	CCoeControl::CreateWindowL(RWindowGroup *)
	CCoeControl::CreateWindowL(RWindowTreeNode &)
	CCoeControl::CreateWindowL(const CCoeControl *)
	CCoeControl::CustomGc()const
	CCoeControl::DeactivateGc()const
	CCoeControl::DrawBackground(const TRect &)const
	CCoeControl::DrawDeferred()const
	CCoeControl::DrawForeground(const TRect &)const
	CCoeControl::DrawNow()const
	CCoeControl::DrawNow(const TRect &)const
	CCoeControl::DrawableWindow()const
	CCoeControl::EnableDragEvents()
	CCoeControl::EnableReportControlStateChange(TBool)
	CCoeControl::EnableWindowTransparency()
	CCoeControl::FindBackground()const
	CCoeControl::FindFontProvider()const
	CCoeControl::FocusChanged(TDrawNow)
	CCoeControl::GetColor(TInt,TRgb &)const
	CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
	CCoeControl::GetGc()const
	CCoeControl::GetHelpContext(TCoeHelpContext &)const
	CCoeControl::GrabbingComponent()const
	CCoeControl::GrabbingComponent(TInt)const
	CCoeControl::HandleComponentControlsResourceChange(TInt)
	CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray ,CCoeControl ,TInt)
	CCoeControl::HandlePointerBufferReadyL()
	CCoeControl::HandleRedrawEvent(const TRect &)const
	CCoeControl::HandleResourceChange(TInt)
	CCoeControl::HasBorder()const
	CCoeControl::HitTest()const
	CCoeControl::IgnoreEventsUntilNextPointerUp()
	CCoeControl::Index(const CCoeControl *)const
	CCoeControl::InitComponentArrayL()
	CCoeControl::InputCapabilities()const
	CCoeControl::IsActivated()const
	CCoeControl::IsBackedUp()const
	CCoeControl::IsBeingDestroyed()const
	CCoeControl::IsBlank()const
	CCoeControl::IsDimmed()const
	CCoeControl::IsFocused()const
	CCoeControl::IsNonFocusing()const
	CCoeControl::IsReadyToDraw()const
	CCoeControl::IsVisible()const
	CCoeControl::LayoutManager()const
	CCoeControl::MakeVisible(TBool)
	CCoeControl::MaximumWidth()const
	CCoeControl::MinimumSize()
	CCoeControl::MopSupplyObject(TTypeUid)
	CCoeControl::NotifyFontChange(const CCoeFontProvider *)
	CCoeControl::Observer()const
	CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
	CCoeControl::OverrideColorL(TInt,TRgb)
	CCoeControl::OwnsWindow()const
	CCoeControl::Parent()
	CCoeControl::Parent()const
	CCoeControl::Position()const
	CCoeControl::PositionChanged()
	CCoeControl::PositionRelativeToScreen()const
	CCoeControl::PrepareForFocusGainL()
	CCoeControl::PrepareForFocusLossL()
	CCoeControl::ProcessPointerBufferReadyL()
	CCoeControl::ProcessPointerEventL(const TPointerEvent &)
	CCoeControl::Rect()const
	CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
	CCoeControl::RecursivelyMergedInputCapabilities()const
	CCoeControl::RefetchPixelMappingL()
	CCoeControl::RemoveFromParent()
	CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
	CCoeControl::RequestRelayout(const CCoeControl *)
	CCoeControl::ResetGc()const
	CCoeControl::ScreenFont(const TCoeFont &)const
	CCoeControl::SetAdjacent(TInt)
	CCoeControl::SetAllowStrayPointers()
	CCoeControl::SetBackground(const MCoeControlBackground *)
	CCoeControl::SetBlank()
	CCoeControl::SetCanDrawOutsideRect()
	CCoeControl::SetComponentsToInheritVisibility(TBool)
	CCoeControl::SetContainerWindowL(RBackedUpWindow &)
	CCoeControl::SetContainerWindowL(RWindow &)
	CCoeControl::SetContainerWindowL(const CCoeControl &)
	CCoeControl::SetControlContext(MCoeControlContext *)
	CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
	CCoeControl::SetCustomGc(CWindowGc *)
	CCoeControl::SetDimmed(TBool)
	CCoeControl::SetExtent(const TPoint &,const TSize &)
	CCoeControl::SetExtentToWholeScreen()
	CCoeControl::SetFocus(TBool,TDrawNow)
	CCoeControl::SetFocusing(TBool)
	CCoeControl::SetFontProviderL(const CCoeFontProvider &)
	CCoeControl::SetGc(CWindowGc *)const
	CCoeControl::SetGloballyCapturing(TBool)
	CCoeControl::SetHitTest(const MCoeControlHitTest *)
	CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
	CCoeControl::SetMaximumWidth(TInt)
	CCoeControl::SetMopParent(MObjectProvider *)
	CCoeControl::SetNeighbor(CCoeControl *)
	CCoeControl::SetNonFocusing()
	CCoeControl::SetObserver(MCoeControlObserver *)
	CCoeControl::SetParent(CCoeControl *)
	CCoeControl::SetPointerCapture(TBool)
	CCoeControl::SetPosition(const TPoint &)
	CCoeControl::SetRect(const TRect &)
	CCoeControl::SetSize(const TSize &)
	CCoeControl::SetSizeWithoutNotification(const TSize &)
	CCoeControl::SetTextBaselineSpacing(TInt)
	CCoeControl::SetUniqueHandle(TInt)
	CCoeControl::SetZoomFactorL(TInt,TZoomType)
	CCoeControl::Size()const
	CCoeControl::SizeChanged()
	CCoeControl::SystemGc()const
	CCoeControl::TextBaselineOffset(const TSize &)const
	CCoeControl::TextDrawer(TInt)const
	CCoeControl::UniqueHandle()const
	CCoeControl::Window()const
	CCoeControl::WriteInternalStateL(RWriteStream &)const
	CCoeControl::WriteInternalStateNowL(RWriteStream &)const
	CCoeControl::ZoomWithType()const
	CCoeControl::operator=(const CCoeControl &)
	CCoeControl::~CCoeControl()

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.

Since: S60 0.9

Constructor & Destructor Documentation

CEikSpacer ( )

IMPORT_C

CEikSpacer

(

)

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

CEikSpacer ( TInt, TInt, TRgb )

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

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

Parameter	Description
aWidth	The spacer's width.
aHeight	The spacer's height.
aColor	The spacer's color.

~CEikSpacer ( )

IMPORT_C

~CEikSpacer

(

)

Destructor.

Member Function Documentation

HandlePointerEventL ( const TPointerEvent & )

IMPORT_C void

HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

[virtual]

Reimplemented from CCoeControl::HandlePointerEventL(const TPointerEvent &)

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.

Parameter	Description
aPointerEvent	The pointer event.

SetClear ( TBool )

IMPORT_C void

SetClear

(

TBool

aClear

)

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.

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

SetColor ( TRgb )

IMPORT_C void

SetColor

(

TRgb

aColor

)

Sets the spacer's color.

Parameter	Description
aColor	The spacer's color.

SetHeight ( TInt )

IMPORT_C void

SetHeight

(

TInt

aHeight

)

Sets the spacer's height.

Parameter	Description
aHeight	The spacer's height.

SetWidth ( TInt )

IMPORT_C void

SetWidth

(

TInt

aWidth

)

Sets the spacer's width.

Parameter	Description
aWidth	The spacer's width.