Collapse all Symbian^3 Application Developer Library

MHsContentController Class Reference

class MHsContentController

Content controller interface defining the interface to modify Home screen content.

Since: S60 v5.2

Public Member Functions
TInt	ActivateAppL ( CHsContentInfo &)
TInt	ActivateViewL ( CHsContentInfo &)
TInt	ActiveAppL ( CHsContentInfo &)
TInt	ActiveViewL ( CHsContentInfo &)
TInt	AddViewL ( CHsContentInfo &)
TInt	AddWidgetL ( CHsContentInfo &)
TInt	AppListL ( CHsContentInfoArray &)
TInt	RemoveViewL ( CHsContentInfo &)
TInt	RemoveWidgetL ( CHsContentInfo &)
TInt	ViewListL ( CHsContentInfoArray &)
TInt	ViewListL ( CHsContentInfo &, CHsContentInfoArray &)
TInt	WidgetListL ( CHsContentInfoArray &)
TInt	WidgetListL ( CHsContentInfo &, CHsContentInfoArray &)

Member Functions Documentation

ActivateAppL(CHsContentInfo &)

TInt

ActivateAppL

(

CHsContentInfo &

aInfo

)

[pure virtual]

Activates the Home screen application configuration

Since: S60 v5.2

Parameters

CHsContentInfo & aInfo

Application configuration request to be activated

ActivateViewL(CHsContentInfo &)

TInt

ActivateViewL

(

CHsContentInfo &

aInfo

)

[pure virtual]

Activates the Home screen view

Since: S60 v5.2

Parameters

CHsContentInfo & aInfo

View request to be activated

ActiveAppL(CHsContentInfo &)

TInt

ActiveAppL

(

CHsContentInfo &

aInfo

)

[pure virtual]

Returns the active Home screen application configuration

Since: S60 v5.2

Parameters

CHsContentInfo & aInfo

Active application configuration

ActiveViewL(CHsContentInfo &)

TInt

ActiveViewL

(

CHsContentInfo &

aInfo

)

[pure virtual]

Returns the active Home screen view

Since: S60 v5.2

Parameters

CHsContentInfo & aInfo

Active view

AddViewL(CHsContentInfo &)

TInt

AddViewL

(

CHsContentInfo &

aInfo

)

[pure virtual]

Adds a view to the active Home screen application configuration.

Since: S60 v5.2

Parameters

CHsContentInfo & aInfo

View request to be added

AddWidgetL(CHsContentInfo &)

TInt

AddWidgetL

(

CHsContentInfo &

aInfo

)

[pure virtual]

Adds a widget to the active Home screen view.

Since: S60 v5.2

Parameters

CHsContentInfo & aInfo

Widget request to be added

AppListL(CHsContentInfoArray &)

TInt

AppListL

(

CHsContentInfoArray &

aArray

)

[pure virtual]

Returns the list of available Home screen application configurations

Since: S60 v5.2

Parameters

CHsContentInfoArray & aArray

List of application configurations

RemoveViewL(CHsContentInfo &)

TInt

RemoveViewL

(

CHsContentInfo &

aInfo

)

[pure virtual]

Removes a view from the configuration.

Since: S60 v5.2

Parameters

CHsContentInfo & aInfo

View request to be removed

RemoveWidgetL(CHsContentInfo &)

TInt

RemoveWidgetL

(

CHsContentInfo &

aInfo

)

[pure virtual]

Removes a widget from the configuration.

Since: S60 v5.2

Parameters

CHsContentInfo & aInfo

Widget request to be removed

ViewListL(CHsContentInfoArray &)

TInt

ViewListL

(

CHsContentInfoArray &

aArray

)

[pure virtual]

Returns the list of available Home screen views

Since: S60 v5.2

Parameters

CHsContentInfoArray & aArray

List of views

ViewListL(CHsContentInfo &, CHsContentInfoArray &)

TInt	ViewListL	(	CHsContentInfo &	aInfo,
			CHsContentInfoArray &	aArray
		)	[pure virtual]

Returns the list of available Home screen views included in an application configuration

Since: S60 v5.2

Parameters

CHsContentInfo & aInfo	Content info defining the application configuration
CHsContentInfoArray & aArray	List of views

WidgetListL(CHsContentInfoArray &)

TInt

WidgetListL

(

CHsContentInfoArray &

aArray

)

[pure virtual]

Returns the list of available Home screen widgets

Since: S60 v5.2

Parameters

CHsContentInfoArray & aArray

List of widgets

WidgetListL(CHsContentInfo &, CHsContentInfoArray &)

TInt	WidgetListL	(	CHsContentInfo &	aInfo,
			CHsContentInfoArray &	aArray
		)	[pure virtual]

Returns the list of Home screen widgets included in an application configuration or a view

Since: S60 v5.2

Parameters

CHsContentInfo & aInfo	Content info defining the application configuration or the view which widget list is requested
CHsContentInfoArray & aArray	List of widgets