LibreOffice LibreOffice 25.2 SDK API Reference

XTextConversion.idl
Go to the documentation of this file.
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
22module com { module sun { module star { module i18n {
23
24
29published interface XTextConversion : ::com::sun::star::uno::XInterface
30{
52 TextConversionResult getConversions(
53 [in] string aText,
54 [in] long nStartPos,
55 [in] long nLength,
56 [in] ::com::sun::star::lang::Locale Locale,
57 [in] short nTextConversionType,
58 [in] long nTextConversionOptions )
59 raises( com::sun::star::lang::IllegalArgumentException,
60 com::sun::star::lang::NoSupportException );
61
85 string getConversion(
86 [in] string aText,
87 [in] long nStartPos,
88 [in] long nLength,
89 [in] ::com::sun::star::lang::Locale Locale,
90 [in] short nTextConversionType,
91 [in] long nTextConversionOptions )
92 raises( com::sun::star::lang::IllegalArgumentException,
93 com::sun::star::lang::NoSupportException );
94
112 boolean interactiveConversion(
113 [in] ::com::sun::star::lang::Locale Locale,
114 [in] short nTextConversionType,
115 [in] long nTextConversionOptions )
116 raises( com::sun::star::lang::IllegalArgumentException,
117 com::sun::star::lang::NoSupportException );
118};
119
120
121
122}; }; }; };
123
124/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::lang::NoSupportException
This exception is thrown when a feature of an interface is not supported.
Definition: NoSupportException.idl:35
com::sun::star::i18n::XTextConversion
Method to convert text from one type to another.
Definition: XTextConversion.idl:30
com::sun::star::i18n::XTextConversion::interactiveConversion
boolean interactiveConversion([in] ::com::sun::star::lang::Locale Locale, [in] short nTextConversionType, [in] long nTextConversionOptions)
Method to query if the conversion type should be interactive or non-interactive mode.
com::sun::star::i18n::XTextConversion::getConversion
string getConversion([in] string aText, [in] long nStartPos, [in] long nLength, [in] ::com::sun::star::lang::Locale Locale, [in] short nTextConversionType, [in] long nTextConversionOptions)
Method to search dictionaries for the conversion candidate, if there are multiple candidates,...
com::sun::star::i18n::XTextConversion::getConversions
TextConversionResult getConversions([in] string aText, [in] long nStartPos, [in] long nLength, [in] ::com::sun::star::lang::Locale Locale, [in] short nTextConversionType, [in] long nTextConversionOptions)
Method to search dictionaries for the conversion candidates.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20
com::sun::star::i18n::TextConversionResult
Text conversion result to be used with XTextConversion.
Definition: TextConversionResult.idl:33
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:34