UIQ Technology
Symbian OS Library

UIQ 3.1 SDK        UIQ developer portal

[Index] [Spacer] [Previous] [Next]

Location: EIKALIGN.H
Link against: eikcoctl.lib

Class CEikAlignedTextControl

class CEikAlignedTextControl : public CEikAlignedControl, public MEikAlignedTextControl;

Description

Base class for aligned text controls.

The CEikAlignedTextControl class extends the CCoeControl class in order to support extra functionality for aligned text controls.

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

Derivation

  • 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

    • Members

    Defined in CEikAlignedTextControl:
    ActivateL(), Alignment(), 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()

    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 CEikAlignedControl:
    iAlignment, iMargin

    Inherited from MEikAlignedControl:
    ETypeId, anonymous

    Inherited from MEikAlignedTextControl:
    SetAutoWrapping(), SetNumberOfVisibleLines()

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

    Member functions

    MopSupplyObject()

    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.

    SetAllMarginsTo()

    virtual IMPORT_C void SetAllMarginsTo(TInt aValue);

    Description

    Sets all margins.

    Parameters

    TInt aValue

    SetAlignment()

    virtual IMPORT_C void SetAlignment(TGulAlignmentValue aAlign);

    Description

    Sets control alignment.

    Parameters

    TGulAlignmentValue aAlign

    Margins()

    virtual IMPORT_C TMargins8 &Margins();

    Description

    Return value

    TMargins8 &

    Alignment()

    virtual IMPORT_C TGulAlignment &Alignment();

    Description

    Return value

    TGulAlignment &

    OfferKeyEventL()

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

    Description

    Handles key events. From CEikAlignedControl .

    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.

    See also:

    MakeVisible()

    virtual IMPORT_C void MakeVisible(TBool aVisible);

    Description

    Sets this control as visible or invisible. From CEikAlignedControl .

    Parameters

    TBool aVisible

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

    See also:

    SetDimmed()

    virtual IMPORT_C void SetDimmed(TBool aDimmed);

    Description

    Sets the control to be dimmed. From CEikAlignedControl .

    Parameters

    TBool aDimmed

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

    See also:

    SetContainerWindowL()

    virtual IMPORT_C void SetContainerWindowL(const CCoeControl &aContainer);

    Description

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

    Parameters

    const CCoeControl &aContainer

    The compound control that is the container for this control

    See also:

    ConstructFromResourceL()

    virtual IMPORT_C void ConstructFromResourceL(TResourceReader &aReader);

    Description

    Constructs the control from a resource file. From CEikAlignedControl .

    Parameters

    TResourceReader &aReader

    The resource reader to use.

    See also:

    ActivateL()

    virtual IMPORT_C void ActivateL();

    Description

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

    See also:

    PrepareForFocusLossL()

    virtual IMPORT_C void PrepareForFocusLossL();

    Description

    Prepares the control for loss of focus. From CEikAlignedControl .

    See also:

    PrepareForFocusGainL()

    virtual IMPORT_C void PrepareForFocusGainL();

    Description

    Prepares the control for gaining focus. From CEikAlignedControl .

    See also:

    SetAdjacent()

    virtual IMPORT_C void SetAdjacent(TInt aAdjacent);

    Description

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

    Parameters

    TInt aAdjacent

    Typically a value defined in TGulAdjacent.

    See also:

    SetNeighbor()

    virtual IMPORT_C void SetNeighbor(CCoeControl *aNeighbor);

    Description

    Sets an associated control. From CEikAlignedControl .

    Parameters

    CCoeControl *aNeighbor

    A control to be used by this function.

    See also:

    HasBorder()

    virtual IMPORT_C TBool HasBorder() const;

    Description

    Tests if the control has a border. From CEikAlignedControl .

    Return value

    TBool

    ETrue if the control has a border, EFalse if the control does not have a border. The default implementation of this function returns EFalse.

    See also:

    MinimumSize()

    virtual IMPORT_C TSize MinimumSize();

    Description

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

    Return value

    TSize

    The minimum size required by the control.

    See also:

    HandleResourceChange()

    virtual IMPORT_C void HandleResourceChange(TInt aType);

    Description

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

    Parameters

    TInt aType

    The type of resource that has changed.

    See also:

    GetColorUseListL()

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

    Description

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

    Parameters

    CArrayFix< TCoeColorUse > &aColorUseList

    The colour list.

    See also:

    GetHelpContext()

    virtual IMPORT_C void GetHelpContext(TCoeHelpContext &aContext) const;

    Description

    Gets the control's help context. From CEikAlignedControl .

    Parameters

    TCoeHelpContext &aContext

    The control's help context

    See also:

    InputCapabilities()

    virtual IMPORT_C TCoeInputCapabilities InputCapabilities() const;

    Description

    Gets the control's input capabilities. From CEikAlignedControl .

    Return value

    TCoeInputCapabilities

    The control's input capabilities.

    See also:

    SetParent()

    virtual IMPORT_C TInt SetParent(CCoeControl *aParent);

    Description

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

    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.

    See also:

    SetLayoutManagerL()

    virtual IMPORT_C void SetLayoutManagerL(MCoeLayoutManager *aLayout);

    Description

    Sets the layout manager From CEikAlignedControl .

    Parameters

    MCoeLayoutManager *aLayout

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

    See also:

    RequestRelayout()

    virtual IMPORT_C TBool RequestRelayout(const CCoeControl *aChildControl);

    Description

    Requests a relayout. From CEikAlignedControl .

    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

    See also:

    TextBaselineOffset()

    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 CEikAlignedControl .

    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.

    See also:

    SetTextBaselineSpacing()

    virtual IMPORT_C void SetTextBaselineSpacing(TInt aSpacing);

    Description

    Sets the spacing between text baselines. From CEikAlignedControl .

    Parameters

    TInt aSpacing

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

    See also:

    HandlePointerEventL()

    virtual IMPORT_C void HandlePointerEventL(const TPointerEvent &aPointerEvent);

    Description

    Handles pointer events. From CEikAlignedControl .

    Parameters

    const TPointerEvent &aPointerEvent

    The pointer event.

    See also:

    CountComponentControls()

    virtual IMPORT_C TInt CountComponentControls() const;

    Description

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

    Return value

    TInt

    The number of component controls contained by this control.

    See also:

    ComponentControl()

    virtual IMPORT_C CCoeControl *ComponentControl(TInt aIndex) const;

    Description

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

    Parameters

    TInt aIndex

    The index of the control.

    Return value

    CCoeControl *

    The component control with an index of aIndex.

    See also:

    WriteInternalStateL()

    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

    HandlePointerBufferReadyL()

    protected: virtual IMPORT_C void HandlePointerBufferReadyL();

    Description

    Handles pointer buffer ready events. From CEikAlignedControl .

    See also:

    FocusChanged()

    protected: virtual IMPORT_C void FocusChanged(TDrawNow aDrawNow);

    Description

    Responds to a change in focus. From CEikAlignedControl .

    Parameters

    TDrawNow aDrawNow

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

    See also:

    SizeChanged()

    protected: virtual IMPORT_C void SizeChanged();

    Description

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

    See also:

    PositionChanged()

    protected: virtual IMPORT_C void PositionChanged();

    Description

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

    See also:

    HandleControlArrayEventL()

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

    Description

    Handles events generated by the CCoeControlArray. From CEikAlignedControl .

    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

    See also:

    [Previous] [Top] [Next]

    Terms and conditions of use of the material