summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/text/LineNumberingProperties.idl
blob: fe15d0c7c4466bc22ada5c3c41250c24abec1539 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_text_LineNumberingProperties_idl__
#define __com_sun_star_text_LineNumberingProperties_idl__

#include <com/sun/star/text/XLineNumberingProperties.idl>


 module com {  module sun {  module star {  module text {

/** provides access to the settings of the line numbering.
 */
published service LineNumberingProperties
{

    /** If `TRUE`, line numbering is used.
     */
    [property] boolean IsOn;


    /** The name of the character style that is used for the line number.
     */
    [property] string CharStyleName;


    /** If `TRUE`, empty lines are counted.
     */
    [property] boolean CountEmptyLines;

    /** If `TRUE`, lines in frames are included in counting.
     */
    [property] boolean CountLinesInFrames;

    /** specifies the distance between the line number and the start or
        end of the text area.
     */
    [property] long Distance;

    /** Line numbers are shown on every <var>Interval</var>th line.
     */
    [property] short Interval;

    /** specifies the string that is used for the line separator.
     */
    [property] string SeparatorText;

    /** The line separator is shown every <var>SeparatorInterval</var>th line.
     */
    [property] short SeparatorInterval;

    /** specifies the position of the line number (constant LineNumberPositions
        left/right/inside/outside).
     */
    [property] short NumberPosition;

    /** specifies the type of the numbering.
     */
    [property] short NumberingType;

    /** specifies if the line numbering should start from the
        beginning at each page.

        <p>If set to `FALSE` the line numbering will be continuous.</p>

        @since OOo 2.0
     */
    [optional, property] boolean RestartAtEachPage;

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */