offapi/com/sun/star/i18n/LineBreakHyphenationOptions.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_i18n_LineBreakHyphenationOptions_idl__
  20 #define __com_sun_star_i18n_LineBreakHyphenationOptions_idl__
  21
  22 #include <com/sun/star/linguistic2/XHyphenator.idl>
  23
  24
  25 module com {  module sun {  module star {  module i18n {
  26
  27
  28 /** Hyphenation options passed in calls to XBreakIterator::getLineBreak().
  29  */
  30 published struct LineBreakHyphenationOptions
  31 {
  32     /// Reference to the specific hyphenator - can be zero.
  33     ::com::sun::star::linguistic2::XHyphenator rHyphenator;
  34
  35     /** Sequence of property values to be used by the hyphenator - can be
  36         empty if the default values (from the property set) should be used. */
  37     ::com::sun::star::beans::PropertyValues aHyphenationOptions;
  38
  39     /** The first character not fitting to the current line,
  40         considering an additional "-" for hyphenation */
  41     long  hyphenIndex;
  42 };
  43
  44 }; }; }; };
  45
  46 #endif
  47
  48 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */