Collapse all Symbian^3 Application Developer Library

CSearchDocumentId Class Reference

class CSearchDocumentId : public CBase

This class references to a unique document matching the search criteria

searchutilities.lib

Inherits from

CSearchDocumentId
- CBase

Public Member Functions
	~CSearchDocumentId ()
IMPORT_C const TInt	DocumentId ()
IMPORT_C void	ExternalizeL ( RWriteStream &)
IMPORT_C CSearchDocumentId *	NewL (const TInt , TUid )
IMPORT_C CSearchDocumentId *	NewL (const CSearchDocumentId &)
IMPORT_C CSearchDocumentId *	NewL ( RReadStream &)
IMPORT_C TUid	PluginId ()
IMPORT_C const TInt32	RepositoryId ()
IMPORT_C void	SetRepositoryIdL (const TInt32 )

Private Member Functions
	CSearchDocumentId ( TUid )
void	ConstructL (const TInt )
void	ConstructL (const TInt32 , const TInt )
void	ConstructL ( RReadStream &)

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

Private Attributes
TInt	iDocumentId
TUid	iPluginId
TInt32	iRepositoryId

Constructor & Destructor Documentation

CSearchDocumentId(TUid)

CSearchDocumentId

(

TUid

aPluginId

)

[private]

Default Constructor

Parameters

TUid aPluginId

~CSearchDocumentId()

~CSearchDocumentId

(

)

[virtual]

Destructor

Member Functions Documentation

ConstructL(const TInt)

void

ConstructL

(

const TInt

aDocumentId

)

[private]

ConstructL function that sets document id and repository ids that are taken as args.

Parameters

const TInt aDocumentId

- Document id

ConstructL(const TInt32, const TInt)

void	ConstructL	(	const TInt32	aRepositoryId,
			const TInt	aDocumentId
		)	[private]

ConstructL function that sets document id and repository ids that are taken as args.

Parameters

const TInt32 aRepositoryId	- Repository id
const TInt aDocumentId	- Document id

ConstructL(RReadStream &)

void

ConstructL

(

RReadStream &

aStream

)

[private]

ConstructL function that initializes the RepositoryId and DocumentId of the class read from aStream which is passed as an argument

Parameters

RReadStream & aStream

- Stream from where to read

DocumentId()

IMPORT_C const TInt

DocumentId

(

)

const

Getter function for the DocumentId of the CSearchDocumentId

ExternalizeL(RWriteStream &)

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalizes the CSearchDocumentId class to the stream

Parameters

RWriteStream & aStream

- Stream to which to write the class data to

NewL(const TInt, TUid)

IMPORT_C CSearchDocumentId *	NewL	(	const TInt	aDocumentId,
			TUid	aPluginId
		)	[static]

Two phased constructor

Parameters

const TInt aDocumentId	- Document id of the Document
TUid aPluginId	- Plugin id of the Document

NewL(const CSearchDocumentId &)

IMPORT_C CSearchDocumentId *

NewL

(

const CSearchDocumentId &

aDocumentId

)

[static]

Two phased constructor

Parameters

const CSearchDocumentId & aDocumentId

- CSearchDocument from which the CSearchDocument is to be instantiated

NewL(RReadStream &)

IMPORT_C CSearchDocumentId *

NewL

(

RReadStream &

aStream

)

[static]

Two phased constructor

Parameters

RReadStream & aStream

- Stream from which to construct the CSearchDocumentId object

PluginId()

IMPORT_C TUid

PluginId

(

)

const

Getter function for the pluginId of the CSearchDocumentId

RepositoryId()

IMPORT_C const TInt32

RepositoryId

(

)

const

Getter function for the RepositoryId of the CSearchDocumentId

SetRepositoryIdL(const TInt32)

IMPORT_C void

SetRepositoryIdL

(

const TInt32

aRepositoryId

)

Sets the repository id

Parameters

const TInt32 aRepositoryId

Member Data Documentation

TInt iDocumentId

TInt

iDocumentId

[private]

Document Id Own

TUid iPluginId

TUid

iPluginId

[private]

Plugin Id

TInt32 iRepositoryId

TInt32

iRepositoryId

[private]

Repository Id