xref: /trunk/main/offapi/com/sun/star/text/LineNumberingProperties.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_text_LineNumberingProperties_idl__
24cdf0e10cSrcweir#define __com_sun_star_text_LineNumberingProperties_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_text_XLineNumberingProperties_idl__
27cdf0e10cSrcweir#include <com/sun/star/text/XLineNumberingProperties.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir//=============================================================================
31cdf0e10cSrcweir
32cdf0e10cSrcweir module com {  module sun {  module star {  module text {
33cdf0e10cSrcweir
34cdf0e10cSrcweir//=============================================================================
35cdf0e10cSrcweir
36cdf0e10cSrcweir// DocMerge from xml: service com::sun::star::text::LineNumberingProperties
37cdf0e10cSrcweir/** provides access to the settings of the line numbering.
38cdf0e10cSrcweir */
39cdf0e10cSrcweirpublished service LineNumberingProperties
40cdf0e10cSrcweir{
41cdf0e10cSrcweir    //-------------------------------------------------------------------------
42cdf0e10cSrcweir
43cdf0e10cSrcweir    /** If <TRUE/>, line numbering is used.
44cdf0e10cSrcweir     */
45cdf0e10cSrcweir    [property] boolean IsOn;
46cdf0e10cSrcweir
47cdf0e10cSrcweir    //-------------------------------------------------------------------------
48cdf0e10cSrcweir
49cdf0e10cSrcweir    /** The name of the character style that is used for the line number.
50cdf0e10cSrcweir     */
51cdf0e10cSrcweir    [property] string CharStyleName;
52cdf0e10cSrcweir
53cdf0e10cSrcweir    //-------------------------------------------------------------------------
54cdf0e10cSrcweir
55cdf0e10cSrcweir    /** If <TRUE/>, empty lines are counted.
56cdf0e10cSrcweir     */
57cdf0e10cSrcweir    [property] boolean CountEmptyLines;
58cdf0e10cSrcweir
59cdf0e10cSrcweir    //-------------------------------------------------------------------------
60cdf0e10cSrcweir    /** If <TRUE/>, lines in frames are included in counting.
61cdf0e10cSrcweir     */
62cdf0e10cSrcweir    [property] boolean CountLinesInFrames;
63cdf0e10cSrcweir
64cdf0e10cSrcweir    //-------------------------------------------------------------------------
65cdf0e10cSrcweir    /** specifies the distance between the line number and the start or
66cdf0e10cSrcweir        end of the text area.
67cdf0e10cSrcweir     */
68cdf0e10cSrcweir    [property] long Distance;
69cdf0e10cSrcweir
70cdf0e10cSrcweir    //-------------------------------------------------------------------------
71cdf0e10cSrcweir    /** Line numbers are shown on every <var>Interval</var>th line.
72cdf0e10cSrcweir     */
73cdf0e10cSrcweir    [property] short Interval;
74cdf0e10cSrcweir
75cdf0e10cSrcweir    //-------------------------------------------------------------------------
76cdf0e10cSrcweir    /** specifies the string that is used for the line separator.
77cdf0e10cSrcweir     */
78cdf0e10cSrcweir    [property] string SeparatorText;
79cdf0e10cSrcweir
80cdf0e10cSrcweir    //-------------------------------------------------------------------------
81cdf0e10cSrcweir    /** The line separator is shown every <var>SeparatorInterval</var>th line.
82cdf0e10cSrcweir     */
83cdf0e10cSrcweir    [property] short SeparatorInterval;
84cdf0e10cSrcweir
85cdf0e10cSrcweir    //-------------------------------------------------------------------------
86cdf0e10cSrcweir    /** specifies the position of the line number (constant LineNumberPositions
87cdf0e10cSrcweir        left/right/inside/outside).
88cdf0e10cSrcweir     */
89cdf0e10cSrcweir    [property] short NumberPosition;
90cdf0e10cSrcweir
91cdf0e10cSrcweir    //-------------------------------------------------------------------------
92cdf0e10cSrcweir    /** specifies the type of the numbering.
93cdf0e10cSrcweir     */
94cdf0e10cSrcweir    [property] short NumberingType;
95cdf0e10cSrcweir
96cdf0e10cSrcweir    //-------------------------------------------------------------------------
97cdf0e10cSrcweir    /** specifies if the line numbering should start from the
98cdf0e10cSrcweir        beginning at each page.
99cdf0e10cSrcweir
100*a893be29SPedro Giffuni        <p>If set to <FALSE/> the line numbering will be continuous.</p>
101cdf0e10cSrcweir
1022a413f17SJürgen Schmidt        @since OpenOffice 2.0
103cdf0e10cSrcweir     */
104cdf0e10cSrcweir    [optional, property] boolean RestartAtEachPage;
105cdf0e10cSrcweir
106cdf0e10cSrcweir};
107cdf0e10cSrcweir
108cdf0e10cSrcweir//=============================================================================
109cdf0e10cSrcweir
110cdf0e10cSrcweir}; }; }; };
111cdf0e10cSrcweir
112cdf0e10cSrcweir#endif
113