summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/FootnoteSettings.idl
blob: f543f6c5731e595c7370ce9748f66ebcab563595 (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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
/* -*- 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_FootnoteSettings_idl__
#define __com_sun_star_text_FootnoteSettings_idl__


//=============================================================================

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

//=============================================================================

/** provides access to the settings of footnotes or endnotes in a
    (text) document.
 */
published service FootnoteSettings
{
    //-------------------------------------------------------------------------

    /** contains the name of the character style that is used
            for the label in front of the footnote/endnote text.
     */
    [property] string CharStyleName;

    //-------------------------------------------------------------------------

    /** contains the numbering type for the numbering of the
        footnotes/endnotes.
     */
    [property] short NumberingType;

    //-------------------------------------------------------------------------

    /** contains the page style that is used for the page that
            contains the footnote/endnote texts
     */
    [property] string PageStyleName;

    //-------------------------------------------------------------------------

    /** contains the paragraph style that is used for the
            footnote/endnote text.
     */
    [property] string ParaStyleName;

    //-------------------------------------------------------------------------

    /** contains the prefix for the footnote/endnote symbol.
     */
    [property] string Prefix;

    //-------------------------------------------------------------------------

    /** contains the first number of the automatic numbering
        of footnotes/endnotes.
     */
    [property] short StartAt;

    //-------------------------------------------------------------------------

    /** contains the suffix for the footnote/endnote symbol.
     */
    [property] string Suffix;

    //-------------------------------------------------------------------------

    /** contains the string at the restart of the footnote
        text after a break.

        <p>For footnotes only.</p>
     */
    [optional, property] string BeginNotice;

    //-------------------------------------------------------------------------

    /** contains the string at the end of a footnote part in
        front of a break.

        <p>For footnotes only.</p>
     */
    [optional, property] string EndNotice;

    //-------------------------------------------------------------------------

    /** contains the type of the counting of the footnote numbers.

        <p>For footnotes only.</p>
        @see FootnoteNumbering
     */
    [optional, property] short FootnoteCounting;

    //-------------------------------------------------------------------------

    /** If <TRUE/>, the footnote text is shown at the end of the document.

        <p>For footnotes only.</p>
     */
    [optional, property] boolean PositionEndOfDoc;

    //-------------------------------------------------------------------------

    /** contains the name of the character style that is used
        for footnote/endnote anchor in the text.

        @since OOo 2.0
     */
    [optional, property] string AnchorCharStyleName;

};

//=============================================================================

}; }; }; };

#endif

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