offapi/com/sun/star/linguistic2/XPossibleHyphens.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: XPossibleHyphens.idl,v $
  10  * $Revision: 1.11 $
  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_XPossibleHyphens_idl__
  31 #define __com_sun_star_linguistic2_XPossibleHyphens_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
  44 module com { module sun { module star { module linguistic2 {
  45
  46 //=============================================================================
  47 /** Gives information about a word's possible hyphenation points.
  48
  49      <P>Example: In German pre-spelling-reform you may have the following:
  50      getWord:                                   Dampfschiffahrt
  51      getPossibleHyphens:                        Dampf=schiff=fahrt
  52      getOrigHyphensPositions:   4, 9
  53      That is "Dampfschiffahrt" can be hyphenated after the "pf" (4) and
  54      between the double "ff" (9). And if you are going to hyphenate it at
  55      position 9 you will get an additional "f" before the hyphen
  56      character.</P>
  57
  58     @see    <type scope="com::sun::star::linguistic2">XHyphenator</type>
  59 */
  60 published interface XPossibleHyphens : com::sun::star::uno::XInterface
  61 {
  62     //-------------------------------------------------------------------------
  63     /**
  64          @returns
  65              the word for which the information of possible hyphenation
  66              points was obtained.
  67     */
  68     string getWord();
  69
  70     //-------------------------------------------------------------------------
  71     /** @returns
  72             the language of the hyphenated word.
  73
  74         @see    <type scope="com::sun::star::lang">Locale</type>
  75     */
  76     com::sun::star::lang::Locale getLocale();
  77
  78     //-------------------------------------------------------------------------
  79     /**
  80          @returns
  81              a string depicting the word with all hyphen positions
  82              which are represented by '=' characters.
  83              If there are any alternative spellings, the word will be altered
  84              accordingly.
  85     */
  86     string getPossibleHyphens();
  87
  88     //-------------------------------------------------------------------------
  89     /**
  90          @returns
  91              an ascending sequence of numbers where each number is an offset
  92              within the original word which denotes a hyphenation
  93              position corresponding to one of the hyphens in the
  94             string returned by
  95             <member scope="com::sun::star::linguistic2">XPossibleHyphens::getPossibleHyphens</member>.
  96     */
  97     sequence<short> getHyphenationPositions();
  98
  99 };
 100
 101 //=============================================================================
 102
 103 }; }; }; };
 104
 105 #endif