Collapse all Symbian^3 Application Developer Library

MXIMPBase Class Reference

class MXIMPBase

Base interface for XIMP Framework object interfaces.

All other XIMP Framework object interfaces inherit directly from MXIMPBase .
Future extended XIMP Framework interfaces may inherit also indirectly from MXIMPBase , by deriving from some current XIMP Framework interface, and extending the interface functionality with some new methods.
Each XIMP Framework object derives only once from MXIMPBase .

MXIMPBase::GetInterface() methods allows client to discover referencies to other interfaces that the object in question supports. MXIMPBase::GetInterfaceId() method lets client to discover the objects primary interface id.

Since: S60 v3.2

Public Member Functions
const TAny *	GetInterface ( TInt32 , TIfGetOps )
TAny *	GetInterface ( TInt32 , TIfGetOps )
TInt32	GetInterfaceId ()

Protected Member Functions
	~MXIMPBase ()

Public Member Enumerations
enum	anonymous { KInterfaceId = XIMP_IF_ID_BASE }
enum	TIfGetOps { EReturnNullIfUnknown = 0, EPanicIfUnknown }

Constructor & Destructor Documentation

~MXIMPBase()

~MXIMPBase

(

)

[protected, inline, virtual]

Protected destructor.

Concrete objects can't be deleted via base interface.

Member Functions Documentation

GetInterface(TInt32, TIfGetOps)

const TAny *	GetInterface	(	TInt32	aInterfaceId,
			TIfGetOps	aOps
		)	const [pure virtual]

Const interface query.

Interface query to access other XIMP Framework interfaces that the object in question supports. Returns const (read-only) interface. If unsupported interface type is tried to access, error is handle as defined by given aOps parameter.

NOTE: Client may use method directly, and cast returned TAny pointer to requested interface type. Or client optionally use templated TXIMPGetInterface helper to encapsulate interface query and type cast.

Parameters

TInt32 aInterfaceId	Interface identifier identifying the interface to retrieve.
TIfGetOps aOps	Options for interface query.

GetInterface(TInt32, TIfGetOps)

TAny *	GetInterface	(	TInt32	aInterfaceId,
			TIfGetOps	aOps
		)	[pure virtual]

Non-const interface query.

Interface query to access other XIMP Framework interfaces that the object in question supports. Returns modifiable (non-const) interface. If unsupported interface type is tried to access, error is handle as defined by given aOps parameter.

Parameters

TInt32 aInterfaceId	Interface identifier identifying the interface to retrieve.
TIfGetOps aOps	Options for interface query.

GetInterfaceId()

TInt32

GetInterfaceId

(

)

const [pure virtual]

Interface identifier access.

Method to access object interface identifier. Returns always objects "primary" interface id. Primary interface id, is the interface id of the MXIMPBase derived interface that object implements.

Member Enumerations Documentation

Enum anonymous

Interface ID for the MXIMPBase .

Enumerators

KInterfaceId = XIMP_IF_ID_BASE

Enum TIfGetOps

Options for interface resolving.

Client gives one of these options for interface resolving, to select which way the client wants to handle possible unknown interface.

Enumerators

EReturnNullIfUnknown = 0	Requestes the interface resolver to signal unknown interface by returning NULL.
EPanicIfUnknown	Requestes the interface resolver to signal unknown interface by raising a panic.