1.1 --- a/epoc32/include/mw/pticompositiondataif.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/pticompositiondataif.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,125 @@
     1.4 -pticompositiondataif.h
     1.5 +/*
     1.6 +* Copyright (c) 2003 Nokia Corporation and/or its subsidiary(-ies). 
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:               MPtiEngineCompositionDataInterface class definitions.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +
    1.24 +
    1.25 +
    1.26 +
    1.27 +
    1.28 +
    1.29 +
    1.30 +
    1.31 +
    1.32 +
    1.33 +
    1.34 +
    1.35 +
    1.36 +#ifndef MPTIENGINECOMPOSITIONDATAINTERFACE_H
    1.37 +#define MPTIENGINECOMPOSITIONDATAINTERFACE_H
    1.38 +
    1.39 +// INCLUDES
    1.40 +#include <e32base.h>
    1.41 +#include <badesca.h> 
    1.42 +
    1.43 +// CLASS DECLARATION
    1.44 +
    1.45 +/**
    1.46 +* MPtiEngineCompositionDataInterface class.
    1.47 +*  This is a class which returned by CPtiEngine::CompositionData() API.
    1.48 +*
    1.49 +*  @lib PtiEngine.lib
    1.50 +*  @since 2.6
    1.51 +*/
    1.52 +class MPtiEngineCompositionDataInterface
    1.53 +    {
    1.54 +    public:
    1.55 +        // the attribute of phrase
    1.56 +        enum TPtiAttributeOfPhrase
    1.57 +            {
    1.58 +            EPtiAttributeTransitoryInput,  // transitory input(before converting)
    1.59 +            EPtiAttributeNonTargetConvert, // non-target phrase(while converting)
    1.60 +            EPtiAttributeTargetConvert     // target phrase(while converting)
    1.61 +            };
    1.62 +
    1.63 +    public:
    1.64 +        /**
    1.65 +        * Gets a cursor position on converting string
    1.66 +        * @since 2.6
    1.67 +        * @return TInt : The current cursor position
    1.68 +        *         If the cursor is left side, the returned value is 0.
    1.69 +        */
    1.70 +        IMPORT_C virtual TInt   CursorPosition() const = 0;
    1.71 +
    1.72 +        /**
    1.73 +        * Gets the number of phrases on converting string
    1.74 +        * @since 2.6
    1.75 +        * @return TInt : the number of phrases
    1.76 +        */
    1.77 +        IMPORT_C virtual TInt   NumberOfPhrase() const = 0;
    1.78 +
    1.79 +        /**
    1.80 +        * Gets the character count of each phrase
    1.81 +        * @since 2.6
    1.82 +        * @return TPtrC8 : the arrary keeping the character count
    1.83 +        */
    1.84 +        IMPORT_C virtual TPtrC8 LengthOfPhrase() const = 0;
    1.85 +
    1.86 +        /**
    1.87 +        * Gets the attribute of each phrase
    1.88 +        * @since 2.6
    1.89 +        * @return TPtrC8 : the arrary keeping the value of TPtiAttributeOfPhrase
    1.90 +        */
    1.91 +        IMPORT_C virtual TPtrC8 AttributeOfPhrase() const = 0;
    1.92 +
    1.93 +        /**
    1.94 +        * Gets the converting string
    1.95 +        * @since 2.6
    1.96 +        * @return TPtrC : the converting string
    1.97 +        */
    1.98 +        IMPORT_C virtual TPtrC  ConvertingString() const = 0;
    1.99 +
   1.100 +        /**
   1.101 +        * Gets the specified string
   1.102 +        * @since 2.6
   1.103 +        * @return TPtrC : the completed string
   1.104 +        */
   1.105 +        IMPORT_C virtual TPtrC  CompletedString() const = 0;
   1.106 +
   1.107 +        /**
   1.108 +        * Gets the reading string of the completed string
   1.109 +        * @since 2.6
   1.110 +        * @return TPtrC : the reading string
   1.111 +        */
   1.112 +        IMPORT_C virtual TPtrC  ReadingString() const = 0;
   1.113 +
   1.114 +        /**
   1.115 +        * Checking it whether a character in a current cursor position 
   1.116 +        * is in modifiable character.
   1.117 +        * The modifiable character is diacritics and small characters.
   1.118 +        * There are two diacritics marks in Japanese: viced sound mark
   1.119 +        * and semi-voiced sound mark.
   1.120 +        * @since 2.6
   1.121 +        * @return TBool : ETrue is modifiable character.
   1.122 +        */
   1.123 +        IMPORT_C virtual TBool IsModifiableCharacter() const = 0;
   1.124 +    };
   1.125 +
   1.126 +#endif  // MPTIENGINECOMPOSITIONDATAINTERFACE_H
   1.127 +
   1.128 +// End of file
   1.129 +