MPtiEngineCompositionDataInterface Class Reference

API published in: S60 3rd Ed

Link against: ptiengine.lib

Capability Information

Required Capabilities

None

#include <pticompositiondataif.h>

Detailed Description

MPtiEngineCompositionDataInterface class.

This is a class which returned by CPtiEngine::CompositionData() API.


Public Types
enum	TPtiAttributeOfPhrase { EPtiAttributeTransitoryInput, EPtiAttributeNonTargetConvert, EPtiAttributeTargetConvert }
Public Member Functions
virtual IMPORT_C TInt	CursorPosition () const =0
	Gets a cursor position on converting string.
virtual IMPORT_C TInt	NumberOfPhrase () const =0
	Gets the number of phrases on converting string.
virtual IMPORT_C TPtrC8	LengthOfPhrase () const =0
	Gets the character count of each phrase.
virtual IMPORT_C TPtrC8	AttributeOfPhrase () const =0
	Gets the attribute of each phrase.
virtual IMPORT_C TPtrC	ConvertingString () const =0
	Gets the converting string.
virtual IMPORT_C TPtrC	CompletedString () const =0
	Gets the specified string.
virtual IMPORT_C TPtrC	ReadingString () const =0
	Gets the reading string of the completed string.
virtual IMPORT_C TBool	IsModifiableCharacter () const =0
	Checking it whether a character in a current cursor position is in modifiable character.

Member Enumeration Documentation

enum MPtiEngineCompositionDataInterface::TPtiAttributeOfPhrase

Enumerator:

EPtiAttributeTransitoryInput
EPtiAttributeNonTargetConvert
EPtiAttributeTargetConvert

Member Function Documentation

virtual IMPORT_C TPtrC8 MPtiEngineCompositionDataInterface::AttributeOfPhrase ( ) const [pure virtual]

Gets the attribute of each phrase.

Returns:: TPtrC8 : the arrary keeping the value of TPtiAttributeOfPhrase

virtual IMPORT_C TPtrC MPtiEngineCompositionDataInterface::CompletedString ( ) const [pure virtual]

Gets the specified string.

Returns:: TPtrC : the completed string

virtual IMPORT_C TPtrC MPtiEngineCompositionDataInterface::ConvertingString ( ) const [pure virtual]

Gets the converting string.

Returns:: TPtrC : the converting string

virtual IMPORT_C TInt MPtiEngineCompositionDataInterface::CursorPosition ( ) const [pure virtual]

Gets a cursor position on converting string.

Returns:: TInt : The current cursor position If the cursor is left side, the returned value is 0.

virtual IMPORT_C TBool MPtiEngineCompositionDataInterface::IsModifiableCharacter ( ) const [pure virtual]

Checking it whether a character in a current cursor position is in modifiable character.

The modifiable character is diacritics and small characters. There are two diacritics marks in Japanese: viced sound mark and semi-voiced sound mark.

Returns:: TBool : ETrue is modifiable character.

virtual IMPORT_C TPtrC8 MPtiEngineCompositionDataInterface::LengthOfPhrase ( ) const [pure virtual]

Gets the character count of each phrase.

Returns:: TPtrC8 : the arrary keeping the character count

virtual IMPORT_C TInt MPtiEngineCompositionDataInterface::NumberOfPhrase ( ) const [pure virtual]

Gets the number of phrases on converting string.

Returns:: TInt : the number of phrases

virtual IMPORT_C TPtrC MPtiEngineCompositionDataInterface::ReadingString ( ) const [pure virtual]

Gets the reading string of the completed string.

Returns:: TPtrC : the reading string

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

pticompositiondataif.h

MPtiEngineCompositionDataInterface Class Reference

Capability Information

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation