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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: LineBreakUserOptions.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_i18n_LineBreakUserOptions_idl__
  31 #define __com_sun_star_i18n_LineBreakUserOptions_idl__
  32
  33 //=============================================================================
  34
  35 module com {  module sun {  module star {  module i18n {
  36
  37 //=============================================================================
  38
  39 /** Line break options passed in calls to <member>XBreakIterator::getLineBreak()</member>.
  40  */
  41 published struct LineBreakUserOptions
  42 {
  43     /// Characters not allowed at the beginning of a line.
  44     string forbiddenBeginCharacters;
  45
  46     /// Characters not allowed at the end of a line.
  47     string forbiddenEndCharacters;
  48
  49     /// If the forbidden characters rules are to be applied or not.
  50     boolean applyForbiddenRules;
  51
  52     /** If punctuation characters are allowed at the end of the line if
  53         outside of the margins, resulting in a line not being wrapped if only
  54         the punctuation would wrap. */
  55     boolean allowPunctuationOutsideMargin;
  56
  57     /// Allow English hyphenation.
  58     boolean allowHyphenateEnglish;
  59
  60 };
  61
  62 //=============================================================================
  63 }; }; }; };
  64
  65 #endif