/* -*- 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 provides Text Conversion service.

    <p> It is derived from
    ::com::sun::star::i18n::XTextConversion and provides
    a new conversion function containing position map (offset) between original
    and converted string. </p>

     @since OOo 2.0
 */
published interface XExtendedTextConversion : ::com::sun::star::i18n::XTextConversion
{
    /**
        The functionality of this method is same as
        ::com::sun::star::i18n::XTextConversion::getConversion(),
        except an additional output parameter rOffset.

        @param aText
            See ::com::sun::star::i18n::XTextConversion::getConversion()
        @param nStartPos
            See ::com::sun::star::i18n::XTextConversion::getConversion()
        @param nLength
            See ::com::sun::star::i18n::XTextConversion::getConversion()
        @param aLocale
            See ::com::sun::star::i18n::XTextConversion::getConversion()
        @param nTextConversionType
            See ::com::sun::star::i18n::XTextConversion::getConversion()
        @param nTextConversionOptions
            See ::com::sun::star::i18n::XTextConversion::getConversion()

        @param rOffset
            To find the grapheme of input string corresponding to the
            grapheme of output string, rOffset provides the offset array
            whose index is the offset of output string, the element
            containing the position within the input string.
            When the graphemes of input and output strings are simple
            one to one mapping, to improve the performance, returned
            rOffset will be a zero length array.
     */
    string getConversionWithOffset(
            [in] string aText,
            [in] long nStartPos,
            [in] long nLength,
            [in] ::com::sun::star::lang::Locale aLocale,
            [in] short nTextConversionType,
            [in] long nTextConversionOptions,
            [out] sequence <long> rOffset )
        raises( com::sun::star::lang::IllegalArgumentException,
                com::sun::star::lang::NoSupportException );
};

}; }; }; };

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