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
  21 module com { module sun { module star { module i18n {
  22
  23
  24
  25 /**
  26     This interface perform input sequence correction for the languages like Thai and Hindi
  27
  28     <p> It is derived from
  29     ::com::sun::star::i18n::XInputSequenceChecker and
  30     provides additional functionality to correct input sequence.</p>
  31
  32      @since OOo 2.0.1
  33  */
  34 published interface XExtendedInputSequenceChecker : ::com::sun::star::i18n::XInputSequenceChecker
  35 {
  36     /** @returns
  37             Next nPos, or length of aText if nothing is corrected.
  38
  39         @param aText
  40             Text to be checked and corrected.
  41
  42         @param nPos
  43             Index in aText where checking starts.
  44
  45         @param cInputChar
  46             The input character.  Or at least, a UTF16 code unit thereof.
  47             It looks like this interface was not designed with non-BMP
  48             characters in mind.  Not sure if that is a problem.
  49
  50         @param nInputCheckMode
  51             One of InputSequenceCheckMode constants.
  52     */
  53     long correctInputSequence( [inout] string aText, [in] long nPos,
  54                 [in] char cInputChar, [in] short nInputCheckMode );
  55 };
  56
  57 }; }; }; };
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */