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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_linguistic2_XHyphenatedWord_idl__
  20 #define __com_sun_star_linguistic2_XHyphenatedWord_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/Locale.idl>
  24
  25
  26
  27 module com { module sun { module star { module linguistic2 {
  28
  29 /** gives information obtained by a successful hyphenation attempt.
  30
  31     <P>This interface is used as a return value for some of the hyphenator
  32     functions.</P>
  33
  34     @see    com::sun::star::linguistic2::XHyphenator
  35 */
  36 published interface XHyphenatedWord : com::sun::star::uno::XInterface
  37 {
  38     /**
  39          @returns
  40              the word that was hyphenated.
  41      */
  42     string getWord();
  43
  44     /**
  45          @returns
  46             the language of the hyphenated word.
  47
  48         @see    com::sun::star::lang::Locale
  49     */
  50     com::sun::star::lang::Locale getLocale();
  51
  52     /**
  53         @returns
  54             the position where hyphenation was applied in the word.
  55
  56         <P>The value has to be in the range from 0 (after the first character)
  57          to n-2 (before the last character) where n is the length of
  58          the word.</P>
  59     */
  60     short getHyphenationPos();
  61
  62     /**
  63          @returns
  64              the hyphenated word as it should be written (without the hyphen
  65              character).
  66      */
  67     string getHyphenatedWord();
  68
  69     /**
  70         @returns
  71             the position of the hyphen in the hyphenated word.
  72
  73         <P>The value has to be in the range from 0 (after the first character)
  74          to m-2 (before the last character) where m is the length of
  75          the hyphenated word.</P>
  76     */
  77     short getHyphenPos();
  78
  79     /** is used to query if the hyphenation result is an alternative spelling.
  80
  81          <p>A hyphenation result is an alternative spelling if the hyphenated
  82          word is different from the word that was hyphenated.</p>
  83
  84          @returns
  85              `TRUE` if it is an alternative spelling, `FALSE` otherwise.
  86     */
  87     boolean isAlternativeSpelling();
  88
  89 };
  90
  91
  92 }; }; }; };
  93
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */