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

   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_LineBreakUserOptions_idl__
  28 #define __com_sun_star_i18n_LineBreakUserOptions_idl__
  29
  30 //=============================================================================
  31
  32 module com {  module sun {  module star {  module i18n {
  33
  34 //=============================================================================
  35
  36 /** Line break options passed in calls to <member>XBreakIterator::getLineBreak()</member>.
  37  */
  38 published struct LineBreakUserOptions
  39 {
  40     /// Characters not allowed at the beginning of a line.
  41     string forbiddenBeginCharacters;
  42
  43     /// Characters not allowed at the end of a line.
  44     string forbiddenEndCharacters;
  45
  46     /// If the forbidden characters rules are to be applied or not.
  47     boolean applyForbiddenRules;
  48
  49     /** If punctuation characters are allowed at the end of the line if
  50         outside of the margins, resulting in a line not being wrapped if only
  51         the punctuation would wrap. */
  52     boolean allowPunctuationOutsideMargin;
  53
  54     /// Allow English hyphenation.
  55     boolean allowHyphenateEnglish;
  56
  57 };
  58
  59 //=============================================================================
  60 }; }; }; };
  61
  62 #endif