/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XPossibleHyphens.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 02:12:52 $
 *
 *  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_XPossibleHyphens_idl__
#define __com_sun_star_linguistic2_XPossibleHyphens_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 about a word's possible hyphenation points.

     <P>Example: In German pre-spelling-reform you may have the following:
     getWord:                   Dampfschiffahrt
     getPossibleHyphens:            Dampf=schiff=fahrt
     getOrigHyphensPositions:   4, 9
     That is "Dampfschiffahrt" can be hyphenated after the "pf" (4) and
     between the double "ff" (9). And if you are going to hyphenate it at
     position 9 you will get an additional "f" before the hyphen
     character.</P>

    @see    <type scope="com::sun::star::linguistic2">XHyphenator</type>
*/
published interface XPossibleHyphens : com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /**
         @returns
             the word for which the information of possible hyphenation
             points was obtained.
    */
    string getWord();

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

        @see    <type scope="com::sun::star::lang">Locale</type>
    */
    com::sun::star::lang::Locale getLocale();

    //-------------------------------------------------------------------------
    /**
         @returns
             a string depicting the word with all hyphen positions
             which are represented by '=' characters.
             If there are any alternative spellings, the word will be altered
             accordingly.
    */
    string getPossibleHyphens();

    //-------------------------------------------------------------------------
    /**
         @returns
             an ascending sequence of numbers where each number is an offset
             within the original word which denotes a hyphenation
             position corresponding to one of the hyphens in the
            string returned by
            <member scope="com::sun::star::linguistic2">XPossibleHyphens::getPossibleHyphens</member>.
    */
    sequence<short> getHyphenationPositions();

};

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

}; }; }; };

#endif
