offapi/com/sun/star/text/ControlCharacter.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_text_ControlCharacter_idl__
  28 #define __com_sun_star_text_ControlCharacter_idl__
  29
  30
  31 //=============================================================================
  32
  33  module com {  module sun {  module star {  module text {
  34
  35 //=============================================================================
  36
  37 // DocMerge from idl: constants com::sun::star::text::ControlCharacter
  38 /** These constants are the codes for inserting control characters
  39         using <method>XSimpleText::insertControlCharacter</method> interface.
  40  */
  41 published constants ControlCharacter
  42 {
  43     //-------------------------------------------------------------------------
  44
  45     // DocMerge from idl: value com::sun::star::text::ControlCharacter::PARAGRAPH_BREAK
  46     /** This control character starts a new paragraph.
  47      */
  48     const short PARAGRAPH_BREAK = 0;
  49
  50     //-------------------------------------------------------------------------
  51
  52     // DocMerge from idl: value com::sun::star::text::ControlCharacter::LINE_BREAK
  53     /** This control character starts a new line in a paragraph.
  54      */
  55     const short LINE_BREAK = 1;
  56
  57     //-------------------------------------------------------------------------
  58
  59     // DocMerge from idl: value com::sun::star::text::ControlCharacter::HARD_HYPHEN
  60     /** This control character equals a dash but prevents this
  61                 position from being hyphenated.
  62      */
  63     const short HARD_HYPHEN = 2;
  64
  65     //-------------------------------------------------------------------------
  66
  67     // DocMerge from idl: value com::sun::star::text::ControlCharacter::SOFT_HYPHEN
  68     /** This control character defines a special position as a
  69                 hyphenation point. If a word containing a soft hyphen
  70                 must be split at the end of a line, then this position
  71                 is preferred.
  72      */
  73     const short SOFT_HYPHEN = 3;
  74
  75     //-------------------------------------------------------------------------
  76
  77     // DocMerge from idl: value com::sun::star::text::ControlCharacter::HARD_SPACE
  78     /** This control character is used to link two words and
  79                 prevents this concatenation from being hyphenated.
  80                 It is printed as a space.
  81      */
  82     const short HARD_SPACE = 4;
  83
  84     //-------------------------------------------------------------------------
  85     /** This control character appends a new paragraph.
  86     */
  87     const short APPEND_PARAGRAPH = 5;
  88 };
  89
  90 //=============================================================================
  91
  92 }; }; }; };
  93
  94 #endif