From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- .../com/sun/star/linguistic2/XDictionaryEntry.idl | 80 ++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 offapi/com/sun/star/linguistic2/XDictionaryEntry.idl (limited to 'offapi/com/sun/star/linguistic2/XDictionaryEntry.idl') diff --git a/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl b/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl new file mode 100644 index 000000000..0dc4d73a1 --- /dev/null +++ b/offapi/com/sun/star/linguistic2/XDictionaryEntry.idl @@ -0,0 +1,80 @@ +/* -*- 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_linguistic2_XDictionaryEntry_idl__ +#define __com_sun_star_linguistic2_XDictionaryEntry_idl__ + +#include +#include + + +module com { module sun { module star { module linguistic2 { + +/** This interfaces gives access to a dictionary entry. + +

A dictionary entry can supply a word and its hyphenation + and indicate if it is a negative word. + If it is a negative entry it may supply a replacement text to + be used instead of the entry word.

+ +

Hyphenation positions are represented by an "=" in the word. + If the "=" is the last character of the word this means it should not + be hyphenated. If there is no "=" charter in the word, hyphenation + positions will be determined automatically (i.e., from the hyphenator + service alone).

+ +

Entries whose words only differ in hyphenation are considered + to be equal. Also a "." at the end of the word will make no + difference.

+ + @see com::sun::star::linguistic2::XDictionary + @see com::sun::star::uno::XInterface +*/ +published interface XDictionaryEntry : com::sun::star::uno::XInterface +{ + /** + @returns + the word defining this entry. + */ + string getDictionaryWord(); + + /** + @returns + `TRUE` if the word (entry) is a negative one and should not be + used, `FALSE` otherwise. + */ + boolean isNegative(); + + /** is the suggested replacement text for negative words. + +

It is undefined if the entry is not negative.

+ + @returns + the replacement text for a negative entry. + An empty string indicates that no replacement text is provided. + */ + string getReplacementText(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3