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