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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_i18n_LineBreakUserOptions_idl__
  20 #define __com_sun_star_i18n_LineBreakUserOptions_idl__
  21
  22
  23 module com {  module sun {  module star {  module i18n {
  24
  25
  26 /** Line break options passed in calls to XBreakIterator::getLineBreak().
  27  */
  28 published struct LineBreakUserOptions
  29 {
  30     /// Characters not allowed at the beginning of a line.
  31     string forbiddenBeginCharacters;
  32
  33     /// Characters not allowed at the end of a line.
  34     string forbiddenEndCharacters;
  35
  36     /// If the forbidden characters rules are to be applied or not.
  37     boolean applyForbiddenRules;
  38
  39     /** If punctuation characters are allowed at the end of the line if
  40         outside of the margins, resulting in a line not being wrapped if only
  41         the punctuation would wrap. */
  42     boolean allowPunctuationOutsideMargin;
  43
  44     /// Allow English hyphenation.
  45     boolean allowHyphenateEnglish;
  46
  47 };
  48
  49 }; }; }; };
  50
  51 #endif
  52
  53 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */