/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XHyphenatedWord.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 02:11:21 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_linguistic2_XHyphenatedWord_idl__
#define __com_sun_star_linguistic2_XHyphenatedWord_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 {

//=============================================================================
/** gives information obtained by a successful hyphenation attempt.

    <P>This interface is used as a return value for some of the hyphenator
    functions.</P>

    @see    <type scope="com::sun::star::linguistic2">XHyphenator</type>
*/
published interface XHyphenatedWord : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /**
         @returns
             the word that was hyphenated.
     */
    string getWord();

    //-------------------------------------------------------------------------
    /**
         @returns
            the language of the hyphenated word.

        @see    com::sun::star::lang::Locale
    */
    com::sun::star::lang::Locale getLocale();

    //-------------------------------------------------------------------------
    /**
        @returns
            the position where hyphenation was applied in the word.

        <P>The value has to be in the range from 0 (after the first character)
         to n-2 (before the last character) where n is the length of
         the word.</P>
    */
    short getHyphenationPos();

    //-------------------------------------------------------------------------
    /**
         @returns
             the hyphenated word as it should be written (without the hyphen
             character).
     */
    string getHyphenatedWord();

    //-------------------------------------------------------------------------
    /**
        @returns
            the position of the hyphen in the hyphenated word.

        <P>The value has to be in the range from 0 (after the first character)
         to m-2 (before the last character) where m is the length of
         the hyphenated word.</P>
    */
    short getHyphenPos();

    //-------------------------------------------------------------------------
    /** is used to query if the hyphenation result is an alternative spelling.

         <p>A hyphenation result is an alternative spelling if the hyphenated
         word is different from the word that was hyphenated.</p>

         @returns
             <TRUE/> if it is an alternative spelling, <FALSE/> otherwise.
    */
    boolean isAlternativeSpelling();

};

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

}; }; }; };

#endif

