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

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