xref: /AOO41X/main/offapi/com/sun/star/text/ControlCharacter.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_text_ControlCharacter_idl__
24#define __com_sun_star_text_ControlCharacter_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module text {
30
31//=============================================================================
32
33// DocMerge from idl: constants com::sun::star::text::ControlCharacter
34/** These constants are the codes for inserting control characters
35        using <method>XSimpleText::insertControlCharacter</method> interface.
36 */
37published constants ControlCharacter
38{
39    //-------------------------------------------------------------------------
40
41    // DocMerge from idl: value com::sun::star::text::ControlCharacter::PARAGRAPH_BREAK
42    /** This control character starts a new paragraph.
43     */
44    const short PARAGRAPH_BREAK = 0;
45
46    //-------------------------------------------------------------------------
47
48    // DocMerge from idl: value com::sun::star::text::ControlCharacter::LINE_BREAK
49    /** This control character starts a new line in a paragraph.
50     */
51    const short LINE_BREAK = 1;
52
53    //-------------------------------------------------------------------------
54
55    // DocMerge from idl: value com::sun::star::text::ControlCharacter::HARD_HYPHEN
56    /** This control character equals a dash but prevents this
57                position from being hyphenated.
58     */
59    const short HARD_HYPHEN = 2;
60
61    //-------------------------------------------------------------------------
62
63    // DocMerge from idl: value com::sun::star::text::ControlCharacter::SOFT_HYPHEN
64    /** This control character defines a special position as a
65                hyphenation point. If a word containing a soft hyphen
66                must be split at the end of a line, then this position
67                is preferred.
68     */
69    const short SOFT_HYPHEN = 3;
70
71    //-------------------------------------------------------------------------
72
73    // DocMerge from idl: value com::sun::star::text::ControlCharacter::HARD_SPACE
74    /** This control character is used to link two words and
75                prevents this concatenation from being hyphenated.
76                It is printed as a space.
77     */
78    const short HARD_SPACE = 4;
79
80    //-------------------------------------------------------------------------
81    /** This control character appends a new paragraph.
82    */
83    const short APPEND_PARAGRAPH = 5;
84};
85
86//=============================================================================
87
88}; }; }; };
89
90#endif
91