CPtiUserDictionary Class Reference

API published in: S60 3rd Ed

Link against: ptiengine.lib

Capability Information

Required Capabilities

None

#include <ptiuserdictionary.h>

Inherits MPtiUserDictionary.


Public Member Functions
virtual IMPORT_C	~CPtiUserDictionary ()
virtual IMPORT_C TInt	OpenL (TDesC &aFileName, TInt aMaxSize)
virtual IMPORT_C TInt	WriteL (TDesC &aFileName)
virtual IMPORT_C TInt	WriteL ()
void	SetFileName (TDesC &aFileName)
TInt	Id () const
	Returns user dictionary id value.
void	SetId (TInt aId)
TInt	Size () const
	Returns size of user dictionary.
TInt32	CoreUID () const
	Returns Uid for core DLL.
void	SetCoreUID (TInt32 aUid)
virtual TPtr8	Data ()
TBool	IsDefault () const
	Returns a boolean value indicating whether this is the default user dictionary.
void	SetDefault (TBool aValue)
TPtrC	FileName () const
	Reuturns user dictionary file name.
TBool	UpdateFlag () const
	If this flag is set, PtiEngine framework calls WriteL before exiting.
void	SetUpdateFlag (TBool aFlag)
	Set update flag to given value.
TInt	SymbolClass () const
void	SetSymbolClass (TInt aSymbolClass)
virtual IMPORT_C TInt	SpaceLeft () const
	Returns the amount of free space in user dictionary.
virtual IMPORT_C void	SetDataL (TAny *aData, TInt aLength)
Static Public Member Functions
static IMPORT_C CPtiUserDictionary *	NewL (TInt aMaxSize)
static IMPORT_C CPtiUserDictionary *	NewL (TDesC &aFileName, TInt aMaxSize)
Protected Member Functions
IMPORT_C	CPtiUserDictionary ()
Protected Attributes
TFileName	iFileName
HBufC8 *	iData
TInt	iId
TInt32	iCoreUID
TBool	iDefault
TBool	iUpdateFlag
TInt	iSymbolClass
TUint32	iChecksum

Constructor & Destructor Documentation

virtual IMPORT_C CPtiUserDictionary::~CPtiUserDictionary ( ) [virtual]

IMPORT_C CPtiUserDictionary::CPtiUserDictionary ( ) [protected]

Member Function Documentation

TInt32 CPtiUserDictionary::CoreUID ( ) const [inline, virtual]

Returns Uid for core DLL.

Returns:: Uid value for core DLL.

Implements MPtiUserDictionary.

virtual TPtr8 CPtiUserDictionary::Data ( ) [inline, virtual]

TPtrC CPtiUserDictionary::FileName ( ) const [inline, virtual]

Reuturns user dictionary file name.

Returns:: User dictionary file name.

Implements MPtiUserDictionary.

TInt CPtiUserDictionary::Id ( ) const [inline, virtual]

Returns user dictionary id value.

Returns:: User dictionary id value.

Implements MPtiUserDictionary.

TBool CPtiUserDictionary::IsDefault ( ) const [inline, virtual]

Returns a boolean value indicating whether this is the default user dictionary.

Returns:: ETrue if this user dictionary is default user dictionary. EFalse if not.

Implements MPtiUserDictionary.

static IMPORT_C CPtiUserDictionary* CPtiUserDictionary::NewL	(	TDesC &	aFileName,
		TInt	aMaxSize
	)	`[static]`

static IMPORT_C CPtiUserDictionary* CPtiUserDictionary::NewL ( TInt aMaxSize ) [static]

virtual IMPORT_C TInt CPtiUserDictionary::OpenL	(	TDesC &	aFileName,
		TInt	aMaxSize
	)	`[virtual]`

void CPtiUserDictionary::SetCoreUID ( TInt32 aUid ) [inline]

virtual IMPORT_C void CPtiUserDictionary::SetDataL	(	TAny *	aData,
		TInt	aLength
	)	`[virtual]`

void CPtiUserDictionary::SetDefault ( TBool aValue ) [inline]

void CPtiUserDictionary::SetFileName ( TDesC & aFileName ) [inline]

void CPtiUserDictionary::SetId ( TInt aId ) [inline]

void CPtiUserDictionary::SetSymbolClass ( TInt aSymbolClass ) [inline]

void CPtiUserDictionary::SetUpdateFlag ( TBool aFlag ) [inline, virtual]

Set update flag to given value.

If update flag is set, PtiEngine tries to save user dictionary when PtiEngine destructor is called.

Parameters:

New status for the update flag.

Implements MPtiUserDictionary.

TInt CPtiUserDictionary::Size ( ) const [inline, virtual]

Returns size of user dictionary.

Returns:: Size of user dictionary.

Implements MPtiUserDictionary.

virtual IMPORT_C TInt CPtiUserDictionary::SpaceLeft ( ) const [virtual]

Returns the amount of free space in user dictionary.

Returns:: The Amount of free space in dictionary. Negative value if the amount of free space value couldn't be found out.

Implements MPtiUserDictionary.

TInt CPtiUserDictionary::SymbolClass ( ) const [inline]

TBool CPtiUserDictionary::UpdateFlag ( ) const [inline, virtual]

If this flag is set, PtiEngine framework calls WriteL before exiting.

Returns:: A boolean valua indicating status of the update flag.

Implements MPtiUserDictionary.

virtual IMPORT_C TInt CPtiUserDictionary::WriteL ( ) [virtual]

virtual IMPORT_C TInt CPtiUserDictionary::WriteL ( TDesC & aFileName ) [virtual]

Field Documentation

TUint32 CPtiUserDictionary::iChecksum [protected]

TInt32 CPtiUserDictionary::iCoreUID [protected]

HBufC8* CPtiUserDictionary::iData [protected]

TBool CPtiUserDictionary::iDefault [protected]

TFileName CPtiUserDictionary::iFileName [protected]

TInt CPtiUserDictionary::iId [protected]

TInt CPtiUserDictionary::iSymbolClass [protected]

TBool CPtiUserDictionary::iUpdateFlag [protected]

The documentation for this class was generated from the following file:

ptiuserdictionary.h

Copyright © Nokia Corporation 2001-2008