/*************************************************************************
 *
 * 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_LineBreakUserOptions_idl__
#define __com_sun_star_i18n_LineBreakUserOptions_idl__

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

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

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

/** Line break options passed in calls to <member>XBreakIterator::getLineBreak()</member>.
 */
published struct LineBreakUserOptions
{
	/// Characters not allowed at the beginning of a line.
	string forbiddenBeginCharacters;

	/// Characters not allowed at the end of a line.
	string forbiddenEndCharacters;

	/// If the forbidden characters rules are to be applied or not.
	boolean applyForbiddenRules;

    /** If punctuation characters are allowed at the end of the line if
        outside of the margins, resulting in a line not being wrapped if only
        the punctuation would wrap. */
	boolean allowPunctuationOutsideMargin;

	/// Allow English hyphenation.
	boolean allowHyphenateEnglish;

};

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

#endif