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_LineNumberingProperties_idl__
24#define __com_sun_star_text_LineNumberingProperties_idl__
25
26#ifndef __com_sun_star_text_XLineNumberingProperties_idl__
27#include <com/sun/star/text/XLineNumberingProperties.idl>
28#endif
29
30//=============================================================================
31
32 module com {  module sun {  module star {  module text {
33
34//=============================================================================
35
36// DocMerge from xml: service com::sun::star::text::LineNumberingProperties
37/** provides access to the settings of the line numbering.
38 */
39published service LineNumberingProperties
40{
41	//-------------------------------------------------------------------------
42
43	/** If <TRUE/>, line numbering is used.
44	 */
45	[property] boolean IsOn;
46
47	//-------------------------------------------------------------------------
48
49	/** The name of the character style that is used for the line number.
50	 */
51	[property] string CharStyleName;
52
53	//-------------------------------------------------------------------------
54
55	/** If <TRUE/>, empty lines are counted.
56	 */
57	[property] boolean CountEmptyLines;
58
59	//-------------------------------------------------------------------------
60	/** If <TRUE/>, lines in frames are included in counting.
61	 */
62	[property] boolean CountLinesInFrames;
63
64	//-------------------------------------------------------------------------
65	/** specifies the distance between the line number and the start or
66		end of the text area.
67	 */
68	[property] long Distance;
69
70	//-------------------------------------------------------------------------
71	/** Line numbers are shown on every <var>Interval</var>th line.
72	 */
73	[property] short Interval;
74
75	//-------------------------------------------------------------------------
76	/** specifies the string that is used for the line separator.
77	 */
78	[property] string SeparatorText;
79
80	//-------------------------------------------------------------------------
81	/** The line separator is shown every <var>SeparatorInterval</var>th line.
82	 */
83	[property] short SeparatorInterval;
84
85	//-------------------------------------------------------------------------
86	/** specifies the position of the line number (constant LineNumberPositions
87		left/right/inside/outside).
88	 */
89	[property] short NumberPosition;
90
91	//-------------------------------------------------------------------------
92	/** specifies the type of the numbering.
93	 */
94	[property] short NumberingType;
95
96    //-------------------------------------------------------------------------
97    /** specifies if the line numbering should start from the
98        beginning at each page.
99
100        <p>If set to <FALSE/> the line numbering will be continous.</p>
101
102        @since OpenOffice 2.0
103     */
104    [optional, property] boolean RestartAtEachPage;
105
106};
107
108//=============================================================================
109
110}; }; }; };
111
112#endif
113
114