summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/i18n/XExtendedTextConversion.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/i18n/XExtendedTextConversion.idl')
-rw-r--r--offapi/com/sun/star/i18n/XExtendedTextConversion.idl85
1 files changed, 85 insertions, 0 deletions
diff --git a/offapi/com/sun/star/i18n/XExtendedTextConversion.idl b/offapi/com/sun/star/i18n/XExtendedTextConversion.idl
new file mode 100644
index 000000000..2ef853aab
--- /dev/null
+++ b/offapi/com/sun/star/i18n/XExtendedTextConversion.idl
@@ -0,0 +1,85 @@
+/* -*- 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 .
+ */
+
+#ifndef __com_sun_star_i18n_XExtendedTextConversion_idl__
+#define __com_sun_star_i18n_XExtendedTextConversion_idl__
+
+#include <com/sun/star/i18n/XTextConversion.idl>
+
+
+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 );
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */