Symbian^3 Application Developer Library >

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 void CancelPointerDownL ()
IMPORT_C void ConstructFromResourceL ( TResourceReader &)
IMPORT_C void ConstructFromResourceL ()
IMPORT_C void Draw ()
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 )
void Set3PiecesColorIcons ( CPenInput3PiecesColorIcons *)
IMPORT_C void SetActive ( TBool )
IMPORT_C void SetDraw3PieceFrameInfo ( TDraw3PiecesFrame )
IMPORT_C void SetForegroundBmpL ( CFbsBitmap *, CFbsBitmap *)
IMPORT_C void SetForgroundBmpRect (const TRect &)
IMPORT_C void SetHighlight ( TBool )
void SetImageFrameId ( TAknsItemID , TAknsItemID , TAknsItemID )
void SetTextColorIndex ( TInt )
void SetTextFormat ( TAknTextLineLayout )
void SetTextL (const TDesC &)
IMPORT_C void SizeChanged ( TRect , TRect , TBool )
TInt TextColorIndex ()
Protected Member Functions
CAknFepCtrlCommonButton ( CFepUiLayout *, TInt , TAknsItemID , TAknsItemID , TAknsItemID )
void CreateDimmedMaskL ( CFbsBitmap *&, const CFbsBitmap *)
void DeleteForgroundRes ()
IMPORT_C CFepUiBaseCtrl * HandlePointerDownEventL (const TPoint &)
IMPORT_C void HandlePointerEnter (const TPoint &)
IMPORT_C void HandlePointerLeave (const TPoint &)
IMPORT_C CFepUiBaseCtrl * HandlePointerUpEventL (const TPoint &)
IMPORT_C void Move (const TPoint &)
void ResizeBitmaps ( 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_C CAknFepCtrlCommonButton ( CFepUiLayout * aUiLayout,
TInt aControlId,
TAknsItemID aNormalID,
TAknsItemID aPressedID,
TAknsItemID aInactiveID
) [protected]

C++ default constructor.

Since
S60 v3.2

Parameters

CFepUiLayout * aUiLayout An instance of CFepUiLayout
TInt aControlId The 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 void CancelPointerDownL ( ) [virtual]

Cancel pointer down state

Since
S60 v3.2

ConstructFromResourceL(TResourceReader &)

IMPORT_C void ConstructFromResourceL ( TResourceReader & aReader )

This function creates the input range button from resource.

Since
S60 v3.2

Parameters

TResourceReader & aReader A Reader which is created against the AKN_FEP_BUTTON resource type

ConstructFromResourceL()

IMPORT_C void ConstructFromResourceL ( )

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 *)

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

Parameters

CFbsBitmap *& aDimmedMask
const CFbsBitmap * aMask

DeleteForgroundRes()

void DeleteForgroundRes ( ) [protected]

Draw()

IMPORT_C void Draw ( ) [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 & aPoint The point position relative the layout

HandlePointerEnter(const TPoint &)

IMPORT_C void HandlePointerEnter ( 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 & aPoint current pointer position

HandlePointerLeave(const TPoint &)

IMPORT_C void HandlePointerLeave ( 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 & aPoint The point position relative the layout

Move(const TPoint &)

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

Move conntrol

Since
S60 V4.0

Parameters

const TPoint & aOffset The offset to be moved

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

IMPORT_C CAknFepCtrlCommonButton * NewL ( CFepUiLayout * aUiLayout,
TInt aControlId,
TAknsItemID aNormalID,
TAknsItemID aPressedID,
TAknsItemID aInactiveID
) [static]

Two-phased constructor.

Since
S60 v3.2

Parameters

CFepUiLayout * aUiLayout An instance of CFepUiLayout
TInt aControlId The control id of input range button
TAknsItemID aNormalID
TAknsItemID aPressedID
TAknsItemID aInactiveID

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

IMPORT_C CAknFepCtrlCommonButton * NewLC ( CFepUiLayout * aUiLayout,
TInt aControlId,
TAknsItemID aNormalID,
TAknsItemID aPressedID,
TAknsItemID aInactiveID
) [static]

Two-phased constructor.

Since
S60 v3.2

Parameters

CFepUiLayout * aUiLayout An instance of CFepUiLayout
TInt aControlId The control id of input range button
TAknsItemID aNormalID
TAknsItemID aPressedID
TAknsItemID aInactiveID

ResizeBitmaps(TSize)

void ResizeBitmaps ( TSize aInnerSize ) [protected]

Parameters

TSize aInnerSize

Set3PiecesColorIcons(CPenInput3PiecesColorIcons *)

void Set3PiecesColorIcons ( CPenInput3PiecesColorIcons * aColorIcons ) [inline]

Parameters

CPenInput3PiecesColorIcons * aColorIcons

SetActive(TBool)

IMPORT_C void SetActive ( TBool aActiveFlag ) [virtual]

Set active for this button

Since
S60 v3.2

Parameters

TBool aActiveFlag active the button or desactive it

SetDraw3PieceFrameInfo(TDraw3PiecesFrame)

IMPORT_C void SetDraw3PieceFrameInfo ( TDraw3PiecesFrame a3PiecesFrameInfo )

Parameters

TDraw3PiecesFrame a3PiecesFrameInfo

SetForegroundBmpL(CFbsBitmap *, CFbsBitmap *)

IMPORT_C void SetForegroundBmpL ( CFbsBitmap * aBmp,
CFbsBitmap * aMaskBmp
)

Parameters

CFbsBitmap * aBmp
CFbsBitmap * aMaskBmp

SetForgroundBmpRect(const TRect &)

IMPORT_C void SetForgroundBmpRect ( const TRect & aRect )

Set Forground bitmap position

Since
S60 v3.2

Parameters

const TRect & aRect Forground bitmap position

SetHighlight(TBool)

IMPORT_C void SetHighlight ( TBool aIsHighlight )

Set high light for the button

Since
S60 v3.2

Parameters

TBool aIsHighlight highlight the button or cancel high light it

SetImageFrameId(TAknsItemID, TAknsItemID, TAknsItemID)

void SetImageFrameId ( TAknsItemID aNormalID,
TAknsItemID aPressedID,
TAknsItemID aInactiveID
) [inline]

Parameters

TAknsItemID aNormalID
TAknsItemID aPressedID
TAknsItemID aInactiveID

SetTextColorIndex(TInt)

void SetTextColorIndex ( TInt aColorGroup ) [inline]

Set text color group

Since
S60 V4.0

Parameters

TInt aColorGroup Text color group

SetTextFormat(TAknTextLineLayout)

void SetTextFormat ( TAknTextLineLayout aTextFormat ) [inline]

Set text line layout

Since
S60 V4.0

Parameters

TAknTextLineLayout aTextFormat Text line layout to be set

SetTextL(const TDesC &)

void SetTextL ( const TDesC & aText ) [inline]

Set text to be shown on button

Since
S60 V4.0

Parameters

const TDesC & aText Text to be shown on button

SizeChanged(TRect, TRect, TBool)

IMPORT_C void SizeChanged ( TRect aRect,
TRect aInnerRect,
TBool aIsReloadImages = EFalse
)

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

Since
S60 v3.2

Parameters

TRect aRect New button extent
TRect aInnerRect New button inner
TBool aIsReloadImages = EFalse Whether 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]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.