CEikBitmapButton Class Reference

#include <mw/eikcmbut.h>

Link against: eikcoctl.dll

class CEikBitmapButton : public CEikCommandButtonBase

Inherits from

CEikBitmapButton
- CEikCommandButtonBase
  - CEikButtonBase
    - CEikBorderedControl
      - CAknControl

Public Member Functions
	CEikBitmapButton()
	~CEikBitmapButton()
virtual IMPORT_C void	ConstructFromResourceL(TResourceReader &)
virtual IMPORT_C void	HandlePointerEventL(const TPointerEvent &)
IMPORT_C CEikImage *	Picture(TWhichComponent)
IMPORT_C void	SetPictureFromFileL(const TDesC &, TInt, TInt, TWhichComponent)
IMPORT_C void	SetPictureL(const CFbsBitmap , const CFbsBitmap , TWhichComponent)

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize
	CEikBorderedControl::iBorder
	CEikButtonBase::iButFlags
	CEikCommandButtonBase::iCmdFlags
	CEikCommandButtonBase::iComponents
	CEikCommandButtonBase::iMargins

Inherited Enumerations
	CCoeControl:TZoomType
	CEikButtonBase:TDrawState
	CEikButtonBase:TState
	CEikCommandButtonBase:TDisplayContent
	CEikCommandButtonBase:TExcess
	CEikCommandButtonBase:TLayout
	CEikCommandButtonBase:TWhichComponent

Inherited Functions
	CAknControl::CAknControl()
	CAknControl::~CAknControl()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CCoeControl::AccumulatedZoom()const
	CCoeControl::ActivateGc()const
	CCoeControl::BackedUpWindow()const
	CCoeControl::Background()const
	CCoeControl::CCoeControl()
	CCoeControl::CCoeControl(CCoeEnv *)
	CCoeControl::CCoeControl(const CCoeControl &)
	CCoeControl::CCoeControlArray
	CCoeControl::CapturesPointer()const
	CCoeControl::ClaimPointerGrab(TBool)
	CCoeControl::ClaimPointerGrab(TInt,TBool)
	CCoeControl::CloseWindow()
	CCoeControl::ComponentArrayExists()const
	CCoeControl::Components()
	CCoeControl::Components()const
	CCoeControl::ControlContext()const
	CCoeControl::ControlEnv()const
	CCoeControl::CopyControlContextFrom(const CCoeControl *)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
	CCoeControl::CreateWindowL()
	CCoeControl::CreateWindowL(RWindowGroup *)
	CCoeControl::CreateWindowL(RWindowTreeNode &)
	CCoeControl::CreateWindowL(const CCoeControl *)
	CCoeControl::CustomGc()const
	CCoeControl::DeactivateGc()const
	CCoeControl::DrawBackground(const TRect &)const
	CCoeControl::DrawDeferred()const
	CCoeControl::DrawForeground(const TRect &)const
	CCoeControl::DrawNow()const
	CCoeControl::DrawNow(const TRect &)const
	CCoeControl::DrawableWindow()const
	CCoeControl::EnableDragEvents()
	CCoeControl::EnableReportControlStateChange(TBool)
	CCoeControl::EnableWindowTransparency()
	CCoeControl::FindBackground()const
	CCoeControl::FindFontProvider()const
	CCoeControl::GetColor(TInt,TRgb &)const
	CCoeControl::GetGc()const
	CCoeControl::GetHelpContext(TCoeHelpContext &)const
	CCoeControl::GrabbingComponent()const
	CCoeControl::GrabbingComponent(TInt)const
	CCoeControl::HandleComponentControlsResourceChange(TInt)
	CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray ,CCoeControl ,TInt)
	CCoeControl::HandlePointerBufferReadyL()
	CCoeControl::HandleRedrawEvent(const TRect &)const
	CCoeControl::HitTest()const
	CCoeControl::IgnoreEventsUntilNextPointerUp()
	CCoeControl::Index(const CCoeControl *)const
	CCoeControl::InitComponentArrayL()
	CCoeControl::IsActivated()const
	CCoeControl::IsBackedUp()const
	CCoeControl::IsBeingDestroyed()const
	CCoeControl::IsBlank()const
	CCoeControl::IsDimmed()const
	CCoeControl::IsFocused()const
	CCoeControl::IsNonFocusing()const
	CCoeControl::IsReadyToDraw()const
	CCoeControl::IsVisible()const
	CCoeControl::LayoutManager()const
	CCoeControl::MakeVisible(TBool)
	CCoeControl::MaximumWidth()const
	CCoeControl::MopSupplyObject(TTypeUid)
	CCoeControl::NotifyFontChange(const CCoeFontProvider *)
	CCoeControl::Observer()const
	CCoeControl::OverrideColorL(TInt,TRgb)
	CCoeControl::OwnsWindow()const
	CCoeControl::Parent()
	CCoeControl::Parent()const
	CCoeControl::Position()const
	CCoeControl::PositionChanged()
	CCoeControl::PositionRelativeToScreen()const
	CCoeControl::PrepareForFocusGainL()
	CCoeControl::PrepareForFocusLossL()
	CCoeControl::ProcessPointerBufferReadyL()
	CCoeControl::ProcessPointerEventL(const TPointerEvent &)
	CCoeControl::Rect()const
	CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
	CCoeControl::RecursivelyMergedInputCapabilities()const
	CCoeControl::RefetchPixelMappingL()
	CCoeControl::RemoveFromParent()
	CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
	CCoeControl::RequestRelayout(const CCoeControl *)
	CCoeControl::ResetGc()const
	CCoeControl::ScreenFont(const TCoeFont &)const
	CCoeControl::SetAllowStrayPointers()
	CCoeControl::SetBackground(const MCoeControlBackground *)
	CCoeControl::SetBlank()
	CCoeControl::SetCanDrawOutsideRect()
	CCoeControl::SetComponentsToInheritVisibility(TBool)
	CCoeControl::SetContainerWindowL(RBackedUpWindow &)
	CCoeControl::SetContainerWindowL(RWindow &)
	CCoeControl::SetControlContext(MCoeControlContext *)
	CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
	CCoeControl::SetCustomGc(CWindowGc *)
	CCoeControl::SetExtent(const TPoint &,const TSize &)
	CCoeControl::SetExtentToWholeScreen()
	CCoeControl::SetFocus(TBool,TDrawNow)
	CCoeControl::SetFocusing(TBool)
	CCoeControl::SetFontProviderL(const CCoeFontProvider &)
	CCoeControl::SetGc(CWindowGc *)const
	CCoeControl::SetGloballyCapturing(TBool)
	CCoeControl::SetHitTest(const MCoeControlHitTest *)
	CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
	CCoeControl::SetMaximumWidth(TInt)
	CCoeControl::SetMopParent(MObjectProvider *)
	CCoeControl::SetNeighbor(CCoeControl *)
	CCoeControl::SetNonFocusing()
	CCoeControl::SetObserver(MCoeControlObserver *)
	CCoeControl::SetParent(CCoeControl *)
	CCoeControl::SetPointerCapture(TBool)
	CCoeControl::SetPosition(const TPoint &)
	CCoeControl::SetRect(const TRect &)
	CCoeControl::SetSize(const TSize &)
	CCoeControl::SetSizeWithoutNotification(const TSize &)
	CCoeControl::SetTextBaselineSpacing(TInt)
	CCoeControl::SetUniqueHandle(TInt)
	CCoeControl::SetZoomFactorL(TInt,TZoomType)
	CCoeControl::Size()const
	CCoeControl::SystemGc()const
	CCoeControl::TextBaselineOffset(const TSize &)const
	CCoeControl::TextDrawer(TInt)const
	CCoeControl::UniqueHandle()const
	CCoeControl::Window()const
	CCoeControl::WriteInternalStateNowL(RWriteStream &)const
	CCoeControl::ZoomWithType()const
	CCoeControl::operator=(const CCoeControl &)
	CCoeControl::~CCoeControl()
	CEikBorderedControl::Border()const
	CEikBorderedControl::CEikBorderedControl()
	CEikBorderedControl::CEikBorderedControl(const TGulBorder &)
	CEikBorderedControl::HasBorder()const
	CEikBorderedControl::SetAdjacent(TInt)
	CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
	CEikBorderedControl::SetBorder(TInt)
	CEikButtonBase::Animate()
	CEikButtonBase::CEikButtonBase()
	CEikButtonBase::CopyDrawStateTo(CEikButtonBase *)const
	CEikButtonBase::DrawState()const
	CEikButtonBase::InputCapabilities()const
	CEikButtonBase::IsPressed()const
	CEikButtonBase::SetAllowTristate()
	CEikButtonBase::SetBehavior(TButtonBehavior)
	CEikButtonBase::SetCoordinator(TEikButtonCoordinator *)
	CEikButtonBase::SetIgnoreNextPointerUp()
	CEikButtonBase::SetReportOnPointerDown()
	CEikButtonBase::SetState(TState)
	CEikButtonBase::State()const
	CEikButtonBase::~CEikButtonBase()
	CEikCommandButtonBase::ActivateL()
	CEikCommandButtonBase::Behavior()const
	CEikCommandButtonBase::ButFlags()const
	CEikCommandButtonBase::CEikCommandButtonBase()
	CEikCommandButtonBase::CheckCreateCommandStackL()
	CEikCommandButtonBase::CommandStack()const
	CEikCommandButtonBase::ComponentControl(TInt)const
	CEikCommandButtonBase::ConstructImageFromResourceL(TResourceReader &,TWhichComponent)
	CEikCommandButtonBase::ConstructLabelFromResourceL(TResourceReader &,TWhichComponent)
	CEikCommandButtonBase::CountComponentControls()const
	CEikCommandButtonBase::Draw(const TRect &)const
	CEikCommandButtonBase::FocusChanged(TDrawNow)
	CEikCommandButtonBase::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
	CEikCommandButtonBase::HandleResourceChange(TInt)
	CEikCommandButtonBase::IsDefault()const
	CEikCommandButtonBase::LayoutComponents()
	CEikCommandButtonBase::MinimumSize()
	CEikCommandButtonBase::OfferKeyEventL(const TKeyEvent &,TEventCode)
	CEikCommandButtonBase::SetButtonLayout(TLayout)
	CEikCommandButtonBase::SetContainerWindowL(const CCoeControl &)
	CEikCommandButtonBase::SetDefault(TBool)
	CEikCommandButtonBase::SetDimmed(TBool)
	CEikCommandButtonBase::SetDisplayContent(TDisplayContent)
	CEikCommandButtonBase::SetExcessSpace(TExcess)
	CEikCommandButtonBase::SetImageAttributes(CEikImage *)
	CEikCommandButtonBase::SetPictureFromFileL(const TDesC &,TInt,TInt,CEikAlignedControl *&)
	CEikCommandButtonBase::SetPictureL(const CFbsBitmap ,const CFbsBitmap ,CEikAlignedControl *&)
	CEikCommandButtonBase::SetTextL(const TDesC &,CEikAlignedControl *&)
	CEikCommandButtonBase::StartConstructFromResourceL(TResourceReader &)
	CEikCommandButtonBase::StateChanged()
	CEikCommandButtonBase::UpdateComponentAlignment()
	CEikCommandButtonBase::WriteInternalStateL(RWriteStream &)const
	CEikCommandButtonBase::~CEikCommandButtonBase()

Detailed Description

A command button with a single bitmap

This specialization of CEikCommandButtonBase supports a single bitmap, optionally with a mask.

Since: S60 1.0

Constructor & Destructor Documentation

CEikBitmapButton ( )

IMPORT_C

CEikBitmapButton

(

)

Constructor

~CEikBitmapButton ( )

IMPORT_C

~CEikBitmapButton

(

)

C++ Destructor

Member Function Documentation

ConstructFromResourceL ( TResourceReader & )

IMPORT_C void

ConstructFromResourceL

(

TResourceReader &

aReader

)

[virtual]

Reimplemented from CCoeControl::ConstructFromResourceL(TResourceReader &)

From CCoeControl

Construct the object from resource

Parameter	Description
aReader	Fully constructed resource reader

HandlePointerEventL ( const TPointerEvent & )

IMPORT_C void

HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

[virtual]

Reimplemented from CEikCommandButtonBase::HandlePointerEventL(const TPointerEvent &)

From CCoeControl

Handle a pointer event coming from the CONE framework

Parameter	Description
aPointerEvent	Event to handle

Picture ( TWhichComponent )

IMPORT_C CEikImage *

Picture

(

TWhichComponent

aWhich = EFirst

)

const

Access to the image

Parameter	Description
aWhich	Which picture to access

Returns: pointer to the image. No ownership is transferred

SetPictureFromFileL ( const TDesC &, TInt, TInt, TWhichComponent )

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

Sets the bitmap and optional mask from an mbm file.

Parameter	Description
aMain	Index of the bitmap to use
aMask	Index of the mask. If -1, then a null mask will be used
aWhich	The component for which the picture is to be set.

SetPictureL ( const CFbsBitmap , const CFbsBitmap , TWhichComponent )

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

Sets the bitmap and optional mask for the button

Parameter	Description
aMain	The bitmap to use
aMask	The mask. If null, then no mask will be used
aWhich	The component for which the picture is to be set.