LibreOffice
LibreOffice 7.2 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 #ifndef __com_sun_star_linguistic2_XConversionDictionary_idl__
20 #define __com_sun_star_linguistic2_XConversionDictionary_idl__
21 
22 
30 
31 
32 
33 module com { module sun { module star { module linguistic2 {
34 
53 {
58  string getName();
59 
67 
75 
82  void setActive( [in] boolean bActivate );
83 
88  boolean isActive();
89 
92  void clear();
93 
126  sequence< string > getConversions(
127  [in] string aText,
128  [in] long nStartPos,
129  [in] long nLength,
131  [in] long nTextConversionOptions )
133 
150  void addEntry(
151  [in] string aLeftText,
152  [in] string aRightText )
155 
168  [in] string aLeftText,
169  [in] string aRightText )
171 
183 
192  sequence< string > getConversionEntries(
194 
195 };
196 
197 
198 }; }; }; };
199 
200 #endif
201 
202 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
is thrown by container methods, if an element is added which is already a child of the container.
Definition: ElementExistException.idl:39
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:35
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
Allows the user to access a conversion dictionary.
Definition: XConversionDictionary.idl:53
sequence< string > getConversionEntries([in] com::sun::star::linguistic2::ConversionDirection eDirection)
void addEntry([in] string aLeftText, [in] string aRightText)
is used to add a conversion pair to the dictionary.
void setActive([in] boolean bActivate)
specifies whether the dictionary should be used or not .
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.
void clear()
removes all entries from the dictionary.
void removeEntry([in] string aLeftText, [in] string aRightText)
removes a conversion pair from the dictionary.
short getMaxCharCount([in] com::sun::star::linguistic2::ConversionDirection eDirection)
returns the maximum number of characters used as left or right text in entries.
base interface of all UNO interfaces
Definition: XInterface.idl:48
ConversionDirection
Conversion direction to be used with XConversionDictionary when looking for conversions.
Definition: ConversionDirection.idl:31
Definition: Ambiguous.idl:22
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:48