/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_i18n_LineBreakHyphenationOptions_idl__
#define __com_sun_star_i18n_LineBreakHyphenationOptions_idl__

#ifndef __com_sun_star_linguistic2_XHyphenator_idl__
#include <com/sun/star/linguistic2/XHyphenator.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module i18n {

//=============================================================================

/** Hyphenation options passed in calls to <member>XBreakIterator::getLineBreak()</member>.
 */
published struct LineBreakHyphenationOptions
{
    /// Reference to the specific hyphenator - can be zero.
    ::com::sun::star::linguistic2::XHyphenator rHyphenator;

    /** Sequence of property values to be used by the hyphenator - can be 
        empty if the default values (from the property set) should be used. */
    ::com::sun::star::beans::PropertyValues aHyphenationOptions;

    /** The first character not fitting to the current line,
        considering an additional "-" for hyphenation */
    long  hyphenIndex;
};

//=============================================================================
}; }; }; };

#endif
