CEikBitmapButton Class Reference

Link against: avkon.lib eikcoctl.lib

Capability Information

Required Capabilities

None


#include <
EIKCMBUT.H>

Inherits CEikCommandButtonBase.

Inherited by CAknPopupField::CAknPopupFieldBitmapButton.


Detailed Description

A command button with a single bitmap.

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

Dll eikcoctl.dll
Since:
S60 1.0

Public Member Functions

IMPORT_C CEikBitmapButton ()
 Constructor.
IMPORT_C ~CEikBitmapButton ()
 C++ Destructor.
IMPORT_C void SetPictureL (const CFbsBitmap *aMain, const CFbsBitmap *aMask=NULL, TWhichComponent aWhich=EFirst)
 Sets the bitmap and optional mask for the button.
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.
IMPORT_C CEikImagePicture (TWhichComponent aWhich=EFirst) const
 Access to the image.
IMPORT_C void ConstructFromResourceL (TResourceReader &aReader)
 From CCoeControl.
IMPORT_C void HandlePointerEventL (const TPointerEvent &aPointerEvent)
 From CCoeControl.

Constructor & Destructor Documentation

IMPORT_C CEikBitmapButton::CEikBitmapButton  ) 
 

Constructor.

IMPORT_C CEikBitmapButton::~CEikBitmapButton  ) 
 

C++ Destructor.


Member Function Documentation

IMPORT_C void CEikBitmapButton::ConstructFromResourceL TResourceReader &  aReader  ) 
 

From CCoeControl.

Construct the object from resource

Parameters:
aReader Fully constructed resource reader
IMPORT_C void CEikBitmapButton::HandlePointerEventL const TPointerEvent &  aPointerEvent  ) 
 

From CCoeControl.

Handle a pointer event coming from the CONE framework

Parameters:
aPointerEvent Event to handle

Reimplemented from CEikCommandButtonBase.

IMPORT_C CEikImage* CEikBitmapButton::Picture TWhichComponent  aWhich = EFirst  )  const
 

Access to the image.

Parameters:
aWhich Which picture to access
Returns:
pointer to the image. No ownership is transferred
IMPORT_C void CEikBitmapButton::SetPictureFromFileL const TDesC &  aFilename,
TInt  aMain,
TInt  aMask = -1,
TWhichComponent  aWhich = EFirst
 

Sets the bitmap and optional mask from an mbm file.

Parameters:
aFile Mbm filename
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.
IMPORT_C void CEikBitmapButton::SetPictureL const CFbsBitmap *  aMain,
const CFbsBitmap *  aMask = NULL,
TWhichComponent  aWhich = EFirst
 

Sets the bitmap and optional mask for the button.

Parameters:
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.

The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2007
Back to top