offapi/com/sun/star/linguistic2/XPossibleHyphens.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_linguistic2_XPossibleHyphens_idl__
  29 #define __com_sun_star_linguistic2_XPossibleHyphens_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #include <com/sun/star/lang/Locale.idl>
  33
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module linguistic2 {
  38
  39 //=============================================================================
  40 /** Gives information about a word's possible hyphenation points.
  41
  42      <P>Example: In German pre-spelling-reform you may have the following:
  43      getWord:                   Dampfschiffahrt
  44      getPossibleHyphens:            Dampf=schiff=fahrt
  45      getOrigHyphensPositions:   4, 9
  46      That is "Dampfschiffahrt" can be hyphenated after the "pf" (4) and
  47      between the double "ff" (9). And if you are going to hyphenate it at
  48      position 9 you will get an additional "f" before the hyphen
  49      character.</P>
  50
  51     @see    <type scope="com::sun::star::linguistic2">XHyphenator</type>
  52 */
  53 published interface XPossibleHyphens : com::sun::star::uno::XInterface
  54 {
  55     //-------------------------------------------------------------------------
  56     /**
  57          @returns
  58              the word for which the information of possible hyphenation
  59              points was obtained.
  60     */
  61     string getWord();
  62
  63     //-------------------------------------------------------------------------
  64     /** @returns
  65             the language of the hyphenated word.
  66
  67         @see    <type scope="com::sun::star::lang">Locale</type>
  68     */
  69     com::sun::star::lang::Locale getLocale();
  70
  71     //-------------------------------------------------------------------------
  72     /**
  73          @returns
  74              a string depicting the word with all hyphen positions
  75              which are represented by "=" characters.
  76              If there are any alternative spellings, the word will be altered
  77              accordingly.
  78     */
  79     string getPossibleHyphens();
  80
  81     //-------------------------------------------------------------------------
  82     /**
  83          @returns
  84              an ascending sequence of numbers where each number is an offset
  85              within the original word which denotes a hyphenation
  86              position corresponding to one of the hyphens in the
  87             string returned by
  88             <member scope="com::sun::star::linguistic2">XPossibleHyphens::getPossibleHyphens</member>.
  89     */
  90     sequence<short> getHyphenationPositions();
  91
  92 };
  93
  94 //=============================================================================
  95
  96 }; }; }; };
  97
  98 #endif
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */