offapi/com/sun/star/linguistic2/XDictionaryEntry.idl

   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_XDictionaryEntry_idl__
  20 #define __com_sun_star_linguistic2_XDictionaryEntry_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/Locale.idl>
  24
  25
  26 module com { module sun { module star { module linguistic2 {
  27
  28 /** This interfaces gives access to a dictionary entry.
  29
  30     <P>A dictionary entry can supply a word and its hyphenation
  31     and indicate if it is a negative word.
  32     If it is a negative entry it may supply a replacement text to
  33     be used instead of the entry word.</P>
  34
  35      <P>Hyphenation positions are represented by an "=" in the word.
  36      If the "=" is the last character of the word this means it should not
  37      be hyphenated. If there is no "=" charter in the word, hyphenation
  38      positions will be determined automatically (i.e., from the hyphenator
  39     service alone).</P>
  40
  41      <P>Entries whose words only differ in hyphenation are considered
  42      to be equal. Also a "." at the end of the word will make no
  43      difference.</P>
  44
  45     @see    com::sun::star::linguistic2::XDictionary
  46     @see    com::sun::star::uno::XInterface
  47 */
  48 published interface XDictionaryEntry : com::sun::star::uno::XInterface
  49 {
  50     /**
  51          @returns
  52              the word defining this entry.
  53      */
  54     string getDictionaryWord();
  55
  56     /**
  57         @returns
  58             `TRUE` if the word (entry) is a negative one and should not be
  59              used, `FALSE` otherwise.
  60     */
  61     boolean isNegative();
  62
  63     /** is the suggested replacement text for negative words.
  64
  65          <p>It is undefined if the entry is not negative.</p>
  66
  67          @returns
  68              the replacement text for a negative entry.
  69              An empty string indicates that no replacement text is provided.
  70      */
  71     string getReplacementText();
  72
  73 };
  74
  75
  76 }; }; }; };
  77
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */