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