Class CEikAlignedControl

class CEikAlignedControl : public CCoeControl, public MEikAlignedControl;

Description

Base class for aligned controls.

The CEikAlignedControl class extends the CCoeControl class in order to support extra functionality such as control alignment and margins.

It is only intended as a simple starting point for controls.

Derivation

• MEikAlignedControl - Interface for aligned 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
• CEikAlignedControl - Base class for aligned controls

Members

Defined in CEikAlignedControl:
ActivateL(), Alignment(), CEikAlignedControl(), ComponentControl(), ConstructFromResourceL(), CountComponentControls(), FocusChanged(), GetColorUseListL(), GetHelpContext(), HandleControlArrayEventL(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleResourceChange(), HasBorder(), InputCapabilities(), MakeVisible(), Margins(), MinimumSize(), MopSupplyObject(), OfferKeyEventL(), PositionChanged(), PrepareForFocusGainL(), PrepareForFocusLossL(), RequestRelayout(), SetAdjacent(), SetAlignment(), SetAllMarginsTo(), SetContainerWindowL(), SetDimmed(), SetLayoutManagerL(), SetNeighbor(), SetParent(), SetTextBaselineSpacing(), SizeChanged(), TextBaselineOffset(), WriteInternalStateL(), iAlignment, iMargin, ~CEikAlignedControl()

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(), Draw(), 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 MEikAlignedControl:
ETypeId, anonymous

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

IMPORT_C CEikAlignedControl();

Description

Default constructor.

IMPORT_C ~CEikAlignedControl();

Description

Destructor.

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

Description

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

Parameters

Return value

virtual IMPORT_C void SetAllMarginsTo(TInt aValue);

Description

Sets all margins.

Parameters

virtual IMPORT_C void SetAlignment(TGulAlignmentValue aAlign);

Description

Sets control alignment.

Parameters

virtual IMPORT_C TMargins8 &Margins();

Description

Return value

virtual IMPORT_C TGulAlignment &Alignment();

Description

Return value

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

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

Description

Handles key events. From CCoeControl .

Parameters

Return value

See also:

• CCoeControl::OfferKeyEventL()

virtual IMPORT_C void MakeVisible(TBool aVisible);

Description

Sets this control as visible or invisible. From CCoeControl .

Parameters

See also:

• CCoeControl::MakeVisible()

virtual IMPORT_C void SetDimmed(TBool aDimmed);

Description

Sets the control to be dimmed. From CCoeControl .

Parameters

See also:

• CCoeControl::SetDimmed()

virtual IMPORT_C void SetContainerWindowL(const CCoeControl &aContainer);

Description

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

Parameters

See also:

• CCoeControl::SetContainerWindowL()

virtual IMPORT_C void ConstructFromResourceL(TResourceReader &aReader);

Description

Constructs the control from a resource file. From CCoeControl .

Parameters

See also:

• CCoeControl::ConstructFromResourceL()

virtual IMPORT_C void ActivateL();

Description

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

See also:

• CCoeControl::ActivateL()

virtual IMPORT_C void PrepareForFocusLossL();

Description

Prepares the control for loss of focus. From CCoeControl .

See also:

• CCoeControl::PrepareForFocusLossL()

virtual IMPORT_C void PrepareForFocusGainL();

Description

Prepares the control for gaining focus. From CCoeControl .

See also:

• CCoeControl::PrepareForFocusGainL()

virtual IMPORT_C void SetAdjacent(TInt aAdjacent);

Description

Sets the control's appearance when it is next to other controls. From CCoeControl .

Parameters

See also:

• CCoeControl::SetAdjacent()

virtual IMPORT_C void SetNeighbor(CCoeControl *aNeighbor);

Description

Sets an associated control. From CCoeControl .

Parameters

See also:

• CCoeControl::SetNeighbor()

virtual IMPORT_C TBool HasBorder() const;

Description

Tests if the control has a border. From CCoeControl .

Return value

See also:

• CCoeControl::HasBorder()

virtual IMPORT_C TSize MinimumSize();

Description

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

Return value

See also:

• CCoeControl::MinimumSize()

virtual IMPORT_C void HandleResourceChange(TInt aType);

Description

Handles a change to the control's resources. From CCoeControl .

Parameters

See also:

• CCoeControl::HandleResourceChange()

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

Description

Gets the list of logical colours used to draw the control. From CCoeControl .

Parameters

See also:

• CCoeControl::GetColorUseListL()

virtual IMPORT_C void GetHelpContext(TCoeHelpContext &aContext) const;

Description

Gets the control's help context. From CCoeControl .

Parameters

See also:

• CCoeControl::GetHelpContext()

virtual IMPORT_C TCoeInputCapabilities InputCapabilities() const;

Description

Gets the control's input capabilities. From CCoeControl .

Return value

See also:

• CCoeControl::InputCapabilities()

virtual IMPORT_C TInt SetParent(CCoeControl *aParent);

Description

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

Parameters

Return value

See also:

• CCoeControl::SetParent()

virtual IMPORT_C void SetLayoutManagerL(MCoeLayoutManager *aLayout);

Description

Sets the layout manager From CCoeControl .

Parameters

See also:

• CCoeControl::SetLayoutManagerL()

virtual IMPORT_C TBool RequestRelayout(const CCoeControl *aChildControl);

Description

Requests a relayout. From CCoeControl .

Parameters

Return value

See also:

• CCoeControl::RequestRelayout()

virtual IMPORT_C TInt TextBaselineOffset(const TSize &aSize) const;

Description

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

Parameters

Return value

See also:

• CCoeControl::TextBaselineOffset()

virtual IMPORT_C void SetTextBaselineSpacing(TInt aSpacing);

Description

Sets the spacing between text baselines. From CCoeControl .

Parameters

See also:

• CCoeControl::SetTextBaselineSpacing()

virtual IMPORT_C void HandlePointerEventL(const TPointerEvent &aPointerEvent);

Description

Handles pointer events. From CCoeControl .

Parameters

See also:

• CCoeControl::HandlePointerEventL()

virtual IMPORT_C TInt CountComponentControls() const;

Description

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

Return value

See also:

• CCoeControl::CountComponentControls()

virtual IMPORT_C CCoeControl *ComponentControl(TInt aIndex) const;

Description

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

Parameters

Return value

See also:

• CCoeControl::ComponentControl()

protected: virtual IMPORT_C void HandlePointerBufferReadyL();

Description

Handles pointer buffer ready events. From CCoeControl .

See also:

• CCoeControl::HandlePointerBufferReadyL()

protected: virtual IMPORT_C void FocusChanged(TDrawNow aDrawNow);

Description

Responds to a change in focus. From CCoeControl .

Parameters

See also:

• CCoeControl::FocusChanged()

protected: virtual IMPORT_C void SizeChanged();

Description

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

See also:

• CCoeControl::SizeChanged()

protected: virtual IMPORT_C void PositionChanged();

Description

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

See also:

• CCoeControl::PositionChanged()

protected: virtual IMPORT_C void HandleControlArrayEventL(CCoeControlArray::TEvent aEvent, const CCoeControlArray *aArray, CCoeControl *aControl, TInt aControlId);

Description

Handles events generated by the CCoeControlArray. From CCoeControl .

Parameters

See also:

• CCoeControl::HandleControlArrayEventL()

TMargins8 iMargin;

Description

TGulAlignment iAlignment;

Description