MPtiUserDictionary Class Reference

API published in: S60 3rd Ed

Link against: ptiengine.lib

Capability Information

Required Capabilities

None

#include <ptiuserdictionary.h>

Inherited by CPtiUserDictionary.

Detailed Description

A base class for PtiEngine user dictionary implementations.

Normally not needed by a client side application.


Public Member Functions
virtual TInt	Id () const =0
	Returns user dictionary id value.
virtual TInt	Size () const =0
	Returns size of user dictionary.
virtual TInt32	CoreUID () const =0
	Returns Uid for core DLL.
virtual TBool	IsDefault () const =0
	Returns a boolean value indicating whether this is the default user dictionary.
virtual TPtrC	FileName () const =0
	Reuturns user dictionary file name.
virtual TInt	SpaceLeft () const =0
	Returns the amount of free space in user dictionary.
virtual TBool	UpdateFlag () const =0
	If this flag is set, PtiEngine framework calls WriteL before exiting.
virtual void	SetUpdateFlag (TBool aFlag)=0
	Set update flag to given value.

Member Function Documentation

virtual TInt32 MPtiUserDictionary::CoreUID ( ) const [pure virtual]

Returns Uid for core DLL.

Returns:: Uid value for core DLL.

Implemented in CPtiUserDictionary.

virtual TPtrC MPtiUserDictionary::FileName ( ) const [pure virtual]

Reuturns user dictionary file name.

Returns:: User dictionary file name.

Implemented in CPtiUserDictionary.

virtual TInt MPtiUserDictionary::Id ( ) const [pure virtual]

Returns user dictionary id value.

Returns:: User dictionary id value.

Implemented in CPtiUserDictionary.

virtual TBool MPtiUserDictionary::IsDefault ( ) const [pure 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.

Implemented in CPtiUserDictionary.

virtual void MPtiUserDictionary::SetUpdateFlag ( TBool aFlag ) [pure virtual]

Set update flag to given value.

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

Parameters:

aFlag

New status for the update flag.

Implemented in CPtiUserDictionary.

virtual TInt MPtiUserDictionary::Size ( ) const [pure virtual]

Returns size of user dictionary.

Returns:: Size of user dictionary.

Implemented in CPtiUserDictionary.

virtual TInt MPtiUserDictionary::SpaceLeft ( ) const [pure 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.

Implemented in CPtiUserDictionary.

virtual TBool MPtiUserDictionary::UpdateFlag ( ) const [pure virtual]

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

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

Implemented in CPtiUserDictionary.

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

ptiuserdictionary.h

Copyright © Nokia Corporation 2001-2008