xref: /AOO41X/main/offapi/com/sun/star/text/LineNumberingSettings.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_LineNumberingSettings_idl__
24#define __com_sun_star_text_LineNumberingSettings_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module text {
30
31//=============================================================================
32
33/** provides access to the settings of the line numbering.
34    @deprecated
35
36    Actually there never was an implementation for this service.
37 */
38published service LineNumberingSettings
39{
40    //-------------------------------------------------------------------------
41
42    /** If <TRUE/>, line numbering is used.
43     */
44    [property] boolean On;
45
46    //-------------------------------------------------------------------------
47
48    /** The name of the character style that is used for the line number.
49     */
50    [property] string CharStyle;
51
52    //-------------------------------------------------------------------------
53
54    /** If <TRUE/>, empty lines are counted.
55     */
56    [property] boolean CountEmptyLines;
57
58    //-------------------------------------------------------------------------
59
60    /** If <TRUE/>, lines in frames are included in counting.
61     */
62    [property] boolean CountLinesInFrames;
63
64    //-------------------------------------------------------------------------
65
66    /** specifies the distance between the line number and the start or
67        end of the text area.
68     */
69    [property] long Distance;
70
71    //-------------------------------------------------------------------------
72
73    /** Line numbers are shown on every <var>LineInterval</var>th line.
74     */
75    [property] short LineInterval;
76
77    //-------------------------------------------------------------------------
78
79    /** specifies the symbol that is shown between the line numbers.
80     */
81    [property] string LineSeparator;
82
83    //-------------------------------------------------------------------------
84
85    /** The line separator is shown every <var>SeparatorLineDistance</var>th line.
86     */
87    [property] short SeparatorLineDistance;
88
89    //-------------------------------------------------------------------------
90
91    /** specifies the position of the line number
92        (constant <type scope="com::sun::star::style::">LineNumberPosition</type> - left/right/inside/outside).
93     */
94    [property] short NumberPosition;
95
96    //-------------------------------------------------------------------------
97
98    /** specifies the type of the numbering.
99     */
100    [property] short NumberingType;
101
102};
103
104//=============================================================================
105
106}; }; }; };
107#endif
108