Symbian^3 Application Developer Library >

CAknFepCtrlDragButton Class Reference

class CAknFepCtrlDragButton : public CDragBar

Basic functionality for drag button It provides creation from resource and can react according to SizeChanged Msg

fepcommonctrls.lib
Since
S60 v3.2

Inherits from

Public Member Functions
~CAknFepCtrlDragButton ()
IMPORT_C void ConstructFromResourceL ( TResourceReader &)
IMPORT_C void ConstructFromResourceL ()
IMPORT_C void Draw ()
IMPORT_C CFepUiBaseCtrl * HandlePointerDownEventL (const TPoint &)
IMPORT_C void Move (const TPoint &)
IMPORT_C CAknFepCtrlDragButton * NewL ( CFepUiLayout *, TInt )
IMPORT_C CAknFepCtrlDragButton * NewLC ( CFepUiLayout *, TInt )
IMPORT_C void SetForegroundBmpL ( CFbsBitmap *, CFbsBitmap *)
IMPORT_C void SetForgroundBmpRect (const TRect &)
void SetImageFrameId ( TAknsItemID , TAknsItemID , TAknsItemID )
void SetTextFormat ( TAknTextLineLayout )
void SetTextL (const TDesC &)
IMPORT_C void SizeChanged ( TRect , TRect , TBool )
Protected Member Functions
CAknFepCtrlDragButton ( CFepUiLayout *, TInt )
void CreateDimmedMaskL ( CFbsBitmap *&, const CFbsBitmap *)
void DeleteForgroundRes ()
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::HandlePointerEnter(const TPoint &)
CButtonBase::HandlePointerLeave(const TPoint &)
CButtonBase::Hide(TBool)
CButtonBase::IsDimmed()
CButtonBase::ResetBmpPool()
CButtonBase::SetActive(TBool)
CButtonBase::SetBackgroundBitmapL(CFbsBitmap *)
CButtonBase::SetBackgroundMaskBitmapL(CFbsBitmap *)
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::~CButtonBase()
CDragBar::AddPositionObserver(MPositionObserver *)
CDragBar::CDragBar(const TRect &,CFepUiLayout *,TInt)
CDragBar::CancelPointerDownL()
CDragBar::ConstructL()
CDragBar::EnableDragging(TBool)
CDragBar::HandleControlEvent(TInt,CFepUiBaseCtrl *,const TDesC &)
CDragBar::HandlePointerMoveEventL(const TPoint &)
CDragBar::HandlePointerUpEventL(const TPoint &)
CDragBar::HandleTimerOut(TInt)
CDragBar::IsDragging()
CDragBar::IsDraggingComponent(CFepUiBaseCtrl *)
CDragBar::IsValidDestination(const TPoint &,TBool &,TBool &)
CDragBar::NewL(const TRect &,CFepUiLayout *,TInt)
CDragBar::OnDeActivate()
CDragBar::ReCalculateDragArea()
CDragBar::RemovePositionObserver(MPositionObserver *)
CDragBar::SetBitmapL(CFbsBitmap *,TButtonBmpType)
CDragBar::SetLongpressTimer(TTimeIntervalMicroSeconds32)
CDragBar::SetMaskBitmapL(CFbsBitmap *,TButtonBmpType)
CDragBar::SetRedrawInterval(TTimeIntervalMicroSeconds32)
CDragBar::~CDragBar()
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::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
Private Attributes
RPointerArray < CFbsBitmap > iBmpList
TBool iFirstTimeConstruct
CFbsBitmap * iForgroundBmp
CFbsBitmap * iForgroundBmpMask
TRect iForgroundBmpRect
CFbsBitmap * iForgroundDimBmpMask
TAknsItemID iInactiveImgID
RPointerArray < CFbsBitmap > iMaskBmpList
TAknsItemID iNormalImgID
TAknsItemID iPressedImgID
HBufC * iText
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

CAknFepCtrlDragButton(CFepUiLayout *, TInt)

IMPORT_C CAknFepCtrlDragButton ( CFepUiLayout * aUiLayout,
TInt aControlId
) [protected]

C++ default constructor.

Since
S60 v3.2

Parameters

CFepUiLayout * aUiLayout The Ui layout
TInt aControlId The control id

~CAknFepCtrlDragButton()

IMPORT_C ~CAknFepCtrlDragButton ( ) [virtual]

destructor.

Since
S60 v3.2

Member Functions Documentation

ConstructFromResourceL(TResourceReader &)

IMPORT_C void ConstructFromResourceL ( TResourceReader & aReader )

This function creates the 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 button from resource, before calling this function, caller should set resource id of 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

HandlePointerDownEventL(const TPoint &)

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

From CFepUiBaseCtrl Handle pointer down 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 ) [virtual]

From CFepUiBaseCtrl Update control and it's components rect

Since
S60 V4.0

Parameters

const TPoint & aOffset The offset to be moved

NewL(CFepUiLayout *, TInt)

IMPORT_C CAknFepCtrlDragButton * NewL ( CFepUiLayout * aUiLayout,
TInt aControlId
) [static]

Symbian constructor.

Since
S60 v3.2

Parameters

CFepUiLayout * aUiLayout The Ui layout
TInt aControlId The control id

NewLC(CFepUiLayout *, TInt)

IMPORT_C CAknFepCtrlDragButton * NewLC ( CFepUiLayout * aUiLayout,
TInt aControlId
) [static]

Symbian constructor.

Since
S60 v3.2

Parameters

CFepUiLayout * aUiLayout The Ui layout
TInt aControlId The control id

ResizeBitmaps(TSize)

void ResizeBitmaps ( TSize aSize ) [protected]

Parameters

TSize aSize

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

SetImageFrameId(TAknsItemID, TAknsItemID, TAknsItemID)

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

Parameters

TAknsItemID aNormalID
TAknsItemID aPressedID
TAknsItemID aInactiveID

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 =  TRect (),
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 =  TRect ()
TBool aIsReloadImages = EFalse ETrue for resizing images; otherwise EFalse

Member Data Documentation

RPointerArray< CFbsBitmap > iBmpList

RPointerArray < CFbsBitmap > iBmpList [private]

Array of background bmp (not own)

TBool iFirstTimeConstruct

TBool iFirstTimeConstruct [private]

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

TAknsItemID iInactiveImgID

TAknsItemID iInactiveImgID [private]

RPointerArray< CFbsBitmap > iMaskBmpList

RPointerArray < CFbsBitmap > iMaskBmpList [private]

Array of background mask bmp (not own)

TAknsItemID iNormalImgID

TAknsItemID iNormalImgID [private]

The img ID of button in various states

TAknsItemID iPressedImgID

TAknsItemID iPressedImgID [private]

HBufC * iText

HBufC * iText [private]

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.