summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/i18n/XExtendedInputSequenceChecker.idl
blob: 98a805804624a7119becdb55948f1d6defc0a0f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */


module com { module sun { module star { module i18n {



/**
    This interface perform input sequence correction for the languages like Thai and Hindi

    <p> It is derived from
    ::com::sun::star::i18n::XInputSequenceChecker and
    provides additional functionality to correct input sequence.</p>

     @since OOo 2.0.1
 */
published interface XExtendedInputSequenceChecker : ::com::sun::star::i18n::XInputSequenceChecker
{
    /** @returns
            Next nPos, or length of aText if nothing is corrected.

        @param aText
            Text to be checked and corrected.

        @param nPos
            Index in aText where checking starts.

        @param cInputChar
            The input character.  Or at least, a UTF16 code unit thereof.
            It looks like this interface was not designed with non-BMP
            characters in mind.  Not sure if that is a problem.

        @param nInputCheckMode
            One of InputSequenceCheckMode constants.
    */
    long correctInputSequence( [inout] string aText, [in] long nPos,
                [in] char cInputChar, [in] short nInputCheckMode );
};

}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */