LibreOffice LibreOffice 25.8 SDK API Reference

XConversionDictionary.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
22
23module com { module sun { module star { module linguistic2 {
24
42published interface XConversionDictionary : com::sun::star::uno::XInterface
43{
48 string getName();
49
56 com::sun::star::lang::Locale getLocale();
57
64 short getConversionType();
65
72 void setActive( [in] boolean bActivate );
73
78 boolean isActive();
79
82 void clear();
83
116 sequence< string > getConversions(
117 [in] string aText,
118 [in] long nStartPos,
119 [in] long nLength,
120 [in] com::sun::star::linguistic2::ConversionDirection eDirection,
121 [in] long nTextConversionOptions )
122 raises( com::sun::star::lang::IllegalArgumentException );
123
140 void addEntry(
141 [in] string aLeftText,
142 [in] string aRightText )
143 raises( com::sun::star::lang::IllegalArgumentException,
144 com::sun::star::container::ElementExistException);
145
157 void removeEntry(
158 [in] string aLeftText,
159 [in] string aRightText )
160 raises( com::sun::star::container::NoSuchElementException );
161
171 short getMaxCharCount(
172 [in] com::sun::star::linguistic2::ConversionDirection eDirection );
173
182 sequence< string > getConversionEntries(
183 [in] com::sun::star::linguistic2::ConversionDirection eDirection );
184
185};
186
187
188}; }; }; };
189
190/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::ElementExistException
is thrown by container methods, if an element is added which is already a child of the container.
Definition: ElementExistException.idl:35
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:31
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::linguistic2::XConversionDictionary
Allows the user to access a conversion dictionary.
Definition: XConversionDictionary.idl:43
com::sun::star::linguistic2::XConversionDictionary::getName
string getName()
com::sun::star::linguistic2::XConversionDictionary::getConversionEntries
sequence< string > getConversionEntries([in] com::sun::star::linguistic2::ConversionDirection eDirection)
com::sun::star::linguistic2::XConversionDictionary::getLocale
com::sun::star::lang::Locale getLocale()
com::sun::star::linguistic2::XConversionDictionary::isActive
boolean isActive()
com::sun::star::linguistic2::XConversionDictionary::addEntry
void addEntry([in] string aLeftText, [in] string aRightText)
is used to add a conversion pair to the dictionary.
com::sun::star::linguistic2::XConversionDictionary::setActive
void setActive([in] boolean bActivate)
specifies whether the dictionary should be used or not .
com::sun::star::linguistic2::XConversionDictionary::getConversionType
short getConversionType()
com::sun::star::linguistic2::XConversionDictionary::getConversions
sequence< string > getConversions([in] string aText, [in] long nStartPos, [in] long nLength, [in] com::sun::star::linguistic2::ConversionDirection eDirection, [in] long nTextConversionOptions)
searches for entries or conversions that match the given text.
com::sun::star::linguistic2::XConversionDictionary::clear
void clear()
removes all entries from the dictionary.
com::sun::star::linguistic2::XConversionDictionary::removeEntry
void removeEntry([in] string aLeftText, [in] string aRightText)
removes a conversion pair from the dictionary.
com::sun::star::linguistic2::XConversionDictionary::getMaxCharCount
short getMaxCharCount([in] com::sun::star::linguistic2::ConversionDirection eDirection)
returns the maximum number of characters used as left or right text in entries.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com::sun::star::linguistic2::ConversionDirection
ConversionDirection
Conversion direction to be used with XConversionDictionary when looking for conversions.
Definition: ConversionDirection.idl:29
com
Definition: Ambiguous.idl:20
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:34