CGSParentContainer Class Reference

class CGSParentContainer : public CCoeControl
Container class for the GS Main view. GSFramework.lib
Since
Series60_3.1

Inherits from

Public Member Functions
~CGSParentContainer()
voidConstructL(const TRect &, CAknViewAppUi *, CArrayPtrFlat< CGSPluginInterface > *, TInt, CGSParentPlugin *, TGSListboxTypes)
IMPORT_C voidFocusChanged(TDrawNow)
voidGetHelpContext(TCoeHelpContext &)
voidHandleResourceChange(TInt)
voidHandleSelectionKeyL()
CEikListBox *ListBox()
voidRestoreListBoxPositionL(const CGSParentPlugin::TListBoxPosition &, TBool)
CGSPluginInterface *SelectedPlugin()
voidSetListBoxEmptyTextL(const TDes &)
voidSetSelectedItem(TUid)
voidSetTopItem(TUid)
voidStoreListBoxPositionL(CGSParentPlugin::TListBoxPosition &)
CGSPluginInterface *TopPlugin()
voidUpdateListBoxL()
Protected Member Functions
voidHandleListBoxEventL(CEikListBox *, TListBoxEvent)
Private Member Functions
voidAddPluginDataToLbxL(CGSPluginInterface *, CDesCArray *, CAknIconArray *, TInt &)
CCoeControl *ComponentControl(TInt)
TInt CountComponentControls()
voidCreateListBoxL(TGSListboxTypes)
TKeyResponse OfferKeyEventL(const TKeyEvent &, TEventCode)
voidSizeChanged()
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::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::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()
Inherited Enumerations
CCoeControl:TZoomType
Private Attributes
CAknViewAppUi *iAppUi
CGsContainerExt *iExt
CDesCArray *iItemTextArray
CEikListBox *iListBox
TGSListboxTypes iListBoxType
CGSParentPlugin *iParentPlugin
CArrayPtrFlat< CGSPluginInterface > *iPluginArray
CArrayPtrFlat< CGSPluginInterface > *iVisiblePlugins
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

~CGSParentContainer()

~CGSParentContainer()

Destructor.

Member Functions Documentation

AddPluginDataToLbxL(CGSPluginInterface *, CDesCArray *, CAknIconArray *, TInt &)

voidAddPluginDataToLbxL(CGSPluginInterface *aPlugin,
CDesCArray *aItemTextArray,
CAknIconArray *aIconArray,
TInt &aIconCounter
)[private]

Adds plugin data to listbox.

Parameters

CGSPluginInterface * aPluginA plugin whose data is to be used.
CDesCArray * aItemTextArrayArray for plugin texts and format strings used by lbx.
CAknIconArray * aIconArrayArray for icons used in lbx.
TInt & aIconCounterCounter for inserted icons, will be updated.

ComponentControl(TInt)

CCoeControl *ComponentControl(TInt)const [private, virtual]

See base class.

Parameters

TInt

ConstructL(const TRect &, CAknViewAppUi *, CArrayPtrFlat< CGSPluginInterface > *, TInt, CGSParentPlugin *, TGSListboxTypes)

voidConstructL(const TRect &aRect,
CAknViewAppUi *aAppUi,
CArrayPtrFlat< CGSPluginInterface > *aPluginArray,
TIntaTitleRscId,
CGSParentPlugin *aParentPlugin,
TGSListboxTypesaListBoxType = EGSListBoxTypeSingleLarge
)

Symbian OS constructor. Required by the base class. Symbian OS constructor. Required by the base class.

Parameters

const TRect & aRect
CAknViewAppUi * aAppUi
CArrayPtrFlat< CGSPluginInterface > * aPluginArray
TInt aTitleRscId
CGSParentPlugin * aParentPlugin
TGSListboxTypes aListBoxType = EGSListBoxTypeSingleLarge

CountComponentControls()

TInt CountComponentControls()const [private, virtual]

See base class.

CreateListBoxL(TGSListboxTypes)

voidCreateListBoxL(TGSListboxTypesaListBoxType)[private]

Creates a listbox.

Parameters

TGSListboxTypes aListBoxType

FocusChanged(TDrawNow)

IMPORT_C voidFocusChanged(TDrawNowaDrawNow)[virtual]

Set focus on the selected listbox. For animated skins feature.

Parameters

TDrawNow aDrawNow

GetHelpContext(TCoeHelpContext &)

voidGetHelpContext(TCoeHelpContext &aContext)const [virtual]

See base class.

Parameters

TCoeHelpContext & aContext

HandleListBoxEventL(CEikListBox *, TListBoxEvent)

voidHandleListBoxEventL(CEikListBox *aListBox,
TListBoxEventaEventType
)[protected]

Handles listbox events.

Parameters

CEikListBox * aListBoxListbox where the event occurred.
TListBoxEvent aEventTypeEvent type.

HandleResourceChange(TInt)

voidHandleResourceChange(TIntaType)[virtual]

See base class.

Parameters

TInt aType

HandleSelectionKeyL()

voidHandleSelectionKeyL()

ListBox()

CEikListBox *ListBox()

OfferKeyEventL(const TKeyEvent &, TEventCode)

TKeyResponse OfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[private, virtual]

See base class.

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

RestoreListBoxPositionL(const CGSParentPlugin::TListBoxPosition &, TBool)

voidRestoreListBoxPositionL(const CGSParentPlugin::TListBoxPosition &aPosition,
TBoolaScreenModeChanged
)

Restore listbox's exact position.

Parameters

const CGSParentPlugin::TListBoxPosition & aPositionincludes the exact position of the listbox.
TBool aScreenModeChangedindicates whether the screen mode is changed.

SelectedPlugin()

CGSPluginInterface *SelectedPlugin()

SetListBoxEmptyTextL(const TDes &)

voidSetListBoxEmptyTextL(const TDes &aEmpty)

Set the empty text of list box.

Parameters

const TDes & aEmpty

SetSelectedItem(TUid)

voidSetSelectedItem(TUidaSelectedItemUid)

Sets selected lbx item using the UID of the item. If the item is not existing or visible anymore, selected item is the first item in the lbx.

Parameters

TUid aSelectedItemUid

SetTopItem(TUid)

voidSetTopItem(TUidaTopItemUid)

Sets top lbx item using the UID of the item.

Parameters

TUid aTopItemUid

SizeChanged()

voidSizeChanged()[private, virtual]

See base class.

StoreListBoxPositionL(CGSParentPlugin::TListBoxPosition &)

voidStoreListBoxPositionL(CGSParentPlugin::TListBoxPosition &aPosition)

Store listbox's exact position.

Parameters

CGSParentPlugin::TListBoxPosition & aPositionincludes the exact position of the listbox.

TopPlugin()

CGSPluginInterface *TopPlugin()

UpdateListBoxL()

voidUpdateListBoxL()

Updates iListBox. Listbox is updated depending on the type of the listbox. Plugins are inserted to listbox only if they are visible.

Member Data Documentation

CAknViewAppUi * iAppUi

CAknViewAppUi *iAppUi[private]

CGsContainerExt * iExt

CGsContainerExt *iExt[private]

CDesCArray * iItemTextArray

CDesCArray *iItemTextArray[private]

CEikListBox * iListBox

CEikListBox *iListBox[private]

TGSListboxTypes iListBoxType

TGSListboxTypes iListBoxType[private]

CGSParentPlugin * iParentPlugin

CGSParentPlugin *iParentPlugin[private]

CArrayPtrFlat< CGSPluginInterface > * iPluginArray

CArrayPtrFlat< CGSPluginInterface > *iPluginArray[private]

CArrayPtrFlat< CGSPluginInterface > * iVisiblePlugins

CArrayPtrFlat< CGSPluginInterface > *iVisiblePlugins[private]