UIQ Technology
Symbian OS Library

UIQ 3.1 SDK        UIQ developer portal

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



Location: EIKCMBUT.H
Link against: eikcoctl.lib

Class CEikBitmapButton

class CEikBitmapButton : public CEikCommandButtonBase;

Description

This class provides member functions to enable you to create a command button with a bitmap image.

A bitmap button has no text associated with it: it displays a picture only.

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 CEikBitmapButton:
    CEikBitmapButton(), ConstructFromResourceL(), Picture(), SetPictureFromFileL(), SetPictureL(), WriteInternalStateL(), ~CEikBitmapButton()

    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(), 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 CEikBorderedControl:
    iBorder

    Inherited from CEikButtonBase:
    Animate(), CEikButtonBase_Reserved_1(), CEikButtonBase_Reserved_2(), CEikButtonBase_Reserved_3(), CopyDrawStateTo(), DrawState(), EClear, EDrawClear, EDrawClearPressed, EDrawIndeterminate, EDrawIndeterminatePressed, EDrawSet, EDrawSetPressed, EIndeterminate, ESet, GetTextDrawer(), IsPressed(), SetAllowTristate(), SetBehavior(), SetBubbleHelpTextL(), SetCoordinator(), SetIgnoreNextPointerUp(), SetReportOnPointerDown(), SetState(), State(), TDrawState, TState, iButFlags

    Inherited from CEikCommandButtonBase:
    ActivateL(), Behavior(), Border(), CEikCommandButtonBase_Reserved_1(), CheckCreateCommandStackL(), ComponentControl(), ConstructImageFromResourceL(), ConstructLabelFromResourceL(), CountComponentControls(), Draw(), EBoth, EDenseFont, EFirst, EFirstBottomSecondTop, EFirstLeftSecondRight, EFirstOnly, EFirstRightSecondLeft, EFirstTopSecondBottom, ESecond, ESecondOnly, EShare, EToFirst, EToSecond, FocusChanged(), GetColorUseListL(), GetHelpContext(), HandleCommandL(), HandleControlArrayEventL(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleResourceChange(), HasBorder(), InputCapabilities(), IsDefault(), LayoutComponents(), MakeVisible(), MapCommandHandler(), MinimumSize(), MopSupplyObject(), OfferKeyEventL(), PositionChanged(), PrepareForFocusGainL(), PrepareForFocusLossL(), RequestRelayout(), SetAdjacent(), SetBorder(), SetButtonLayout(), SetContainerWindowL(), SetContentL(), SetDefault(), SetDimmed(), SetDisplayContent(), SetDisplayPictureOnly(), SetExcessSpace(), SetLayoutManagerL(), SetNeighbor(), SetParent(), SetTextBaselineSpacing(), SetTextL(), SizeChanged(), StartConstructFromResourceL(), StateChanged(), TDisplayContent, TExcess, TLayout, TWhichComponent, TextBaselineOffset(), UpdateComponentAlignment(), iCmdFlags, iComponents, iMargins

    Inherited from MEikBorderedControl:
    ETypeId, anonymous

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

    Inherited from MQikCommandHandler:
    HandleAttemptDimmedSelectionL()


    Construction and destruction


    CEikBitmapButton()

    IMPORT_C CEikBitmapButton();

    Description

    Default constructor.


    ~CEikBitmapButton()

    IMPORT_C ~CEikBitmapButton();

    Description

    Destructor.

    [Top]


    Member functions


    SetPictureL()

    IMPORT_C void SetPictureL(const CFbsBitmap *aMain, const CFbsBitmap *aMask=0,TWhichComponent aWhich=EFirst);

    Description

    Sets the image to be displayed in the button, and an optional bitmap mask for the image.

    Parameters

    const CFbsBitmap *aMain

    const CFbsBitmap *aMask

    TWhichComponent aWhich


    SetPictureFromFileL()

    IMPORT_C void SetPictureFromFileL(const TDesC &aFilename, TInt aMain, TInt aMask=-1, TWhichComponent aWhich=EFirst);

    Description

    Set the buttons image to a bitmap stored in a file.

    A bitmap mask may optionally be set using aMask . If the image cannot be read from the file, the button is not updated.

    Parameters

    const TDesC &aFilename

    TInt aMain

    TInt aMask

    TWhichComponent aWhich


    Picture()

    IMPORT_C CEikImage *Picture(TWhichComponent aWhich=EFirst) const;

    Description

    Gets the image associated with the specified component.

    Parameters

    TWhichComponent aWhich

    Return value

    CEikImage *

    "CEikImage*" The image associated with the specified component.


    ConstructFromResourceL()

    virtual IMPORT_C void ConstructFromResourceL(TResourceReader &aReader);

    Description

    Constructs a bitmap button from resource.

    Parameters

    TResourceReader &aReader


    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