/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_linguistic2_XPossibleHyphens_idl__
#define __com_sun_star_linguistic2_XPossibleHyphens_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/Locale.idl>



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    com::sun::star::linguistic2::XHyphenator
*/
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    com::sun::star::lang::Locale
    */
    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
            com::sun::star::linguistic2::XPossibleHyphens::getPossibleHyphens().
    */
    sequence<short> getHyphenationPositions();

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */