CGSMainContainer Class Reference

class CGSMainContainer : public CCoeControl
Container class for the GS Main view.
Since
Series60_3.1

Inherits from

Public Member Functions
~CGSMainContainer ()
void ConstructL (const TRect &, CAknViewAppUi *, CArrayPtrFlat < CGSPluginInterface > *)
void FocusChanged ( TDrawNow )
void HandleResourceChange ( TInt )
CAknSingleLargeStyleListBox * ListBox ()
void RestoreListBoxPositionL (const CGSMainView::TListBoxPosition &, TBool )
CGSPluginInterface * SelectedPlugin ()
void SetListBoxEmptyTextL (const TDes &)
void SetSelectedItem ( TUid )
void StoreListBoxPositionL ( CGSMainView::TListBoxPosition &)
void UpdateListBoxL ()
Protected Member Functions
void GetHelpContext ( TCoeHelpContext &)
void HandleListBoxEventL ( CEikListBox *, TListBoxEvent)
Private Member Functions
void AddPluginDataToLbxL ( CGSPluginInterface *, TInt , CDesCArray *, CAknIconArray *)
CCoeControl * ComponentControl ( TInt )
TInt CountComponentControls ()
TKeyResponse OfferKeyEventL (const TKeyEvent &, TEventCode )
void SizeChanged ()
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
CAknSingleLargeStyleListBox * iListBox
CArrayPtrFlat < CGSPluginInterface > * iPluginArray
CArrayPtrFlat < CGSPluginInterface > * iVisiblePlugins
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

~CGSMainContainer()

~CGSMainContainer ( )

Destructor.

Member Functions Documentation

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

void AddPluginDataToLbxL ( CGSPluginInterface * aPlugin,
TInt aIndex,
CDesCArray * aItemTextArray,
CAknIconArray * aIconArray
) [private]

Adds plugin data to listbox.

Parameters

CGSPluginInterface * aPlugin A plugin whose data is to be used.
TInt aIndex Index of the plugin in the listbox.
CDesCArray * aItemTextArray Array for plugin texts and format strings used by lbx.
CAknIconArray * aIconArray Array for icons used in lbx.

ComponentControl(TInt)

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

See base class.

Parameters

TInt

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

void ConstructL ( const TRect & aRect,
CAknViewAppUi * aAppUi,
CArrayPtrFlat < CGSPluginInterface > * aPluginArray
)

Symbian OS constructor. Required by the base class.

Parameters

const TRect & aRect
CAknViewAppUi * aAppUi
CArrayPtrFlat < CGSPluginInterface > * aPluginArray

CountComponentControls()

TInt CountComponentControls ( ) const [private, virtual]

See base class.

FocusChanged(TDrawNow)

void FocusChanged ( TDrawNow aDrawNow ) [virtual]

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

Parameters

TDrawNow aDrawNow

GetHelpContext(TCoeHelpContext &)

void GetHelpContext ( TCoeHelpContext & aContext ) const [protected, virtual]

Required for help.

Parameters

TCoeHelpContext & aContext

HandleListBoxEventL(CEikListBox *, TListBoxEvent)

void HandleListBoxEventL ( CEikListBox * aListBox,
TListBoxEvent aEventType
) [protected]

Handles listbox events.

Parameters

CEikListBox * aListBox Listbox where the event occurred.
TListBoxEvent aEventType Event type.

HandleResourceChange(TInt)

void HandleResourceChange ( TInt aType ) [virtual]

See base class.

Parameters

TInt aType

ListBox()

CAknSingleLargeStyleListBox * ListBox ( )

OfferKeyEventL(const TKeyEvent &, TEventCode)

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

See base class.

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

RestoreListBoxPositionL(const CGSMainView::TListBoxPosition &, TBool)

void RestoreListBoxPositionL ( const CGSMainView::TListBoxPosition & aPosition,
TBool aScreenModeChanged
)

Restore listbox's exact position.

Parameters

const CGSMainView::TListBoxPosition & aPosition includes the exact position of the listbox.
TBool aScreenModeChanged indicates whether the screen mode is changed.

SelectedPlugin()

CGSPluginInterface * SelectedPlugin ( )

SetListBoxEmptyTextL(const TDes &)

void SetListBoxEmptyTextL ( const TDes & aEmpty )

Set the empty text of list box.

Parameters

const TDes & aEmpty

SetSelectedItem(TUid)

void SetSelectedItem ( TUid aSelectedItemUid )

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

SizeChanged()

void SizeChanged ( ) [private, virtual]

See base class.

StoreListBoxPositionL(CGSMainView::TListBoxPosition &)

void StoreListBoxPositionL ( CGSMainView::TListBoxPosition & aPosition )

Store listbox's exact position.

Parameters

CGSMainView::TListBoxPosition & aPosition includes the exact position of the listbox.

UpdateListBoxL()

void UpdateListBoxL ( )

Updates listbox.

Member Data Documentation

CAknViewAppUi * iAppUi

CAknViewAppUi * iAppUi [private]

CGsContainerExt * iExt

CGsContainerExt * iExt [private]

CDesCArray * iItemTextArray

CDesCArray * iItemTextArray [private]

Pointer to listbox model's item texts. Note that the indexes of listbox items are mapped directly to the indexes in plugin array. Plugin which maps to selected listbox item index in plugin array is activated when item is selected in listbox.

Owned by iListBox.

CAknSingleLargeStyleListBox * iListBox

CAknSingleLargeStyleListBox * iListBox [private]

CArrayPtrFlat< CGSPluginInterface > * iPluginArray

CArrayPtrFlat < CGSPluginInterface > * iPluginArray [private]

CArrayPtrFlat< CGSPluginInterface > * iVisiblePlugins

CArrayPtrFlat < CGSPluginInterface > * iVisiblePlugins [private]