CAknFepCtrlCommonButton Class Reference

class CAknFepCtrlCommonButton : public CButtonBase

Basic functionality for graphic buttons It provides creation from resource and can react according to SizeChanged Msg

fepcommonctrls.lib
Since
S60 v3.2

Inherits from

Public Member Functions
~CAknFepCtrlCommonButton()
EXPORT_C voidCancelPointerDownL()
IMPORT_C voidConstructFromResourceL(TResourceReader &)
IMPORT_C voidConstructFromResourceL()
IMPORT_C voidDraw()
CFbsBitmap *ForgroundBmp()
CFbsBitmap *ForgroundBmpMask()
const TRect &ForgroundBmpRect()
IMPORT_C CAknFepCtrlCommonButton *NewL(CFepUiLayout *, TInt, TAknsItemID, TAknsItemID, TAknsItemID)
IMPORT_C CAknFepCtrlCommonButton *NewLC(CFepUiLayout *, TInt, TAknsItemID, TAknsItemID, TAknsItemID)
voidSet3PiecesColorIcons(CPenInput3PiecesColorIcons *)
IMPORT_C voidSetActive(TBool)
IMPORT_C voidSetDraw3PieceFrameInfo(TDraw3PiecesFrame)
IMPORT_C voidSetForegroundBmpL(CFbsBitmap *, CFbsBitmap *)
IMPORT_C voidSetForgroundBmpRect(const TRect &)
IMPORT_C voidSetHighlight(TBool)
voidSetImageFrameId(TAknsItemID, TAknsItemID, TAknsItemID)
voidSetTextColorIndex(TInt)
voidSetTextFormat(TAknTextLineLayout)
voidSetTextL(const TDesC &)
IMPORT_C voidSizeChanged(TRect, TRect, TBool)
TInt TextColorIndex()
Protected Member Functions
CAknFepCtrlCommonButton(CFepUiLayout *, TInt, TAknsItemID, TAknsItemID, TAknsItemID)
voidCreateDimmedMaskL(CFbsBitmap *&, const CFbsBitmap *)
voidDeleteForgroundRes()
IMPORT_C CFepUiBaseCtrl *HandlePointerDownEventL(const TPoint &)
IMPORT_C voidHandlePointerEnter(const TPoint &)
IMPORT_C voidHandlePointerLeave(const TPoint &)
IMPORT_C CFepUiBaseCtrl *HandlePointerUpEventL(const TPoint &)
IMPORT_C voidMove(const TPoint &)
voidResizeBitmaps(TSize)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
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()
CButtonBase::BaseConstructL()
CButtonBase::Bitmap(TButtonBmpType,TBool)
CButtonBase::BmpStretchable()
CButtonBase::CButtonBase(const TRect &,CFepUiLayout *,TInt)
CButtonBase::HandlePointerMoveEventL(const TPoint &)
CButtonBase::Hide(TBool)
CButtonBase::IsDimmed()
CButtonBase::NewL(const TRect &,CFepUiLayout *,TInt)
CButtonBase::ResetBmpPool()
CButtonBase::SetBackgroundBitmapL(CFbsBitmap *)
CButtonBase::SetBackgroundMaskBitmapL(CFbsBitmap *)
CButtonBase::SetBitmapL(CFbsBitmap *,TButtonBmpType)
CButtonBase::SetBmpStretchable(TBool)
CButtonBase::SetCaptionColor(const TRgb &)
CButtonBase::SetCaptionL(const TDesC &)
CButtonBase::SetCaptionShadowColor(const TRgb &)
CButtonBase::SetDimmed(TBool)
CButtonBase::SetFont(const CFont *)
CButtonBase::SetFont(const TFontSpec &)
CButtonBase::SetMaskBitmapL(CFbsBitmap *,TButtonBmpType)
CButtonBase::~CButtonBase()
CFepUiBaseCtrl::AbleToDraw()
CFepUiBaseCtrl::AbsOrderPos()
CFepUiBaseCtrl::ActiveExtResponseArea()
CFepUiBaseCtrl::AddEventObserver(MEventObserver *)
CFepUiBaseCtrl::AllowOverlap()
CFepUiBaseCtrl::BackgroundBmp()
CFepUiBaseCtrl::BaseConstructL(CFepUiLayoutRootCtrl *)
CFepUiBaseCtrl::BitGc()
CFepUiBaseCtrl::BitmapDevice()
CFepUiBaseCtrl::BkColor()
CFepUiBaseCtrl::BkMaskBmp()
CFepUiBaseCtrl::BorderColor()
CFepUiBaseCtrl::BorderSize()
CFepUiBaseCtrl::BringToBack()
CFepUiBaseCtrl::BringToTop()
CFepUiBaseCtrl::CFepUiBaseCtrl(CCoeControl *,CFepUiLayout *,TBool)
CFepUiBaseCtrl::CFepUiBaseCtrl(const TRect &,CFepUiLayout *,TInt)
CFepUiBaseCtrl::CancelExtResponseArea()
CFepUiBaseCtrl::CapturePointer(TBool)
CFepUiBaseCtrl::Clear()
CFepUiBaseCtrl::ClearRect(const TRect &)
CFepUiBaseCtrl::CompareOrder(CFepUiBaseCtrl *)
CFepUiBaseCtrl::CompareOrderInSameGroup(CFepUiBaseCtrl *)
CFepUiBaseCtrl::Contains(const TPoint &)
CFepUiBaseCtrl::ControlId()
CFepUiBaseCtrl::ControlType()
CFepUiBaseCtrl::CreateOwnDeviceL(CFbsBitmap *,CFbsBitmap *)
CFepUiBaseCtrl::DisableRegionUpdating()
CFepUiBaseCtrl::DrawBackground(TBool)
CFepUiBaseCtrl::DrawBackground(const TRect,TBool)
CFepUiBaseCtrl::DrawBackgroundToDevice(TRect,CFbsDevice *,CFbsBitmap *,const TRgb &,const TRgb &,TBool)
CFepUiBaseCtrl::DrawBitmap(const CFbsBitmap *,TBool)
CFepUiBaseCtrl::DrawBitmap(const TRect,const CFbsBitmap *,TBool)
CFepUiBaseCtrl::DrawMaskBackground(TBool)
CFepUiBaseCtrl::DrawOpaqueMaskBackground(TBool)
CFepUiBaseCtrl::DrawOpaqueMaskBackground(const TRect,TBool)
CFepUiBaseCtrl::DrawShadow()
CFepUiBaseCtrl::DrawTransparentMaskBackground(const TRect &,TBool)
CFepUiBaseCtrl::EnableExtResponseArea(TBool,const TRect &)
CFepUiBaseCtrl::EnableRegionUpdating()
CFepUiBaseCtrl::Extension_(TUint,TAny *&,TAny *)
CFepUiBaseCtrl::GraphicDeviceSizeChanged()
CFepUiBaseCtrl::HandlePositionChange(const TPoint &)
CFepUiBaseCtrl::HandleResourceChange(TInt)
CFepUiBaseCtrl::Hiden()
CFepUiBaseCtrl::IsActive()
CFepUiBaseCtrl::IsFepBaseControl()
CFepUiBaseCtrl::IsKindOfControl(TStockBaseCtrlType)
CFepUiBaseCtrl::IsOnTopOf(CFepUiBaseCtrl *)
CFepUiBaseCtrl::MaskBitmapDevice()
CFepUiBaseCtrl::MaskBkCol()
CFepUiBaseCtrl::MovingArea()
CFepUiBaseCtrl::NONSHARABLE_CLASS(CFepUiBaseCtrlExtension)
CFepUiBaseCtrl::OnActivate()
CFepUiBaseCtrl::OnDeActivate()
CFepUiBaseCtrl::OnLayoutDraggingEnd()
CFepUiBaseCtrl::OnLayoutDraggingStart()
CFepUiBaseCtrl::OrderPos()const
CFepUiBaseCtrl::Overlapped(CFepUiBaseCtrl *)
CFepUiBaseCtrl::ParentCtrl()
CFepUiBaseCtrl::PenColor()
CFepUiBaseCtrl::PenSize()
CFepUiBaseCtrl::PointerDown()
CFepUiBaseCtrl::ReDrawRect(const TRect &)
CFepUiBaseCtrl::Ready()
CFepUiBaseCtrl::Rect()
CFepUiBaseCtrl::Region()
CFepUiBaseCtrl::RemoveEventObserver(MEventObserver *)
CFepUiBaseCtrl::ReportEvent(TInt,const TDesC &)
CFepUiBaseCtrl::RequireRegionUpdateL(TBool)
CFepUiBaseCtrl::ResizeDeviceL()
CFepUiBaseCtrl::ResourceId()
CFepUiBaseCtrl::RootControl()
CFepUiBaseCtrl::SetAllowOverlap(TBool)
CFepUiBaseCtrl::SetBackgroundBmp(CFbsBitmap *)
CFepUiBaseCtrl::SetBackgroundMaskBmp(CFbsBitmap *)
CFepUiBaseCtrl::SetBkColor(const TRgb &)
CFepUiBaseCtrl::SetBorderColor(const TRgb &)
CFepUiBaseCtrl::SetBorderSize(const TSize &)
CFepUiBaseCtrl::SetControlType(TControlType)
CFepUiBaseCtrl::SetHidenFlag(TBool)
CFepUiBaseCtrl::SetMaskBkCol(const TRgb &)
CFepUiBaseCtrl::SetOrdinalPos(TInt)
CFepUiBaseCtrl::SetParent(CFepUiBaseCtrl *)
CFepUiBaseCtrl::SetPenColor(const TRgb &)
CFepUiBaseCtrl::SetPenSize(const TSize &)
CFepUiBaseCtrl::SetPointerDown(TBool)
CFepUiBaseCtrl::SetReady(TBool)
CFepUiBaseCtrl::SetRect(const TRect &)
CFepUiBaseCtrl::SetRegion(const RRegion &)
CFepUiBaseCtrl::SetResourceId(TInt32)
CFepUiBaseCtrl::SetShadowAreaRect(const TRect &,TShadowBitmapIndex)
CFepUiBaseCtrl::SetShadowBmp(CFbsBitmap *,CFbsBitmap *,TShadowBitmapIndex)
CFepUiBaseCtrl::SetShadowRect(const TRect &)
CFepUiBaseCtrl::SetTactileFeedbackType(TInt)
CFepUiBaseCtrl::ShadowAreaRect(TShadowBitmapIndex)
CFepUiBaseCtrl::ShadowRect()
CFepUiBaseCtrl::SimulateRawEvent(const TRawEvent &)
CFepUiBaseCtrl::TactileFeedbackType()const
CFepUiBaseCtrl::UiLayout()
CFepUiBaseCtrl::UpdateArea(const TRect &,TBool)
CFepUiBaseCtrl::UpdateAreaImmed(const TRect &,TBool)
CFepUiBaseCtrl::UpdateValidRegion(CFepUiBaseCtrl *,TBool)
CFepUiBaseCtrl::ValidClipRegion()
CFepUiBaseCtrl::WholeHiden()
CFepUiBaseCtrl::WndBasedControl()
CFepUiBaseCtrl::WndControl()
CFepUiBaseCtrl::~CFepUiBaseCtrl()
Inherited Enumerations
CFepUiBaseCtrl:TZOrder
Protected Attributes
TBool iFirstTimeConstruct
TBool iHighlight
TBool iPressed
Private Attributes
CPenInput3PiecesColorIcons *iColorIcons
TDraw3PiecesFrame iDraw3PiecesInfo
CFbsBitmap *iForgroundBmp
CFbsBitmap *iForgroundBmpMask
TRect iForgroundBmpRect
CFbsBitmap *iForgroundDimBmpMask
TAknsItemID iInactiveImgID
TAknsItemID iNormalImgID
TAknsItemID iPressedImgID
HBufC *iText
TInt iTextColorIndex
TAknTextLineLayout iTextFormat
Inherited Attributes
CButtonBase::iActiveBmp
CButtonBase::iActiveBmpPressed
CButtonBase::iActiveMaskBmp
CButtonBase::iActiveMaskBmpPressed
CButtonBase::iNonActiveBkBmp
CButtonBase::iNonActiveBkBmpPressed
CButtonBase::iNonActiveBkMaskBmp
CButtonBase::iNonActiveBkMaskBmpPressed
CFepUiBaseCtrl::iBorderColor
CFepUiBaseCtrl::iBorderSize
CFepUiBaseCtrl::iClipRegion
CFepUiBaseCtrl::iParentCtrl
CFepUiBaseCtrl::iPointerLeft
CFepUiBaseCtrl::iRect
CFepUiBaseCtrl::iResourceId
CFepUiBaseCtrl::iShadowAreaRect
CFepUiBaseCtrl::iShadowRect
CFepUiBaseCtrl::iUpdateFlagEnabled
CFepUiBaseCtrl::iValidRegion
CFepUiBaseCtrl::iWndControl

Constructor & Destructor Documentation

CAknFepCtrlCommonButton(CFepUiLayout *, TInt, TAknsItemID, TAknsItemID, TAknsItemID)

IMPORT_CCAknFepCtrlCommonButton(CFepUiLayout *aUiLayout,
TIntaControlId,
TAknsItemIDaNormalID,
TAknsItemIDaPressedID,
TAknsItemIDaInactiveID
)[protected]

C++ default constructor.

Since
S60 v3.2

Parameters

CFepUiLayout * aUiLayoutAn instance of CFepUiLayout
TInt aControlIdThe control id of input range button
TAknsItemID aNormalID
TAknsItemID aPressedID
TAknsItemID aInactiveID

~CAknFepCtrlCommonButton()

IMPORT_C~CAknFepCtrlCommonButton()[virtual]

Destructor.

Since
S60 v3.2

Member Functions Documentation

CancelPointerDownL()

EXPORT_C voidCancelPointerDownL()[virtual]

Cancel pointer down state

Since
S60 v3.2

ConstructFromResourceL(TResourceReader &)

IMPORT_C voidConstructFromResourceL(TResourceReader &aReader)

This function creates the input range button from resource.

Since
S60 v3.2

Parameters

TResourceReader & aReaderA Reader which is created against the AKN_FEP_BUTTON resource type

ConstructFromResourceL()

IMPORT_C voidConstructFromResourceL()

This function creates the input range button from resource, before calling this function, caller should set resource id of range button first

Since
S60 v3.2

CreateDimmedMaskL(CFbsBitmap *&, const CFbsBitmap *)

voidCreateDimmedMaskL(CFbsBitmap *&aDimmedMask,
const CFbsBitmap *aMask
)[protected]

Parameters

CFbsBitmap *& aDimmedMask
const CFbsBitmap * aMask

DeleteForgroundRes()

voidDeleteForgroundRes()[protected]

Draw()

IMPORT_C voidDraw()[virtual]

Draws UI

Since
S60 v3.2

ForgroundBmp()

CFbsBitmap *ForgroundBmp()[inline]

ForgroundBmpMask()

CFbsBitmap *ForgroundBmpMask()[inline]

ForgroundBmpRect()

const TRect &ForgroundBmpRect()const [inline]

HandlePointerDownEventL(const TPoint &)

IMPORT_C CFepUiBaseCtrl *HandlePointerDownEventL(const TPoint &aPoint)[protected, virtual]

From CFepUiBaseCtrl Handle pointer down event

Since
S60 V4.0

Parameters

const TPoint & aPointThe point position relative the layout

HandlePointerEnter(const TPoint &)

IMPORT_C voidHandlePointerEnter(const TPoint &aPoint)[protected, virtual]

From CFepUiBaseCtrl Handle pointer enter event. This will be called only when it's got pointer down event before and pointer leaves but now comes back without pointer up event.

Since
S60 V4.0

Parameters

const TPoint & aPointcurrent pointer position

HandlePointerLeave(const TPoint &)

IMPORT_C voidHandlePointerLeave(const TPoint &aPt)[protected, virtual]

From CFepUiBaseCtrl Handle pointer up event

Since
S60 V4.0

Parameters

const TPoint & aPt

HandlePointerUpEventL(const TPoint &)

IMPORT_C CFepUiBaseCtrl *HandlePointerUpEventL(const TPoint &aPoint)[protected, virtual]

From CFepUiBaseCtrl Handle pointer up event

Since
S60 V4.0

Parameters

const TPoint & aPointThe point position relative the layout

Move(const TPoint &)

IMPORT_C voidMove(const TPoint &aOffset)[protected, virtual]

Move conntrol

Since
S60 V4.0

Parameters

const TPoint & aOffsetThe offset to be moved

NewL(CFepUiLayout *, TInt, TAknsItemID, TAknsItemID, TAknsItemID)

IMPORT_C CAknFepCtrlCommonButton *NewL(CFepUiLayout *aUiLayout,
TIntaControlId,
TAknsItemIDaNormalID,
TAknsItemIDaPressedID,
TAknsItemIDaInactiveID
)[static]

Two-phased constructor.

Since
S60 v3.2

Parameters

CFepUiLayout * aUiLayoutAn instance of CFepUiLayout
TInt aControlIdThe control id of input range button
TAknsItemID aNormalID
TAknsItemID aPressedID
TAknsItemID aInactiveID

NewLC(CFepUiLayout *, TInt, TAknsItemID, TAknsItemID, TAknsItemID)

IMPORT_C CAknFepCtrlCommonButton *NewLC(CFepUiLayout *aUiLayout,
TIntaControlId,
TAknsItemIDaNormalID,
TAknsItemIDaPressedID,
TAknsItemIDaInactiveID
)[static]

Two-phased constructor.

Since
S60 v3.2

Parameters

CFepUiLayout * aUiLayoutAn instance of CFepUiLayout
TInt aControlIdThe control id of input range button
TAknsItemID aNormalID
TAknsItemID aPressedID
TAknsItemID aInactiveID

ResizeBitmaps(TSize)

voidResizeBitmaps(TSizeaInnerSize)[protected]

Parameters

TSize aInnerSize

Set3PiecesColorIcons(CPenInput3PiecesColorIcons *)

voidSet3PiecesColorIcons(CPenInput3PiecesColorIcons *aColorIcons)[inline]

Parameters

CPenInput3PiecesColorIcons * aColorIcons

SetActive(TBool)

IMPORT_C voidSetActive(TBoolaActiveFlag)[virtual]

Set active for this button

Since
S60 v3.2

Parameters

TBool aActiveFlagactive the button or desactive it

SetDraw3PieceFrameInfo(TDraw3PiecesFrame)

IMPORT_C voidSetDraw3PieceFrameInfo(TDraw3PiecesFramea3PiecesFrameInfo)

Parameters

TDraw3PiecesFrame a3PiecesFrameInfo

SetForegroundBmpL(CFbsBitmap *, CFbsBitmap *)

IMPORT_C voidSetForegroundBmpL(CFbsBitmap *aBmp,
CFbsBitmap *aMaskBmp
)

Parameters

CFbsBitmap * aBmp
CFbsBitmap * aMaskBmp

SetForgroundBmpRect(const TRect &)

IMPORT_C voidSetForgroundBmpRect(const TRect &aRect)

Set Forground bitmap position

Since
S60 v3.2

Parameters

const TRect & aRectForground bitmap position

SetHighlight(TBool)

IMPORT_C voidSetHighlight(TBoolaIsHighlight)

Set high light for the button

Since
S60 v3.2

Parameters

TBool aIsHighlighthighlight the button or cancel high light it

SetImageFrameId(TAknsItemID, TAknsItemID, TAknsItemID)

voidSetImageFrameId(TAknsItemIDaNormalID,
TAknsItemIDaPressedID,
TAknsItemIDaInactiveID
)[inline]

Parameters

TAknsItemID aNormalID
TAknsItemID aPressedID
TAknsItemID aInactiveID

SetTextColorIndex(TInt)

voidSetTextColorIndex(TIntaColorGroup)[inline]

Set text color group

Since
S60 V4.0

Parameters

TInt aColorGroupText color group

SetTextFormat(TAknTextLineLayout)

voidSetTextFormat(TAknTextLineLayoutaTextFormat)[inline]

Set text line layout

Since
S60 V4.0

Parameters

TAknTextLineLayout aTextFormatText line layout to be set

SetTextL(const TDesC &)

voidSetTextL(const TDesC &aText)[inline]

Set text to be shown on button

Since
S60 V4.0

Parameters

const TDesC & aTextText to be shown on button

SizeChanged(TRect, TRect, TBool)

IMPORT_C voidSizeChanged(TRectaRect,
TRectaInnerRect,
TBoolaIsReloadImages = EFalse
)

This function handles the SizeChanged event, it resizes all images and rects

Since
S60 v3.2

Parameters

TRect aRectNew button extent
TRect aInnerRectNew button inner
TBool aIsReloadImages = EFalseWhether resize images as well, if only the position of the button changed, no need to reset the images as well

TextColorIndex()

TInt TextColorIndex()const [inline]

Member Data Documentation

CPenInput3PiecesColorIcons * iColorIcons

CPenInput3PiecesColorIcons *iColorIcons[private]

The 3 pieces color icon (owned)

TDraw3PiecesFrame iDraw3PiecesInfo

TDraw3PiecesFrame iDraw3PiecesInfo[private]

TBool iFirstTimeConstruct

TBool iFirstTimeConstruct[protected]

The first time construct flag of button

CFbsBitmap * iForgroundBmp

CFbsBitmap *iForgroundBmp[private]

Froground bitmap and it's mask

CFbsBitmap * iForgroundBmpMask

CFbsBitmap *iForgroundBmpMask[private]

TRect iForgroundBmpRect

TRect iForgroundBmpRect[private]

Froground bitmap's position

CFbsBitmap * iForgroundDimBmpMask

CFbsBitmap *iForgroundDimBmpMask[private]

Froground Dimmed bitmap's mask

TBool iHighlight

TBool iHighlight[protected]

The highlight flag of the button

TAknsItemID iInactiveImgID

TAknsItemID iInactiveImgID[private]

TAknsItemID iNormalImgID

TAknsItemID iNormalImgID[private]

The img ID of button in various states

TBool iPressed

TBool iPressed[protected]

Button pressed status

TAknsItemID iPressedImgID

TAknsItemID iPressedImgID[private]

HBufC * iText

HBufC *iText[private]

TInt iTextColorIndex

TInt iTextColorIndex[private]

Text color index

TAknTextLineLayout iTextFormat

TAknTextLineLayout iTextFormat[private]