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