MPtiUserDictionary Class Reference

#include <mw/PtiUserDictionary.h>

class MPtiUserDictionary
Public Member Functions
pure virtual TInt32 CoreUID()
pure virtual TPtrC FileName()
pure virtual TInt Id()
pure virtual TBool IsDefault()
pure virtual voidSetUpdateFlag(TBool)
pure virtual TInt Size()
pure virtual TInt SpaceLeft()
pure virtual TBool UpdateFlag()

Detailed Description

A base class for PtiEngine user dictionary implementations. Normally not needed by a client side application.

Member Function Documentation

CoreUID ( )

TInt32 CoreUID()const [pure virtual]

Returns Uid for core DLL.

Since
S60 V2.6

Returns: Uid value for core DLL.

FileName ( )

TPtrC FileName()const [pure virtual]

Reuturns user dictionary file name.

Since
S60 V2.6

Returns: User dictionary file name.

Id ( )

TInt Id()const [pure virtual]

Returns user dictionary id value.

Since
S60 V2.6

Returns: User dictionary id value.

IsDefault ( )

TBool IsDefault()const [pure virtual]

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

Since
S60 V2.6

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

SetUpdateFlag ( TBool )

voidSetUpdateFlag(TBoolaFlag)[pure virtual]

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

Since
S60 V2.6
ParameterDescription
aFlagNew status for the update flag.

Size ( )

TInt Size()const [pure virtual]

Returns size of user dictionary.

Since
S60 V2.6

Returns: Size of user dictionary.

SpaceLeft ( )

TInt SpaceLeft()const [pure virtual]

Returns the amount of free space in user dictionary.

Since
S60 V2.6

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

UpdateFlag ( )

TBool UpdateFlag()const [pure virtual]

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

Since
S60 V2.6

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