Collapse all Symbian^3 Application Developer Library

CHgScrollerWithTitle Class Reference

class CHgScrollerWithTitle : public CCoeControl

Compound control that compounds a static title element and HgScroller. Scroller is owned by this control but it can be accessed freely. However, user of this class should not call InitScreenL for the scroller, because it is this classes responsibility to set correct size for the HgScroller.

Inherits from

CHgScrollerWithTitle
- CCoeControl
  - CBase

Public Member Functions
	~CHgScrollerWithTitle ()
CCoeControl *	ComponentControl ( TInt )
TInt	CountComponentControls ()
void	Draw (const TRect &)
void	FocusChanged ( TDrawNow )
IMPORT_C void	InitScreenL (const TRect &)
IMPORT_C CHgScrollerWithTitle *	NewL (const TRect &, TInt , THgScrollerType , CGulIcon *)
TKeyResponse	OfferKeyEventL (const TKeyEvent &, TEventCode )
IMPORT_C TSize	PreferredImageSize ()
IMPORT_C CHgScroller &	Scroller ()
void	SizeChanged ()
IMPORT_C CHgItem &	TitleItem ()

Protected Member Functions
	CHgScrollerWithTitle ()
void	ConstructL (const TRect &, TInt , THgScrollerType , CGulIcon *)

Inherited Functions
	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::ActivateL()
	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::ConstructFromResourceL(TResourceReader &)
	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::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::HandlePointerEventL(const TPointerEvent &)
	CCoeControl::HandleRedrawEvent(const TRect &)const
	CCoeControl::HandleResourceChange(TInt)
	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::MinimumSize()
	CCoeControl::MopSupplyObject(TTypeUid)
	CCoeControl::NotifyFontChange(const CCoeFontProvider *)
	CCoeControl::Observer()const
	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	THgScrollerType { EHgScrollerDoubleGraphicList , EHgScrollerDoubleTextList , EHgScrollerSingleGraphicList , EHgScrollerSingleLargeList , EHgScrollerSingleTextList , EHgScrollerGrid , EHgScrollerSingleTextListWithIcon , EHgScrollerDoubleGraphicListFlat }

Inherited Enumerations
	CCoeControl:TZoomType

Protected Attributes
TRgb	iColor
CHgListLayoutData *	iLayoutData
CHgScroller *	iScroller
CHgItem *	iTitleItem
TRect	iTitleRect

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

Constructor & Destructor Documentation

CHgScrollerWithTitle()

CHgScrollerWithTitle

(

)

[protected]

~CHgScrollerWithTitle()

~CHgScrollerWithTitle

(

)

[virtual]

Member Functions Documentation

ComponentControl(TInt)

CCoeControl *

ComponentControl

(

TInt

aIndex

)

const [virtual]

Parameters

TInt aIndex

ConstructL(const TRect &, TInt, THgScrollerType, CGulIcon *)

void	ConstructL	(	const TRect &	aRect,
			TInt	aItemCount,
			THgScrollerType	aScrollerType,
			CGulIcon *	aDefaultIcon
		)	[protected]

Parameters

const TRect & aRect
TInt aItemCount
THgScrollerType aScrollerType
CGulIcon * aDefaultIcon

CountComponentControls()

TInt

CountComponentControls

(

)

const [virtual]

Draw(const TRect &)

void

Draw

(

const TRect &

aRect

)

const [virtual]

Parameters

const TRect & aRect

FocusChanged(TDrawNow)

void

FocusChanged

(

TDrawNow

aDrawNow

)

[virtual]

Parameters

TDrawNow aDrawNow

InitScreenL(const TRect &)

IMPORT_C void

InitScreenL

(

const TRect &

aRect

)

Re-inits the grid display area.

Parameters

const TRect & aRect

New display rect

NewL(const TRect &, TInt, THgScrollerType, CGulIcon *)

IMPORT_C CHgScrollerWithTitle *	NewL	(	const TRect &	aRect,
			TInt	aItemCount,
			THgScrollerType	aScrollerType,
			CGulIcon *	aDefaultIcon = NULL
		)	[static]

Creates new CHgScrollerWithTitle .

Parameters

const TRect & aRect	Rect that the control draws onto.
TInt aItemCount	Total count of items in the grid
THgScrollerType aScrollerType	Type of the scroller control.
CGulIcon * aDefaultIcon = NULL	Default icon to be used.

OfferKeyEventL(const TKeyEvent &, TEventCode)

TKeyResponse	OfferKeyEventL	(	const TKeyEvent &	aKeyEvent,
			TEventCode	aType
		)	[virtual]

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

PreferredImageSize()

IMPORT_C TSize

PreferredImageSize

(

)

[static]

Returns preferred image size that should be used when setting image to title.

Scroller()

IMPORT_C CHgScroller &

Scroller

(

)

SizeChanged()

void

SizeChanged

(

)

[virtual]

TitleItem()

IMPORT_C CHgItem &

TitleItem

(

)

Member Enumerations Documentation

Enum THgScrollerType

Enumerators

EHgScrollerDoubleGraphicList
EHgScrollerDoubleTextList
EHgScrollerSingleGraphicList
EHgScrollerSingleLargeList
EHgScrollerSingleTextList
EHgScrollerGrid
EHgScrollerSingleTextListWithIcon
EHgScrollerDoubleGraphicListFlat

Member Data Documentation

TRgb iColor

TRgb

iColor

[protected]

CHgListLayoutData * iLayoutData

CHgListLayoutData *

iLayoutData

[protected]

CHgScroller * iScroller

CHgScroller *

iScroller

[protected]

CHgItem * iTitleItem

CHgItem *

iTitleItem

[protected]

TRect iTitleRect

TRect

iTitleRect

[protected]