/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_linguistic2_XDictionaryEntry_idl__
#define __com_sun_star_linguistic2_XDictionaryEntry_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif

//=============================================================================

module com { module sun { module star { module linguistic2 {

//=============================================================================
/** This interfaces gives access to a dictionary entry.

    <P>A dictionary entry can supply a word and its hyhenation
    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.</P>

     <P>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 '=' charcter in the word, hyphenation
     positions will be determined automatically (i.e., from the hyphenator
    service alone).</P>

     <P>Entries whose words only differ in hyphenation are considered
     to be equal. Also a '.' at the end of the word will make no
     difference.</P>

    @see    <type scope="com::sun::star::linguistic2">XDictionary</type>
    @see    <type scope="com::sun::star::uno">XInterface</type>
*/
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.

         <p>It is undefined if the entry is not negative.</p>

         @returns
             the replacement text for a negative entry.
             An empty string indicates that no replacement text is provided.
     */
    string getReplacementText();

};

//=============================================================================

}; }; }; };

#endif
