Class CEikBorderedControl

CEikBorderedControl

Support

Supported from 6.0

Description

A control which is drawn surrounded by a rectangular border.

This class is used as the basis for most Uikon controls.

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

Derivation

CBase Base class for all classes to be instantiated on the heap CCoeControl Control base class from which all other controls are derived CEikBorderedControl A control which is drawn surrounded by a rectangular border

Defined in CEikBorderedControl:
Border(), CEikBorderedControl(), Draw(), GetColorUseListL(), HandleResourceChange(), HasBorder(), SetAdjacent(), SetBorder(), iBorder

Inherited from CBase:
operator new()

Inherited from CCoeControl:
ActivateGc(), ActivateL(), BackedUpWindow(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), ComponentControl(), ConstructFromResourceL(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CountComponentControls(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawDeferred(), DrawNow(), DrawableWindow(), EnableDragEvents(), FocusChanged(), GetColor(), GetHelpContext(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleRedrawEvent(), IgnoreEventsUntilNextPointerUp(), Index(), InputCapabilities(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), MakeVisible(), MinimumSize(), Observer(), OfferKeyEventL(), OverrideColorL(), OwnsWindow(), Position(), PositionChanged(), PositionRelativeToScreen(), PrepareForFocusGainL(), PrepareForFocusLossL(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), ResetGc(), SetAllowStrayPointers(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetContainerWindow(), SetContainerWindowL(), SetControlContext(), SetCornerAndSize(), SetCornerAndSizeL(), SetDimmed(), SetExtent(), SetExtentL(), SetExtentToWholeScreen(), SetExtentToWholeScreenL(), SetFocus(), SetFocusing(), SetGloballyCapturing(), SetNeighbor(), SetNonFocusing(), SetObserver(), SetPointerCapture(), SetPosition(), SetRect(), SetRectL(), SetSize(), SetSizeL(), SetSizeWithoutNotification(), SetSizeWithoutNotificationL(), Size(), SizeChanged(), SizeChangedL(), SystemGc(), Window()

CEikBorderedControl();

Description

Default constructor. Constructs a new bordered control that has no border.

CEikBorderedControl(const TGulBorder& aBorder);

Description

Constructor. Constructs a new bordered control.

Parameters

const TGulBorder aBorder The border.

TGulBorder Border() const;

Description

Gets the border type.

Return value

TGulBorder The border type.

void SetBorder(TGulBorder::TBorderType aBorderType);

Description

Sets the border type from enum. Overloaded method which sets the border type to aBorderType for a value from the enum TGulBorder::TBorderType.

Parameters

TGulBorder::TBorderType aBorderType New value for the border type.

void SetBorder(TInt aBorderType);

Description

Sets the border type. Overloaded method which sets the border type to aBorderType.

Parameters

TInt aBorderType New value for the border type.

TBool HasBorder() const;

Description

Tests whether the control has a border. This function overrides CCoeControl::HasBorder().

Return value

TBool ETrue if this control has a border, EFalse otherwise.

void SetAdjacent(TInt aAdjacent);

Description

Sets the control adjacency. Declares that a control abuts another control along one edge, and does not need to be drawn with a full border along that side. This is for use by layout engines or any user code which lays out controls next to one another.

Parameters

TInt aAdjacent A value from TGulAdjacent declaring which edge of this control is shared.

See also:

• CCoeControl::SetAdjacent()

protected: void Draw(const TRect& aRect) const;

Description

Draws the border around the control. This function also clears the central area if the IsBlank() method returns ETrue.

Parameters

const TRect& aRect Optional. If supplied, the screen rectangle to be updated.

See also:

• CCoeControl::IsBlank()
• Border()

void GetColorUseListL(CArrayFix<TCoeColorUse>& aColorUseList) const;

Description

Gets the list of logical colours employed in the drawing the control. Appends the list to aColorUseList together with an explanation of how the colours are used.

Parameters

CArrayFix<TCoeColorUse>& aColorUseList On return, the list of logical colours.

void HandleResourceChange(TInt aType);

Description

Handles a change to the control's resources that are shared across the environment. Examples include colors or fonts.

Parameters

TInt aType The type of resource that has changed.

Description

Specifies the control’s border.

TGulBorder iBorder

Description

The control’s border.