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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDictionaryEntry.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_linguistic2_XDictionaryEntry_idl__
  31 #define __com_sun_star_linguistic2_XDictionaryEntry_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_Locale_idl__
  38 #include <com/sun/star/lang/Locale.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module linguistic2 {
  44
  45 //=============================================================================
  46 /** This interfaces gives access to a dictionary entry.
  47
  48     <P>A dictionary entry can supply a word and its hyhenation
  49     and indicate if it is a negative word.
  50     If it is a negative entry it may supply a replacement text to
  51     be used instead of the entry word.</P>
  52
  53      <P>Hyphenation positions are represented by an '=' in the word.
  54      If the '=' is the last character of the word this means it should not
  55      be hyphenated. If there is no '=' charcter in the word, hyphenation
  56      positions will be determined automatically (i.e., from the hyphenator
  57     service alone).</P>
  58
  59      <P>Entries whose words only differ in hyphenation are considered
  60      to be equal. Also a '.' at the end of the word will make no
  61      difference.</P>
  62
  63     @see    <type scope="com::sun::star::linguistic2">XDictionary</type>
  64     @see    <type scope="com::sun::star::uno">XInterface</type>
  65 */
  66 published interface XDictionaryEntry : com::sun::star::uno::XInterface
  67 {
  68     //-------------------------------------------------------------------------
  69     /**
  70          @returns
  71              the word defining this entry.
  72      */
  73     string getDictionaryWord();
  74
  75     //-------------------------------------------------------------------------
  76     /**
  77         @returns
  78             <TRUE/> if the word (entry) is a negative one and should not be
  79              used, <FALSE/> otherwise.
  80     */
  81     boolean isNegative();
  82
  83     //-------------------------------------------------------------------------
  84     /** is the suggested replacement text for negative words.
  85
  86          <p>It is undefined if the entry is not negative.</p>
  87
  88          @returns
  89              the replacement text for a negative entry.
  90              An empty string indicates that no replacement text is provided.
  91      */
  92     string getReplacementText();
  93
  94 };
  95
  96 //=============================================================================
  97
  98 }; }; }; };
  99
 100 #endif