offapi/com/sun/star/i18n/XExtendedInputSequenceChecker.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XExtendedInputSequenceChecker.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_i18n_XExtendedInputCSequencehecker_idl__
  32 #define __com_sun_star_i18n_XExtendedInputSequenceChecker_idl__
  33
  34 #include <com/sun/star/i18n/XInputSequenceChecker.idl>
  35
  36 //=============================================================================
  37
  38 module com { module sun { module star { module i18n {
  39
  40 //=============================================================================
  41
  42
  43 /**
  44     This interface perform input sequence correction for the languages like Thai and Hindi
  45
  46     <p> It is derived from
  47     <type scope="::com::sun::star::i18n">XInputSequenceChecker</type> and
  48     provides additional functionality to correct input sequence.</p>
  49
  50      @since OOo 2.0.1
  51  */
  52 published interface XExtendedInputSequenceChecker : ::com::sun::star::i18n::XInputSequenceChecker
  53 {
  54     /** @returns
  55             Next nPos, or length of aText if nothing is corrected.
  56
  57         @param nInputCheckMode
  58             One of <type>InputSequenceCheckMode</type> constants.
  59     */
  60     long correctInputSequence( [inout] string aText, [in] long nPos,
  61                 [in] char cInputChar, [in] short nInputCheckMode );
  62 };
  63
  64 //=============================================================================
  65 }; }; }; };
  66
  67 #endif