CEikBorderedControl in QEikStd

class CEikBorderedControl : public CCoeControl, public MEikBorderedControl;

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

MEikBorderedControl - Interface for bordered controls

MObjectProvider - An interface that allows an object to be part of a network of object providers
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

Members

Defined in CEikBorderedControl:
ActivateL(), Border(), CEikBorderedControl(), CEikBorderedControl(), ComponentControl(), ConstructFromResourceL(), CountComponentControls(), Draw(), FocusChanged(), GetColorUseListL(), GetHelpContext(), HandleControlArrayEventL(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleResourceChange(), HasBorder(), InputCapabilities(), MakeVisible(), MinimumSize(), MopSupplyObject(), OfferKeyEventL(), PositionChanged(), PrepareForFocusGainL(), PrepareForFocusLossL(), RequestRelayout(), SetAdjacent(), SetBorder(), SetBorder(), SetContainerWindowL(), SetDimmed(), SetLayoutManagerL(), SetNeighbor(), SetParent(), SetTextBaselineSpacing(), SizeChanged(), TextBaselineOffset(), WriteInternalStateL(), iBorder

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CCoeControl:
AccumulatedZoom(), ActivateGc(), BackedUpWindow(), Background(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), ComponentArrayExists(), Components(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawBackground(), DrawDeferred(), DrawForeground(), DrawNow(), DrawableWindow(), EAbsoluteZoom, ERelativeZoom, EnableDragEvents(), FindBackground(), FindFontProvider(), GetColor(), GetGc(), GetTextDrawer(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandleRedrawEvent(), HitTest(), IgnoreEventsUntilNextPointerUp(), Index(), InitComponentArrayL(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), LayoutManager(), MaximumWidth(), MopNext(), Observer(), OverrideColorL(), OwnsWindow(), Parent(), Position(), PositionRelativeToScreen(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), Reserved_2(), ResetGc(), ScreenFont(), SetAllowStrayPointers(), SetBackground(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetControlContext(), SetCornerAndSize(), SetExtent(), SetExtentToWholeScreen(), SetFocus(), SetFocusing(), SetFontProviderL(), SetGc(), SetGloballyCapturing(), SetHitTest(), SetMaximumWidth(), SetMopParent(), SetNonFocusing(), SetObserver(), SetPointerCapture(), SetPosition(), SetRect(), SetSize(), SetSizeWithoutNotification(), SetUniqueHandle(), SetZoomFactorL(), Size(), SystemGc(), TZoomType, TextDrawer(), UniqueHandle(), Window(), ZoomWithType(), iCoeEnv, iContext, iPosition, iSize

Inherited from MEikBorderedControl:
ETypeId, anonymous

Inherited from MObjectProvider:
MObjectProvider_Reserved1(), MObjectProvider_Reserved2(), MopGetObject(), MopGetObjectNoChaining()

IMPORT_C CEikBorderedControl();

Description

Default constructor.

Constructs a new bordered control that has no border.

IMPORT_C CEikBorderedControl(const TGulBorder &aBorder);

Description

Constructor.

Constructs a new bordered control.

Parameters

const TGulBorder &aBorder

virtual IMPORT_C TTypeUid::Ptr MopSupplyObject(TTypeUid aId);

Description

Gets an object whose type is encapsulated by the specified TTypeUid object.

Parameters


TTypeUid aId

Encapsulates the Uid that identifies the type of object required.

Return value

TTypeUid::Ptr

Encapsulates the pointer to the object provided. Note that the encapsulated pointer may be NULL.

virtual IMPORT_C TBool HasBorder() const;

Description

Tests whether the control has a border.

This function overrides CCoeControl::HasBorder() .

Return value

TBool

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

virtual IMPORT_C void SetAdjacent(TInt aAdjacent);

Description

Sets 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

virtual IMPORT_C 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

virtual IMPORT_C 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

virtual IMPORT_C 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

virtual IMPORT_C void SetBorder(TInt aBorderType);

Description

Sets the border type to aBorderType. Any one of the values from the enums TGulBorder::TBorderType or TGulBorder::TLogicalType specifies a valid border type. Custom border types can be created by selecting

one value from each of the enums TGulBorder::T3DStyle and TGulBorder::TConstructionStyle,
at most one value from the enums TGulBorder::TOutlineStyle and TGulBorder::TInlineStyle,
at least one value from the enums TGulBorder::TThickness and TGulBorder::TRounding

and ORing these values together.

.0

Parameters


TInt aBorderType

virtual IMPORT_C TGulBorder Border() const;

Description

Gets the border type.

Return value

TGulBorder

"TGulBorder" The border type.

protected: virtual IMPORT_C 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

protected: virtual IMPORT_C void WriteInternalStateL(RWriteStream &aWriteStream) const;

Description

Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.

Parameters


RWriteStream &aWriteStream

virtual IMPORT_C TKeyResponse OfferKeyEventL(const TKeyEvent &aKeyEvent, TEventCode aType);

Description

Handles key events. From CCoeControl .

Parameters

`const TKeyEvent &aKeyEvent`	The key event.
`TEventCode aType`	The type of key event: EEventKey, EEventKeyUp or EEventKeyDown.

Return value

TKeyResponse

Indicates whether or not the key event was used by this control.

Description

Sets this control as visible or invisible. From CCoeControl .

Parameters


TBool aVisible

ETrue to make the control visible, EFalse to make it invisible.

Description

Sets the control to be dimmed. From CCoeControl .

Parameters


TBool aDimmed

ETrue to dim the control, EFalse to set the control as not dimmed.

Description

Sets the control's containing window by copying it from aContainer. From CCoeControl .

Parameters

const CCoeControl &aContainer

The compound control that is the container for this control

Description

Constructs the control from a resource file. From CCoeControl .

Parameters


TResourceReader &aReader

The resource reader to use.

Description

Sets the control as ready to be drawn. From CCoeControl .

Description

Prepares the control for loss of focus. From CCoeControl .

Description

Prepares the control for gaining focus. From CCoeControl .

Description

Sets an associated control. From CCoeControl .

Parameters


CCoeControl *aNeighbor

A control to be used by this function.

Description

Gets the control's minimum required size. From CCoeControl .

Return value

TSize

The minimum size required by the control.

Description

Gets the control's help context. From CCoeControl .

Parameters


TCoeHelpContext &aContext

The control's help context

Description

Gets the control's input capabilities. From CCoeControl .

Return value

TCoeInputCapabilities

The control's input capabilities.

Description

Sets aParent as the parent of this control. From CCoeControl .

Parameters


CCoeControl *aParent

The control to set as this control's parent.

Return value

TInt

KErrNone if successful, otherwise another of the system error codes.

Description

Sets the layout manager From CCoeControl .

Parameters


MCoeLayoutManager *aLayout

The new layout manager, NULL if you just want to remove the current layout manager.

Description

Requests a relayout. From CCoeControl .

Parameters

const CCoeControl *aChildControl

The child control that requests the relayout, might be NULL.

Return value

TBool

ETrue if the request is addressed, otherwise EFalse

Description

Gets the offset to the first text baseline relative to the top of the control. From CCoeControl .

Parameters

const TSize &aSize

The offset of the baseline may depend on the size of the control. This argument specifies the size to use when computing the baseline offset.

Return value

TInt

The offset of the baseline from the top of the control.

Description

Sets the spacing between text baselines. From CCoeControl .

Parameters


TInt aSpacing

The baseline spacing i.e. the space in pixels between the text baselines.

Description

Handles pointer events. From CCoeControl .

Parameters

const TPointerEvent &aPointerEvent

The pointer event.

Description

Gets the number of controls contained in a compound control. From CCoeControl .

Return value

TInt

The number of component controls contained by this control.

Description

Gets an indexed component of a compound control. From CCoeControl .

Parameters


TInt aIndex

The index of the control.

Return value

CCoeControl *

The component control with an index of aIndex.

Description

Handles pointer buffer ready events. From CCoeControl .

Description

Responds to a change in focus. From CCoeControl .

Parameters


TDrawNow aDrawNow

Contains the value that was passed to it by SetFocus().

Description

Responds to changes to the size and position of the contents of this control. From CCoeControl .

Description

Responds to changes in the position of a control. From CCoeControl .

Description

Handles events generated by the CCoeControlArray. From CCoeControl .

Parameters

`CCoeControlArray::TEvent aEvent`	The type of the event
`const CCoeControlArray *aArray`	The array that generated the event
`CCoeControl *aControl`	The control affected by the event
`TInt aControlId`	The id of the control affected by the event

Class CEikBorderedControl

Description

Derivation

Members

Construction and destruction