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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_i18n_XExtendedInputSequenceChecker_idl__
  21 #define __com_sun_star_i18n_XExtendedInputSequenceChecker_idl__
  22
  23 #include <com/sun/star/i18n/XInputSequenceChecker.idl>
  24
  25
  26 module com { module sun { module star { module i18n {
  27
  28
  29
  30 /**
  31     This interface perform input sequence correction for the languages like Thai and Hindi
  32
  33     <p> It is derived from
  34     ::com::sun::star::i18n::XInputSequenceChecker and
  35     provides additional functionality to correct input sequence.</p>
  36
  37      @since OOo 2.0.1
  38  */
  39 published interface XExtendedInputSequenceChecker : ::com::sun::star::i18n::XInputSequenceChecker
  40 {
  41     /** @returns
  42             Next nPos, or length of aText if nothing is corrected.
  43
  44         @param aText
  45             Text to be checked and corrected.
  46
  47         @param nPos
  48             Index in aText where checking starts.
  49
  50         @param cInputChar
  51             The input character.  Or at least, a UTF16 code unit thereof.
  52             It looks like this interface was not designed with non-BMP
  53             characters in mind.  Not sure if that is a problem.
  54
  55         @param nInputCheckMode
  56             One of InputSequenceCheckMode constants.
  57     */
  58     long correctInputSequence( [inout] string aText, [in] long nPos,
  59                 [in] char cInputChar, [in] short nInputCheckMode );
  60 };
  61
  62 }; }; }; };
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */