Collapse all Symbian^3 Product Developer Library

MAiContentObserver Class Reference

class MAiContentObserver

Used by AI Plug-in to give notification about modifications in content and/or internal state.

Since: S60 3.2

Public Member Functions
TBool	CanPublish(CHsContentPublisher &, TInt, TInt)
TInt	CancelTransaction(TInt)
TInt	Clean(CHsContentPublisher &, TInt, TInt)
TInt	Commit(TInt)
TAny *	Extension(TUid)
TInt	Publish(CHsContentPublisher &, TInt, TInt, TInt)
TInt	Publish(CHsContentPublisher &, TInt, const TDesC16 &, TInt)
TInt	Publish(CHsContentPublisher &, TInt, const TDesC8 &, TInt)
TInt	Publish(CHsContentPublisher &, TInt, RFile &, TInt)
TInt	PublishPtr(CHsContentPublisher &, TInt, TAny *, TInt)
TBool	RequiresSubscription(const THsPublisherInfo &)
TInt	SetProperty(CHsContentPublisher &, const TDesC8 &, const TDesC8 &, const TDesC8 &)
TInt	SetProperty(CHsContentPublisher &, const TDesC8 &, const TDesC8 &, const TDesC8 &, MAiContentObserver::TValueType)
TInt	StartTransaction(TInt)
PtrT *	UnpackPtr(const TDesC8 &)

Protected Member Functions
	~MAiContentObserver()

Public Member Enumerations
enum	TValueType { EValueUnknown = 0, EValueNumber, EValuePercentage, EValuePx, EValueDimension, EValueString, EValueIdent, EValueAttr, EValueCounter, EValueRect, EValueRgbColor, EValueRgbaColor, EValueFunction, EValueUnitValue }

Constructor & Destructor Documentation

~MAiContentObserver()

~MAiContentObserver

(

)

[protected, inline]

Protected destructor prevents deletion through this interface.

Member Functions Documentation

CanPublish(CHsContentPublisher &, TInt, TInt)

TBool	CanPublish	(	CHsContentPublisher &	aPlugin,
			TInt	aContent,
			TInt	aIndex
		)	[pure virtual]

Invoked by plug-in to test if the specified content can be published.

Parameters

CHsContentPublisher & aPlugin	- Plug-in interface implementation.
TInt aContent	- identification of content selector, MUST correspond single content selector supported by plug-in. The framework utilizes the selector id to match for cid and MIME type.
TInt aIndex	- index of the content item.

CancelTransaction(TInt)

TInt

CancelTransaction

(

TInt

aTxId

)

[pure virtual]

Invoked by plug-in to indicate that content publishing transaction must be cancelled.

Parameters

TInt aTxId

- transaction Id

Clean(CHsContentPublisher &, TInt, TInt)

TInt	Clean	(	CHsContentPublisher &	aPlugin,
			TInt	aContent,
			TInt	aIndex
		)	[pure virtual]

Invoked by the plug-in to inform that content must be cleaned in UI control identified by selector aContent.

Parameters

CHsContentPublisher & aPlugin	- Plug-in interface implementation.
TInt aContent	- identification of content selector, MUST correspond single content selector supported by plug-in. The framework utilizes the selector id to match for cid and MIME type.
TInt aIndex	- index of the content item.

Commit(TInt)

TInt

Commit

(

TInt

aTxId

)

[pure virtual]

Invoked by the plug-in to request framework that content publishing transaction must be finalized and content should be rendered to the screen.

Parameters

TInt aTxId

- transaction Id

Extension(TUid)

TAny *

Extension

(

TUid

aUid

)

[pure virtual]

Returns interface extension. Not used in S60 3.2 release.

Parameters

TUid aUid

- UID of the extension interface to access.

Publish(CHsContentPublisher &, TInt, TInt, TInt)

TInt	Publish	(	CHsContentPublisher &	aPlugin,
			TInt	aContent,
			TInt	aResource,
			TInt	aIndex
		)	[pure virtual]

Invoked by the plug-in to inform that content identified by reference aResource must be published to UI control identified by selector aContent.

Parameters

CHsContentPublisher & aPlugin	- Plug-in interface implementation.
TInt aContent	- identification of content selector, MUST correspond single content selector supported by plug-in. The framework utilizes the selector id to match for cid and MIME type.
TInt aResource	- identification of content reference, MUST correspond single content reference supported by plug-in. The framework utilizes the reference if to match for cid and MIME type of the content supplied with in UI definition.
TInt aIndex	- index of the content item.

Publish(CHsContentPublisher &, TInt, const TDesC16 &, TInt)

TInt	Publish	(	CHsContentPublisher &	aPlugin,
			TInt	aContent,
			const TDesC16 &	aText,
			TInt	aIndex
		)	[pure virtual]

Invoked by the plug-in to inform that textual content provided within parameter aText must be published to UI control identified by selector aContent.

Parameters

CHsContentPublisher & aPlugin	- Plug-in interface implementation.
TInt aContent	- identification of content selector, MUST correspond single content selector supported by plug-in. The framework utilizes the selector id to match for cid and MIME type.
const TDesC16 & aText	- Textual content in UNICODE.
TInt aIndex	- index of the content item.

Publish(CHsContentPublisher &, TInt, const TDesC8 &, TInt)

TInt	Publish	(	CHsContentPublisher &	aPlugin,
			TInt	aContent,
			const TDesC8 &	aBuf,
			TInt	aIndex
		)	[pure virtual]

Invoked by the plug-in to inform that content provided within buffer aBuf must be published to UI control identified by selector aContent.

Parameters

CHsContentPublisher & aPlugin	- Plug-in interface implementation.
TInt aContent	- identification of content selector, MUST correspond single content selector supported by plug-in. The framework utilizes the selector id to match for cid and MIME type.
const TDesC8 & aBuf	- instance of content.
TInt aIndex	- index of the content item.

Publish(CHsContentPublisher &, TInt, RFile &, TInt)

TInt	Publish	(	CHsContentPublisher &	aPlugin,
			TInt	aContent,
			RFile &	aFile,
			TInt	aIndex
		)	[pure virtual]

Invoked by the plug-in to inform that content from file handle aFile must be published to UI control identified by selector aContent.

Parameters

CHsContentPublisher & aPlugin	- Plug-in interface implementation.
TInt aContent	- identification of content selector, MUST correspond single content selector supported by plug-in. The framework utilizes the selector id to match for cid and MIME type.
RFile & aFile	- file handle from where content can be obtained by UI framework.
TInt aIndex	- index of the content item.

PublishPtr(CHsContentPublisher &, TInt, TAny *, TInt)

TInt	PublishPtr	(	CHsContentPublisher &	aPlugin,
			TInt	aContent,
			TAny *	aPtr,
			TInt	aIndex
		)	[inline]

Invoked by the plug-in to inform that an object provided by pointer aPtr must be published to UI control identified by selector aContent. The implementation packages the pointer to a buffer and delegates to buffer publishing method Publish(MAiPropertyExtension&, TInt, const TDesC8&, TInt).

KAiContentTypeBitmap

Parameters

CHsContentPublisher & aPlugin	- Plug-in interface implementation.
TInt aContent	- identification of content selector, MUST correspond single content selector supported by plug-in. The framework utilizes the selector id to match for cid and MIME type.
TAny * aPtr	- pointer to the content object. The actual type of the pointer is deduced based on the MIME type of the content item identified by aContent.
TInt aIndex	- index of the content item.

RequiresSubscription(const THsPublisherInfo &)

TBool

RequiresSubscription

(

const THsPublisherInfo &

aPublisherInfo

)

const [pure virtual]

Invoked by the plugin factory

Parameters

const THsPublisherInfo & aPublisherInfo

SetProperty(CHsContentPublisher &, const TDesC8 &, const TDesC8 &, const TDesC8 &)

TInt	SetProperty	(	CHsContentPublisher &	aPlugin,
			const TDesC8 &	aElementId,
			const TDesC8 &	aPropertyName,
			const TDesC8 &	aPropertyValue
		)	[pure virtual]

Invoked by the plug-in to change the property value of a specific content. value type must be string.

Parameters

CHsContentPublisher & aPlugin	- Plug-in interface implementation.
const TDesC8 & aElementId	- id of content selector, MUST correspond single content supported by plug-in. The framework utilizes the id to find in the plugin xml defintion.
const TDesC8 & aPropertyName	- property name.
const TDesC8 & aPropertyValue	- property value.

SetProperty(CHsContentPublisher &, const TDesC8 &, const TDesC8 &, const TDesC8 &, MAiContentObserver::TValueType)

TInt	SetProperty	(	CHsContentPublisher &	aPlugin,
			const TDesC8 &	aElementId,
			const TDesC8 &	aPropertyName,
			const TDesC8 &	aPropertyValue,
			MAiContentObserver::TValueType	aValueType
		)	[pure virtual]

Invoked by the plug-in to change the property value of a specific content.

Parameters

CHsContentPublisher & aPlugin	- Plug-in interface implementation.
const TDesC8 & aElementId	- id of content selector, MUST correspond single content supported by plug-in. The framework utilizes the id to find in the plugin xml defintion.
const TDesC8 & aPropertyName	- property name.
const TDesC8 & aPropertyValue	- property value.
MAiContentObserver::TValueType aValueType	- value type.

StartTransaction(TInt)

TInt

StartTransaction

(

TInt

aTxId

)

[pure virtual]

Invoked by the plug-in to inform that it initiates content publishing transaction.

Parameters

TInt aTxId

- transaction Id

UnpackPtr(const TDesC8 &)

PtrT *

UnpackPtr

(

const TDesC8 &

aBuf

)

[static, inline]

Helper function for unpacking a pointer that has been published with MAiContentObserver::PublishPtr.

MAiContentObserver::PublishPtr

Parameters

const TDesC8 & aBuf

Member Enumerations Documentation

Enum TValueType

Value type for SetProperty

Since: S60 5.2

Enumerators

EValueUnknown = 0
EValueNumber
EValuePercentage
EValuePx
EValueDimension
EValueString
EValueIdent
EValueAttr
EValueCounter
EValueRect
EValueRgbColor
EValueRgbaColor
EValueFunction
EValueUnitValue