offapi/com/sun/star/linguistic2/XPossibleHyphens.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_XPossibleHyphens_idl__
  20 #define __com_sun_star_linguistic2_XPossibleHyphens_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 about a word's possible hyphenation points.
  30
  31      <P>Example: In German pre-spelling-reform you may have the following:
  32      getWord:                   Dampfschiffahrt
  33      getPossibleHyphens:            Dampf=schiff=fahrt
  34      getOrigHyphensPositions:   4, 9
  35      That is "Dampfschiffahrt" can be hyphenated after the "pf" (4) and
  36      between the double "ff" (9). And if you are going to hyphenate it at
  37      position 9 you will get an additional "f" before the hyphen
  38      character.</P>
  39
  40     @see    com::sun::star::linguistic2::XHyphenator
  41 */
  42 published interface XPossibleHyphens : com::sun::star::uno::XInterface
  43 {
  44     /**
  45          @returns
  46              the word for which the information of possible hyphenation
  47              points was obtained.
  48     */
  49     string getWord();
  50
  51     /** @returns
  52             the language of the hyphenated word.
  53
  54         @see    com::sun::star::lang::Locale
  55     */
  56     com::sun::star::lang::Locale getLocale();
  57
  58     /**
  59          @returns
  60              a string depicting the word with all hyphen positions
  61              which are represented by "=" characters.
  62              If there are any alternative spellings, the word will be altered
  63              accordingly.
  64     */
  65     string getPossibleHyphens();
  66
  67     /**
  68          @returns
  69              an ascending sequence of numbers where each number is an offset
  70              within the original word which denotes a hyphenation
  71              position corresponding to one of the hyphens in the
  72             string returned by
  73             com::sun::star::linguistic2::XPossibleHyphens::getPossibleHyphens().
  74     */
  75     sequence<short> getHyphenationPositions();
  76
  77 };
  78
  79
  80 }; }; }; };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */