Collapse all Symbian^3 Product Developer Library

ContentAccess::CF32AgentUi Class Reference

class ContentAccess::CF32AgentUi : public CBase

Interface that must be implemented in order for the F32 agent to display information on the screen

Inherits from

ContentAccess::CF32AgentUi
- CBase

Public Member Functions
TBool	ConfirmDeleteL(const TDesC &)
void	DisplayInfoL(TInt, RFile &)
TInt	SetProperty(TInt, TInt)

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()

Member Functions Documentation

ConfirmDeleteL(const TDesC &)

TBool

ConfirmDeleteL

(

const TDesC &

aFileName

)

[pure virtual]

The implementation of this API will display a dialog asking the user to confirm deletion of a file. The implementation will display the dialog if the appropriate setting, TAgentProperty::EAgentPropertyAgentUI, has been set using CF32AgentUi::SetProperty, enabling the Agent UI. If the user selects to delete the file ETrue will be returned, EFalse if the file is not to be deleted. If the Agent UI is not enabled a default value of ETrue will be returned.

The function should only return once the dialog has completed

Parameters

const TDesC & aFileName

The name of the file that is about to be deleted

DisplayInfoL(TInt, RFile &)

void	DisplayInfoL	(	TInt	aInfo,
			RFile &	aFile
		)	[pure virtual]

Display information describing the supplied file

The file will already be open before calling this function. The function should only return once the dialog has completed

Parameters

TInt aInfo	The information to display, from ContentAccess::TDisplayInfo
RFile & aFile	The file to display

SetProperty(TInt, TInt)

TInt	SetProperty	(	TInt	aProperty,
			TInt	aValue
		)	[pure virtual]

The implementation of this API will action/remember Agent properties applicable to the Agent UI.

Currently the F32 Agent only supports one UI property - TAgentProperty::EAgentPropertyAgentUI, enabling or disabling the Agent UI. The implementation of this function should store the property that has been set and subsequent requests to the interface should be dealt with in accordance with these properties.

CF32AgentUi::ConfirmDeleteLThe implementation will return KErrNone if the property has been set correctly or KErrCANotSupported if the property supplied is not supported.

Parameters

TInt aProperty	The property to set, from ContentAccess::TAgentProperty
TInt aValue	The value of the property