Collapse all Symbian^3 Product Developer Library

CAknPopupHeadingPane Class Reference

class CAknPopupHeadingPane : public CAknControl

Header control for queries. Defines properties of the header of the pop-up menu.

Since: Series 60 0.9

Inherits from

CAknPopupHeadingPane
- CAknControl
  - CCoeControl
    - CBase

Public Member Functions
	CAknPopupHeadingPane()
	~CAknPopupHeadingPane()
void	ActivateL()
IMPORT_C TInt	CancelAnimation()
IMPORT_C void	ConstructFromResourceL(TResourceReader &)
IMPORT_C void	ConstructL(TPtrC)
IMPORT_C void	HandlePointerEventL(const TPointerEvent &)
IMPORT_C void	HandleResourceChange(TInt)
IMPORT_C TSize	MinimumSize()
IMPORT_C CEikLabel *	Prompt()
IMPORT_C TPtr	PromptText()
IMPORT_C void	SetHeaderAnimationL(TInt)
IMPORT_C void	SetHeaderImageL(CEikImage *)
IMPORT_C void	SetHeaderImageOwnedL(CEikImage *)
IMPORT_C void	SetLayout(THeadingPaneLayout)
void	SetPageL(TInt, TInt)
IMPORT_C void	SetSkinFrameCenterId(const TAknsItemID &)
IMPORT_C void	SetSkinFrameId(const TAknsItemID &)
IMPORT_C void	SetTextL(TPtrC)
void	SetTouchObserver(MAknHeadingPaneTouchObserver *)
IMPORT_C void	SizeChanged()
IMPORT_C void	StartAnimationL()

Private Member Functions
CCoeControl *	ComponentControl(TInt)
TInt	CountComponentControls()
void	DoSetPromptL()
IMPORT_C void	Draw(const TRect &)
IMPORT_C void *	ExtensionInterface(TUid)
void	LayoutColourSelectionGridHeadingPane()
void	LayoutListHeadingPane()
void	LayoutMessageQueryHeadingPane()
void	LayoutQueryHeadingPane()
HBufC *	PageTextL()
void	SetAnimationBackGroundFrameL()

Inherited Functions
	CAknControl::CAknControl()
	CAknControl::~CAknControl()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	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()
	CCoeControl::AccumulatedZoom()const
	CCoeControl::ActivateGc()const
	CCoeControl::BackedUpWindow()const
	CCoeControl::Background()const
	CCoeControl::CCoeControl()
	CCoeControl::CCoeControl(CCoeEnv *)
	CCoeControl::CCoeControl(const CCoeControl &)
	CCoeControl::CapturesPointer()const
	CCoeControl::ClaimPointerGrab(TBool)
	CCoeControl::ClaimPointerGrab(TInt,TBool)
	CCoeControl::CloseWindow()
	CCoeControl::ComponentArrayExists()const
	CCoeControl::Components()
	CCoeControl::Components()const
	CCoeControl::ControlContext()const
	CCoeControl::ControlEnv()const
	CCoeControl::CopyControlContextFrom(const CCoeControl *)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
	CCoeControl::CreateWindowL()
	CCoeControl::CreateWindowL(RWindowGroup *)
	CCoeControl::CreateWindowL(RWindowTreeNode &)
	CCoeControl::CreateWindowL(const CCoeControl *)
	CCoeControl::CustomGc()const
	CCoeControl::DeactivateGc()const
	CCoeControl::DrawBackground(const TRect &)const
	CCoeControl::DrawDeferred()const
	CCoeControl::DrawForeground(const TRect &)const
	CCoeControl::DrawNow()const
	CCoeControl::DrawNow(const TRect &)const
	CCoeControl::DrawableWindow()const
	CCoeControl::EnableDragEvents()
	CCoeControl::EnableReportControlStateChange(TBool)
	CCoeControl::EnableWindowTransparency()
	CCoeControl::FindBackground()const
	CCoeControl::FindFontProvider()const
	CCoeControl::FocusChanged(TDrawNow)
	CCoeControl::GetColor(TInt,TRgb &)const
	CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
	CCoeControl::GetGc()const
	CCoeControl::GetHelpContext(TCoeHelpContext &)const
	CCoeControl::GrabbingComponent()const
	CCoeControl::GrabbingComponent(TInt)const
	CCoeControl::HandleComponentControlsResourceChange(TInt)
	CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray ,CCoeControl ,TInt)
	CCoeControl::HandlePointerBufferReadyL()
	CCoeControl::HandleRedrawEvent(const TRect &)const
	CCoeControl::HasBorder()const
	CCoeControl::HitTest()const
	CCoeControl::IgnoreEventsUntilNextPointerUp()
	CCoeControl::Index(const CCoeControl *)const
	CCoeControl::InitComponentArrayL()
	CCoeControl::InputCapabilities()const
	CCoeControl::IsActivated()const
	CCoeControl::IsBackedUp()const
	CCoeControl::IsBeingDestroyed()const
	CCoeControl::IsBlank()const
	CCoeControl::IsDimmed()const
	CCoeControl::IsFocused()const
	CCoeControl::IsNonFocusing()const
	CCoeControl::IsReadyToDraw()const
	CCoeControl::IsVisible()const
	CCoeControl::LayoutManager()const
	CCoeControl::MakeVisible(TBool)
	CCoeControl::MaximumWidth()const
	CCoeControl::MopSupplyObject(TTypeUid)
	CCoeControl::NotifyFontChange(const CCoeFontProvider *)
	CCoeControl::Observer()const
	CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
	CCoeControl::OverrideColorL(TInt,TRgb)
	CCoeControl::OwnsWindow()const
	CCoeControl::Parent()
	CCoeControl::Parent()const
	CCoeControl::Position()const
	CCoeControl::PositionChanged()
	CCoeControl::PositionRelativeToScreen()const
	CCoeControl::PrepareForFocusGainL()
	CCoeControl::PrepareForFocusLossL()
	CCoeControl::ProcessPointerBufferReadyL()
	CCoeControl::ProcessPointerEventL(const TPointerEvent &)
	CCoeControl::Rect()const
	CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
	CCoeControl::RecursivelyMergedInputCapabilities()const
	CCoeControl::RefetchPixelMappingL()
	CCoeControl::RemoveFromParent()
	CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
	CCoeControl::RequestRelayout(const CCoeControl *)
	CCoeControl::ResetGc()const
	CCoeControl::ScreenFont(const TCoeFont &)const
	CCoeControl::SetAdjacent(TInt)
	CCoeControl::SetAllowStrayPointers()
	CCoeControl::SetBackground(const MCoeControlBackground *)
	CCoeControl::SetBlank()
	CCoeControl::SetCanDrawOutsideRect()
	CCoeControl::SetComponentsToInheritVisibility(TBool)
	CCoeControl::SetContainerWindowL(RBackedUpWindow &)
	CCoeControl::SetContainerWindowL(RWindow &)
	CCoeControl::SetContainerWindowL(const CCoeControl &)
	CCoeControl::SetControlContext(MCoeControlContext *)
	CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
	CCoeControl::SetCustomGc(CWindowGc *)
	CCoeControl::SetDimmed(TBool)
	CCoeControl::SetExtent(const TPoint &,const TSize &)
	CCoeControl::SetExtentToWholeScreen()
	CCoeControl::SetFocus(TBool,TDrawNow)
	CCoeControl::SetFocusing(TBool)
	CCoeControl::SetFontProviderL(const CCoeFontProvider &)
	CCoeControl::SetGc(CWindowGc *)const
	CCoeControl::SetGloballyCapturing(TBool)
	CCoeControl::SetHitTest(const MCoeControlHitTest *)
	CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
	CCoeControl::SetMaximumWidth(TInt)
	CCoeControl::SetMopParent(MObjectProvider *)
	CCoeControl::SetNeighbor(CCoeControl *)
	CCoeControl::SetNonFocusing()
	CCoeControl::SetObserver(MCoeControlObserver *)
	CCoeControl::SetParent(CCoeControl *)
	CCoeControl::SetPointerCapture(TBool)
	CCoeControl::SetPosition(const TPoint &)
	CCoeControl::SetRect(const TRect &)
	CCoeControl::SetSize(const TSize &)
	CCoeControl::SetSizeWithoutNotification(const TSize &)
	CCoeControl::SetTextBaselineSpacing(TInt)
	CCoeControl::SetUniqueHandle(TInt)
	CCoeControl::SetZoomFactorL(TInt,TZoomType)
	CCoeControl::Size()const
	CCoeControl::SystemGc()const
	CCoeControl::TextBaselineOffset(const TSize &)const
	CCoeControl::TextDrawer(TInt)const
	CCoeControl::UniqueHandle()const
	CCoeControl::Window()const
	CCoeControl::WriteInternalStateL(RWriteStream &)const
	CCoeControl::WriteInternalStateNowL(RWriteStream &)const
	CCoeControl::ZoomWithType()const
	CCoeControl::operator=(const CCoeControl &)
	CCoeControl::~CCoeControl()

Public Member Enumerations
enum	THeadingPaneLayout { EQueryHeadingPane, EListHeadingPane, EColourSelectionGridHeadingPane, EMessageQueryHeadingPane }

Inherited Enumerations
	CCoeControl:TZoomType

Private Attributes
CAknBitmapAnimation *	iAnimation
CAknPopupHeadingAttributes *	iAttributes
CAknPopupHeadingPaneExtension *	iExtension
CEikImage *	iHeaderImage
TInt	iHeadingLayoutRef
TAknLayoutRect	iLayoutHeading
CAknTextControl *	iPrompt

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize

Constructor & Destructor Documentation

CAknPopupHeadingPane()

IMPORT_C

CAknPopupHeadingPane

(

)

Constructor.

~CAknPopupHeadingPane()

IMPORT_C

~CAknPopupHeadingPane

(

)

Destructor.

Member Functions Documentation

ActivateL()

void

ActivateL

(

)

[virtual]

From CCoeControl. Activates popup heading. Calls CCoeControl::ActivateL().

CancelAnimation()

IMPORT_C TInt

CancelAnimation

(

)

Cancel the animation. Calls RBitmapAnim::CommandReply(EBitmapAnimCommandStopAnimation).

ComponentControl(TInt)

CCoeControl *

ComponentControl

(

TInt

anIndex

)

const [private, virtual]

Parameters

TInt anIndex

ConstructFromResourceL(TResourceReader &)

IMPORT_C void

ConstructFromResourceL

(

TResourceReader &

aReader

)

[virtual]

From CCoeControl. Constructs heading pane from a resource file. Current resource reader position must point to AVKON_HEADING resource.

Parameters

TResourceReader & aReader

The resource reader with which to access the header resource values.

ConstructL(TPtrC)

IMPORT_C void

ConstructL

(

TPtrC

aText

)

Completes the construction of the CAknPopupHeadingPane object. Layout is set to EQueryHeadingPane by default.

Parameters

TPtrC aText

Header text.

CountComponentControls()

TInt

CountComponentControls

(

)

const [private, virtual]

DoSetPromptL()

void

DoSetPromptL

(

)

[private]

Draw(const TRect &)

IMPORT_C void

Draw

(

const TRect &

aRect

)

const [private, virtual]

Parameters

const TRect & aRect

ExtensionInterface(TUid)

IMPORT_C void *

ExtensionInterface

(

TUid

aInterface

)

[private, virtual]

From CAknControl

Parameters

TUid aInterface

HandlePointerEventL(const TPointerEvent &)

IMPORT_C void

HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

[virtual]

Parameters

const TPointerEvent & aPointerEvent

HandleResourceChange(TInt)

IMPORT_C void

HandleResourceChange

(

TInt

aType

)

[virtual]

Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.

Since: 3.1

Parameters

TInt aType

LayoutColourSelectionGridHeadingPane()

void

LayoutColourSelectionGridHeadingPane

(

)

[private]

LayoutListHeadingPane()

void

LayoutListHeadingPane

(

)

[private]

LayoutMessageQueryHeadingPane()

void

LayoutMessageQueryHeadingPane

(

)

[private]

LayoutQueryHeadingPane()

void

LayoutQueryHeadingPane

(

)

[private]

MinimumSize()

IMPORT_C TSize

MinimumSize

(

)

[virtual]

From CCoeControl. Get the minimum required size of heading pane.

PageTextL()

HBufC *

PageTextL

(

)

const [private]

Prompt()

IMPORT_C CEikLabel *

Prompt

(

)

const

Get pointer to the prompt control.

PromptText()

IMPORT_C TPtr

PromptText

(

)

const

Get prompt text.

SetAnimationBackGroundFrameL()

void

SetAnimationBackGroundFrameL

(

)

[private]

SetHeaderAnimationL(TInt)

IMPORT_C void

SetHeaderAnimationL

(

TInt

aResourceId

)

Set header animation by reading BMPANIM_DATA resource.

Parameters

TInt aResourceId

A resource identifier for the header animation.

SetHeaderImageL(CEikImage *)

IMPORT_C void

SetHeaderImageL

(

CEikImage *

aImage

)

Set header image.

Parameters

CEikImage * aImage

A header image.

SetHeaderImageOwnedL(CEikImage *)

IMPORT_C void

SetHeaderImageOwnedL

(

CEikImage *

aImage

)

Set header image. Gets the ownership of the image.

Parameters

CEikImage * aImage

A header image.

SetLayout(THeadingPaneLayout)

IMPORT_C void

SetLayout

(

THeadingPaneLayout

aLayout

)

Set layout of the heading pane.

Parameters

THeadingPaneLayout aLayout

A layout of the heading pane.

SetPageL(TInt, TInt)

void	SetPageL	(	TInt	aCurrent,
			TInt	aMax = 0
		)

Parameters

TInt aCurrent
TInt aMax = 0

SetSkinFrameCenterId(const TAknsItemID &)

IMPORT_C void

SetSkinFrameCenterId

(

const TAknsItemID &

aFrameCenterId

)

Parameters

const TAknsItemID & aFrameCenterId

SetSkinFrameId(const TAknsItemID &)

IMPORT_C void

SetSkinFrameId

(

const TAknsItemID &

aFrameId

)

Set heading frame ids. These can be used to override default ids.

Parameters

const TAknsItemID & aFrameId

/ aFrameCenterId Ids of heading's frame..

SetTextL(TPtrC)

IMPORT_C void

SetTextL

(

TPtrC

aText

)

Set header text.

Parameters

TPtrC aText

A header text.

SetTouchObserver(MAknHeadingPaneTouchObserver *)

void

SetTouchObserver

(

MAknHeadingPaneTouchObserver *

aTouchObserver

)

Set the heading pane touch observer. The observer must derive from MAknHeadingPaneTouchObserver and implement method HandleHeadingPanePointerEventL().

Parameters

MAknHeadingPaneTouchObserver * aTouchObserver

SizeChanged()

IMPORT_C void

SizeChanged

(

)

[virtual]

From CCoeControl. Responds to size changes to sets the size and position of the contents of the heading pane.

StartAnimationL()

IMPORT_C void

StartAnimationL

(

)

Start the animation.

Member Enumerations Documentation

Enum THeadingPaneLayout

Enumeration for different layouts

Enumerators

EQueryHeadingPane	Query mode layout for heading pane
EListHeadingPane	List mode layout for heading pane
EColourSelectionGridHeadingPane	Heading pane for colour selection list. Since 3.0
EMessageQueryHeadingPane	Heading pane for message query. Since 3.0

Member Data Documentation

CAknBitmapAnimation * iAnimation

CAknBitmapAnimation *

iAnimation

[private]

CAknPopupHeadingAttributes * iAttributes

CAknPopupHeadingAttributes *

iAttributes

[private]

CAknPopupHeadingPaneExtension * iExtension

CAknPopupHeadingPaneExtension *

iExtension

[private]

CEikImage * iHeaderImage

CEikImage *

iHeaderImage

[private]

TInt iHeadingLayoutRef

TInt

iHeadingLayoutRef

[private]

TAknLayoutRect iLayoutHeading

TAknLayoutRect

iLayoutHeading

[private]

CAknTextControl * iPrompt

CAknTextControl *

iPrompt

[private]