Collapse all Symbian^3 Product Developer Library

CGSBaseView Class Reference

class CGSBaseView : public CGSPluginInterface

CGSBaseView view class Base class for GS plugin views.

GSFramework.lib

Since: Series60_3.1

Inherits from

CGSBaseView
- CGSPluginInterface
  - CAknView
    - CBase

Public Member Functions
	CGSBaseView()
	~CGSBaseView()
IMPORT_C void	ConstructL()
IMPORT_C CGSBaseContainer *	Container()
IMPORT_C void	DoActivateL(const TVwsViewId &, TUid, const TDesC8 &)
IMPORT_C void	DoDeactivate()
IMPORT_C void	OpenLocalizedResourceFileL(const TDesC &, RConeResourceLoader &)
IMPORT_C void	ResetSelectedItemIndex()
IMPORT_C void	SetCurrentItem(TInt)

Protected Member Functions
IMPORT_C void	CreateContainerL()
IMPORT_C void	CreateNaviPaneContextL(TInt)
void	HandleClientRectChange()
void	HandleListBoxEventL(CEikListBox *, TListBoxEvent)
IMPORT_C void	NewContainerL()
IMPORT_C void	SetNaviPaneL()

Private Member Functions
void	HandleListBoxSelectionL()
CAknNavigationControlContainer *	NaviControlContainerL()

Inherited Functions
	CAknView::ActivateViewL(const TVwsViewId &)
	CAknView::ActivateViewL(const TVwsViewId &,TUid,const TDesC8 &)
	CAknView::AknViewActivatedL(const TVwsViewId &,TUid,const TDesC8 &)
	CAknView::AknViewDeactivated()
	CAknView::AppUi()const
	CAknView::BaseConstructL(TInt)
	CAknView::CAknView()
	CAknView::Cba()const
	CAknView::ClientRect()const
	CAknView::ConstructMenuAndCbaEarlyL()
	CAknView::CreateAndSetToolbarL(TInt)
	CAknView::HandleCommandL(TInt)
	CAknView::HandleForegroundEventL(TBool)
	CAknView::HandleStatusPaneSizeChange()
	CAknView::HandleViewRectChange()
	CAknView::Id()const
	CAknView::IsForeground()const
	CAknView::MenuBar()const
	CAknView::MopNext()
	CAknView::MopSupplyObject(TTypeUid)
	CAknView::ProcessCommandL(TInt)
	CAknView::ProcessForegroundEventL(TBool)
	CAknView::Redraw()const
	CAknView::SaveToolbarStatus(TBool,TBool)
	CAknView::SetEmphasis(CCoeControl *,TBool)
	CAknView::SetToolbar(CAknToolbar *)
	CAknView::ShowToolbarOnViewActivation(TBool)
	CAknView::StatusPane()const
	CAknView::StopDisplayingMenuBar()
	CAknView::StopDisplayingToolbar()
	CAknView::Toolbar()const
	CAknView::ToolbarShownOnViewActivation()const
	CAknView::ViewActivatedL(const TVwsViewId &,TUid,const TDesC8 &)
	CAknView::ViewDeactivated()
	CAknView::ViewId()const
	CAknView::ViewScreenDeviceChangedL()
	CAknView::~CAknView()
	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()
	CGSPluginInterface::CGSPluginInterface()
	CGSPluginInterface::CreateIconL(const TUid)
	CGSPluginInterface::CustomOperationL(TAny ,TAny )
	CGSPluginInterface::GetCaptionL(TDes &)const
	CGSPluginInterface::GetEcomDestructorKey()
	CGSPluginInterface::GetValue(const TGSPluginValueKeys,TDes &)
	CGSPluginInterface::HandleSelection(const TGSSelectionTypes)
	CGSPluginInterface::ItemType()
	CGSPluginInterface::MenuActivationItem()
	CGSPluginInterface::NewL(const TUid,TAny *)
	CGSPluginInterface::PluginProviderCategory()const
	CGSPluginInterface::SetOrder(TInt)
	CGSPluginInterface::Visible()const
	CGSPluginInterface::~CGSPluginInterface()

Public Member Enumerations
enum	KGSViewPanicCodes { EGSViewPanicNullPtr = 1 }

Inherited Enumerations
	CGSPluginInterface:TGSPluginProviderCategory

Public Attributes
TVwsViewId	iPrevViewId

Protected Attributes
CAknViewAppUi *	iAppUi
CGSBaseContainer *	iContainer
TInt	iCurrentItem
TBool	iElaf
CAknNavigationControlContainer *	iNaviControlContainer
CAknNavigationDecorator *	iNaviPaneContext
RConeResourceLoader	iResourceLoader
TInt	iTopItemIndex

Inherited Attributes
	CAknView::iCoeEnv

Constructor & Destructor Documentation

CGSBaseView()

IMPORT_C

CGSBaseView

(

)

C++ default constructor

~CGSBaseView()

IMPORT_C

~CGSBaseView

(

)

Destructor.

Member Functions Documentation

ConstructL()

IMPORT_C void

ConstructL

(

)

[pure virtual]

Symbian OS default constructor.

Container()

IMPORT_C CGSBaseContainer *

Container

(

)

Returns the container this view has.

CreateContainerL()

IMPORT_C void

CreateContainerL

(

)

[protected, virtual]

Creates container,

CreateNaviPaneContextL(TInt)

IMPORT_C void

CreateNaviPaneContextL

(

TInt

aResourceId

)

[protected, virtual]

Creates context for view's navi pane.

Parameters

TInt aResourceId

Resource id for navi pane context's resource.

DoActivateL(const TVwsViewId &, TUid, const TDesC8 &)

IMPORT_C void	DoActivateL	(	const TVwsViewId &	aPrevViewId,
			TUid	,
			const TDesC8 &
		)	[virtual]

See base class.

Parameters

const TVwsViewId & aPrevViewId
TUid
const TDesC8 &

DoDeactivate()

IMPORT_C void

DoDeactivate

(

)

[virtual]

See base class.

HandleClientRectChange()

void

HandleClientRectChange

(

)

[protected]

See base class.

HandleListBoxEventL(CEikListBox *, TListBoxEvent)

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

See base class.

Parameters

CEikListBox * aListBox
TListBoxEvent aEventType

HandleListBoxSelectionL()

void

HandleListBoxSelectionL

(

)

[private, pure virtual]

Handles listbox selection. Called by HandleListBoxEventL. Implement by sub-class.

NaviControlContainerL()

CAknNavigationControlContainer *

NaviControlContainerL

(

)

[private]

Creates navi control container when needed

NewContainerL()

IMPORT_C void

NewContainerL

(

)

[protected, pure virtual]

Functionality for creating a container. Called by DoActivateL(). Implemented by sub-class.

OpenLocalizedResourceFileL(const TDesC &, RConeResourceLoader &)

IMPORT_C void	OpenLocalizedResourceFileL	(	const TDesC &	aResourceFileName,
			RConeResourceLoader &	aResourceLoader
		)

Opens the nearest localized resourcefile using aResourceLoader. aResourceLoader should be opened only once before closing it. Otherwise it will raise a panic. Therefore it is better to have multiple resource loaders. Uses KDC_RESOURCE_FILES_DIR.

Parameters

const TDesC & aResourceFileName	Drive and name of resource file in format <path>:<rsc_file_name>
RConeResourceLoader & aResourceLoader	Resource loader for the resource. The loader must not be opened allready or it will raise a panic. It is caller's responsibility to close the resource loader after using the resource.

ResetSelectedItemIndex()

IMPORT_C void

ResetSelectedItemIndex

(

)

[virtual]

See base class.

SetCurrentItem(TInt)

IMPORT_C void

SetCurrentItem

(

TInt

aIndex = 0

)

[virtual]

This function is used to set the current item in the listbox.

Parameters

TInt aIndex = 0

Current item. Default value is 0 i.e. the first item of the list.

SetNaviPaneL()

IMPORT_C void

SetNaviPaneL

(

)

[protected, virtual]

Sets the correct navi pane for the view (eg. tabs, string etc.).

Member Enumerations Documentation

Enum KGSViewPanicCodes

Enumerators

EGSViewPanicNullPtr = 1

Member Data Documentation

CAknViewAppUi * iAppUi

CAknViewAppUi *

iAppUi

[protected]

CGSBaseContainer * iContainer

CGSBaseContainer *

iContainer

[protected]

TInt iCurrentItem

TInt

iCurrentItem

[protected]

TBool iElaf

TBool

iElaf

[protected]

CAknNavigationControlContainer * iNaviControlContainer

CAknNavigationControlContainer *

iNaviControlContainer

[protected]

CAknNavigationDecorator * iNaviPaneContext

CAknNavigationDecorator *

iNaviPaneContext

[protected]

TVwsViewId iPrevViewId

TVwsViewId

iPrevViewId

RConeResourceLoader iResourceLoader

RConeResourceLoader

iResourceLoader

[protected]

TInt iTopItemIndex

TInt

iTopItemIndex

[protected]