AOO410/main/offapi/com/sun/star/i18n/LineBreakUserOptions.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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