Collapse all Symbian^3 Application Developer Library

CAknFepCtrlEventButton Class Reference

class CAknFepCtrlEventButton : public CAknFepCtrlCommonButton

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

CAknFepCtrlEventButton
- CAknFepCtrlCommonButton
  - CButtonBase
    - CFepUiBaseCtrl
      - CBase

Public Member Functions
	~CAknFepCtrlEventButton ()
IMPORT_C void	Draw ()
IMPORT_C TInt	Event ()
IMPORT_C CFepUiBaseCtrl *	HandlePointerUpEventL (const TPoint &)
IMPORT_C CAknFepCtrlEventButton *	NewL ( CFepUiLayout *, TInt , TInt , TInt , TAknsItemID , TAknsItemID , TAknsItemID )
IMPORT_C CAknFepCtrlEventButton *	NewLC ( CFepUiLayout *, TInt , TInt , TInt , TAknsItemID , TAknsItemID , TAknsItemID )
IMPORT_C void	SetEvent ( TInt )
IMPORT_C void	SetFont (const CFont *)
IMPORT_C void	SetFontColor (const TRgb )
IMPORT_C void	SetShadowFont (const CFont *)
IMPORT_C void	SetShadowFontColor (const TRgb )
IMPORT_C void	SetText (const TDesC &)
IMPORT_C void	SetUnicode ( TInt )
IMPORT_C TInt	Unicode ()

Protected Member Functions
	CAknFepCtrlEventButton ( CFepUiLayout *, TInt , TInt , TInt , TAknsItemID , TAknsItemID , TAknsItemID )
IMPORT_C void	DisplayText ()

Inherited Functions
	CAknFepCtrlCommonButton::CAknFepCtrlCommonButton(CFepUiLayout *,TInt,TAknsItemID,TAknsItemID,TAknsItemID)
	CAknFepCtrlCommonButton::CancelPointerDownL()
	CAknFepCtrlCommonButton::ConstructFromResourceL()
	CAknFepCtrlCommonButton::ConstructFromResourceL(TResourceReader &)
	CAknFepCtrlCommonButton::CreateDimmedMaskL(CFbsBitmap &,const CFbsBitmap )
	CAknFepCtrlCommonButton::DeleteForgroundRes()
	CAknFepCtrlCommonButton::ForgroundBmp()
	CAknFepCtrlCommonButton::ForgroundBmpMask()
	CAknFepCtrlCommonButton::ForgroundBmpRect()const
	CAknFepCtrlCommonButton::HandlePointerDownEventL(const TPoint &)
	CAknFepCtrlCommonButton::HandlePointerEnter(const TPoint &)
	CAknFepCtrlCommonButton::HandlePointerLeave(const TPoint &)
	CAknFepCtrlCommonButton::Move(const TPoint &)
	CAknFepCtrlCommonButton::NewL(CFepUiLayout *,TInt,TAknsItemID,TAknsItemID,TAknsItemID)
	CAknFepCtrlCommonButton::NewLC(CFepUiLayout *,TInt,TAknsItemID,TAknsItemID,TAknsItemID)
	CAknFepCtrlCommonButton::ResizeBitmaps(TSize)
	CAknFepCtrlCommonButton::Set3PiecesColorIcons(CPenInput3PiecesColorIcons *)
	CAknFepCtrlCommonButton::SetActive(TBool)
	CAknFepCtrlCommonButton::SetDraw3PieceFrameInfo(TDraw3PiecesFrame)
	CAknFepCtrlCommonButton::SetForegroundBmpL(CFbsBitmap ,CFbsBitmap )
	CAknFepCtrlCommonButton::SetForgroundBmpRect(const TRect &)
	CAknFepCtrlCommonButton::SetHighlight(TBool)
	CAknFepCtrlCommonButton::SetImageFrameId(TAknsItemID,TAknsItemID,TAknsItemID)
	CAknFepCtrlCommonButton::SetTextColorIndex(TInt)
	CAknFepCtrlCommonButton::SetTextFormat(TAknTextLineLayout)
	CAknFepCtrlCommonButton::SetTextL(const TDesC &)
	CAknFepCtrlCommonButton::SizeChanged(TRect,TRect,TBool)
	CAknFepCtrlCommonButton::TextColorIndex()const
	CAknFepCtrlCommonButton::~CAknFepCtrlCommonButton()
	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 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

Private Attributes
TInt	iEvent
const CFont *	iFont
TRgb	iFontColor
const CFont *	iShadowFont
TRgb	iShadowFontColor
HBufC *	iText
TInt	iUnicode

Inherited Attributes
	CAknFepCtrlCommonButton::iFirstTimeConstruct
	CAknFepCtrlCommonButton::iHighlight
	CAknFepCtrlCommonButton::iPressed
	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

CAknFepCtrlEventButton(CFepUiLayout *, TInt, TInt, TInt, TAknsItemID, TAknsItemID, TAknsItemID)

IMPORT_C	CAknFepCtrlEventButton	(	CFepUiLayout *	aUiLayout,
			TInt	aControlId,
			TInt	aEvent,
			TInt	aUnicode,
			TAknsItemID	aNormalID = KAknsIIDQsnFrFunctionButtonNormal ,
			TAknsItemID	aPressedID = KAknsIIDQsnFrFunctionButtonPressed ,
			TAknsItemID	aInactiveID = KAknsIIDQsnFrFunctionButtonInactive
		)	[protected]

C++ constructor.

Since: S60 v3.2

Parameters

CFepUiLayout * aUiLayout	Ui Layout who contains this control
TInt aControlId	Control Id
TInt aEvent	An event Id to be sent
TInt aUnicode	A Unicode value to be sent
TAknsItemID aNormalID = KAknsIIDQsnFrFunctionButtonNormal
TAknsItemID aPressedID = KAknsIIDQsnFrFunctionButtonPressed
TAknsItemID aInactiveID = KAknsIIDQsnFrFunctionButtonInactive

~CAknFepCtrlEventButton()

IMPORT_C

~CAknFepCtrlEventButton

(

)

[virtual]

destructor.

Since: S60 v3.2

Member Functions Documentation

DisplayText()

IMPORT_C void

DisplayText

(

)

[protected]

Display button caption.

Since: S60 v3.2

Draw()

IMPORT_C void

Draw

(

)

[virtual]

Draw function

Since: S60 v3.2

Event()

IMPORT_C TInt

Event

(

)

const

This function gets the current Event Id

Since: S60 v3.2

HandlePointerUpEventL(const TPoint &)

IMPORT_C CFepUiBaseCtrl *

HandlePointerUpEventL

(

const TPoint &

aPoint

)

[virtual]

From CButtonBase Handle button up event. cancel all timers

Since: S60 v3.2

Parameters

const TPoint & aPoint

Point position

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

IMPORT_C CAknFepCtrlEventButton *	NewL	(	CFepUiLayout *	aUiLayout,
			TInt	aControlId,
			TInt	aEvent = 0xFFFF,
			TInt	aUnicode = 0,
			TAknsItemID	aNormalID = KAknsIIDQsnFrFunctionButtonNormal ,
			TAknsItemID	aPressedID = KAknsIIDQsnFrFunctionButtonPressed ,
			TAknsItemID	aInactiveID = KAknsIIDQsnFrFunctionButtonInactive
		)	[static]

Symbian constructor.

Since: S60 v3.2

Parameters

CFepUiLayout * aUiLayout	The layout
TInt aControlId	The control id
TInt aEvent = 0xFFFF	An event Id to be sent
TInt aUnicode = 0	A Unicode value to be sent
TAknsItemID aNormalID = KAknsIIDQsnFrFunctionButtonNormal
TAknsItemID aPressedID = KAknsIIDQsnFrFunctionButtonPressed
TAknsItemID aInactiveID = KAknsIIDQsnFrFunctionButtonInactive

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

IMPORT_C CAknFepCtrlEventButton *	NewLC	(	CFepUiLayout *	aUiLayout,
			TInt	aControlId,
			TInt	aEvent = 0xFFFF,
			TInt	aUnicode = 0,
			TAknsItemID	aNormalID = KAknsIIDQsnFrFunctionButtonNormal ,
			TAknsItemID	aPressedID = KAknsIIDQsnFrFunctionButtonPressed ,
			TAknsItemID	aInactiveID = KAknsIIDQsnFrFunctionButtonInactive
		)	[static]

Symbian constructor.

Since: S60 v3.2

Parameters

CFepUiLayout * aUiLayout	The layout
TInt aControlId	The control id
TInt aEvent = 0xFFFF	An event Id to be sent
TInt aUnicode = 0	A Unicode value to be sent
TAknsItemID aNormalID = KAknsIIDQsnFrFunctionButtonNormal
TAknsItemID aPressedID = KAknsIIDQsnFrFunctionButtonPressed
TAknsItemID aInactiveID = KAknsIIDQsnFrFunctionButtonInactive

SetEvent(TInt)

IMPORT_C void

SetEvent

(

TInt

aEvent

)

This function sets the Event Id sent by this button

Since: S60 v3.2

Parameters

TInt aEvent

An event Id to be sent

SetFont(const CFont *)

IMPORT_C void

SetFont

(

const CFont *

aFont

)

This function set the font used to draw the text

Since: S60 v3.2

Parameters

const CFont * aFont

the font

SetFontColor(const TRgb)

IMPORT_C void

SetFontColor

(

const TRgb

aColor

)

This function set the font color used to draw the text

Since: S60 v3.2

Parameters

const TRgb aColor

the font color

SetShadowFont(const CFont *)

IMPORT_C void

SetShadowFont

(

const CFont *

aFont

)

This function set the shadow font used to draw the text

Since: S60 v3.2

Parameters

const CFont * aFont

the shadow font

SetShadowFontColor(const TRgb)

IMPORT_C void

SetShadowFontColor

(

const TRgb

aColor

)

This function set the shadow font color used to draw the text

Since: S60 v3.2

Parameters

const TRgb aColor

the shadow font color

SetText(const TDesC &)

IMPORT_C void

SetText

(

const TDesC &

aText

)

This function sets the text written on the button

Since: S60 v3.2

Parameters

const TDesC & aText

the text will be shown

SetUnicode(TInt)

IMPORT_C void

SetUnicode

(

TInt

aUnicode

)

This function sets the Unicode value sent by this button

Since: S60 v3.2

Parameters

TInt aUnicode

A Unicode value to be sent

Unicode()

IMPORT_C TInt

Unicode

(

)

const

This function gets the current Unicode value

Since: S60 v3.2

Member Data Documentation

TInt iEvent

TInt

iEvent

[private]

Event Id

const CFont * iFont

const CFont *

iFont

[private]

the font used to show the text

TRgb iFontColor

TRgb

iFontColor

[private]

the font color used to show the text

const CFont * iShadowFont

const CFont *

iShadowFont

[private]

the shadow font used to show the text

TRgb iShadowFontColor

TRgb

iShadowFontColor

[private]

the shadow font color used to show the text

HBufC * iText

HBufC *

iText

[private]

Text shown on button

TInt iUnicode

TInt

iUnicode

[private]

Unicode value