1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_i18n_LineBreakHyphenationOptions_idl__
28#define __com_sun_star_i18n_LineBreakHyphenationOptions_idl__
29
30#ifndef __com_sun_star_linguistic2_XHyphenator_idl__
31#include <com/sun/star/linguistic2/XHyphenator.idl>
32#endif
33
34//=============================================================================
35
36module com {  module sun {  module star {  module i18n {
37
38//=============================================================================
39
40/** Hyphenation options passed in calls to <member>XBreakIterator::getLineBreak()</member>.
41 */
42published struct LineBreakHyphenationOptions
43{
44    /// Reference to the specific hyphenator - can be zero.
45    ::com::sun::star::linguistic2::XHyphenator rHyphenator;
46
47    /** Sequence of property values to be used by the hyphenator - can be
48        empty if the default values (from the property set) should be used. */
49    ::com::sun::star::beans::PropertyValues aHyphenationOptions;
50
51    /** The first character not fitting to the current line,
52        considering an additional "-" for hyphenation */
53    long  hyphenIndex;
54};
55
56//=============================================================================
57}; }; }; };
58
59#endif
60