offapi/com/sun/star/linguistic2/XHyphenatedWord.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: XHyphenatedWord.idl,v $
  10  * $Revision: 1.10 $
  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_XHyphenatedWord_idl__
  31 #define __com_sun_star_linguistic2_XHyphenatedWord_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 obtained by a successful hyphenation attempt.
  48
  49     <P>This interface is used as a return value for some of the hyphenator
  50     functions.</P>
  51
  52     @see    <type scope="com::sun::star::linguistic2">XHyphenator</type>
  53 */
  54 published interface XHyphenatedWord : com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57     /**
  58          @returns
  59              the word that was hyphenated.
  60      */
  61     string getWord();
  62
  63     //-------------------------------------------------------------------------
  64     /**
  65          @returns
  66             the language of the hyphenated word.
  67
  68         @see    com::sun::star::lang::Locale
  69     */
  70     com::sun::star::lang::Locale getLocale();
  71
  72     //-------------------------------------------------------------------------
  73     /**
  74         @returns
  75             the position where hyphenation was applied in the word.
  76
  77         <P>The value has to be in the range from 0 (after the first character)
  78          to n-2 (before the last character) where n is the length of
  79          the word.</P>
  80     */
  81     short getHyphenationPos();
  82
  83     //-------------------------------------------------------------------------
  84     /**
  85          @returns
  86              the hyphenated word as it should be written (without the hyphen
  87              character).
  88      */
  89     string getHyphenatedWord();
  90
  91     //-------------------------------------------------------------------------
  92     /**
  93         @returns
  94             the position of the hyphen in the hyphenated word.
  95
  96         <P>The value has to be in the range from 0 (after the first character)
  97          to m-2 (before the last character) where m is the length of
  98          the hyphenated word.</P>
  99     */
 100     short getHyphenPos();
 101
 102     //-------------------------------------------------------------------------
 103     /** is used to query if the hyphenation result is an alternative spelling.
 104
 105          <p>A hyphenation result is an alternative spelling if the hyphenated
 106          word is different from the word that was hyphenated.</p>
 107
 108          @returns
 109              <TRUE/> if it is an alternative spelling, <FALSE/> otherwise.
 110     */
 111     boolean isAlternativeSpelling();
 112
 113 };
 114
 115 //=============================================================================
 116
 117 }; }; }; };
 118
 119 #endif
 120