LibreOffice
LibreOffice 6.0 SDK API Reference
TextSection.idl
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef __com_sun_star_text_TextSection_idl__
20 #define __com_sun_star_text_TextSection_idl__
21 
31 
32 
33 
34 module com { module sun { module star { module text {
35 
46 published service TextSection
47 {
49 
51 
56 
62  [property] string Condition;
63 
66  [property] boolean IsVisible;
67 
71  [property] boolean IsProtected;
72 
78 
88  [property] string LinkRegion;
89 
93  [property] string DDECommandType;
94 
97  [property] string DDECommandFile;
98 
102  [property] string DDECommandElement;
103 
106  [property] string BackGraphicURL;
107 
110  [property] string BackGraphicFilter;
111 
120  [property] boolean FootnoteIsCollectAtTextEnd;
124  [property] boolean FootnoteIsRestartNumbering;
128  [property] short FootnoteRestartNumberingAt;
132  [property] boolean FootnoteIsOwnNumbering;
137  [property] short FootnoteNumberingType;
141  [property] string FootnoteNumberingPrefix;
145  [property] string FootnoteNumberingSuffix;
149  [property] boolean EndnoteIsCollectAtTextEnd;
153  [property] boolean EndnoteIsRestartNumbering;
157  [property] short EndnoteRestartNumberingAt;
161  [property] boolean EndnoteIsOwnNumbering;
166  [property] short EndnoteNumberingType;
170  [property] string EndnoteNumberingPrefix;
174  [property] string EndnoteNumberingSuffix;
177  [property] boolean IsAutomaticUpdate;
183  [optional, property] long SectionLeftMargin;
186  [optional, property] long SectionRightMargin;
187 };
188 
189 
190 }; }; }; };
191 
192 #endif
193 
194 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
long SectionLeftMargin
determines the left margin of the section
Definition: TextSection.idl:183
specifies the name of the object.
Definition: XNamed.idl:32
long SectionRightMargin
determines the left margin of the section
Definition: TextSection.idl:186
boolean EndnoteIsCollectAtTextEnd
determines whether endnotes inside the section are displayed at the end of the section text...
Definition: TextSection.idl:149
string BackGraphicFilter
contains the name of the file filter for the background graphic.
Definition: TextSection.idl:110
boolean FootnoteIsCollectAtTextEnd
determines whether footnotes inside the section are displayed at the end of the section text...
Definition: TextSection.idl:120
string LinkRegion
specifies the source of a file link in the document that is specified in TextSection::FileLink.
Definition: TextSection.idl:88
string DDECommandElement
specifies the source element of the command string for a DDE operation.
Definition: TextSection.idl:102
boolean IsProtected
If this property is TRUE, the text section is protected and cannot be modified from the user interfac...
Definition: TextSection.idl:71
string FootnoteNumberingPrefix
determines the prefix that is display before the footnote number.
Definition: TextSection.idl:141
boolean IsAutomaticUpdate
determines if a DDE link is updated automatically.
Definition: TextSection.idl:177
short FootnoteRestartNumberingAt
determines at which number the footnote numbering inside of the section starts.
Definition: TextSection.idl:128
Definition: Ambiguous.idl:22
makes it possible to query information about the state of one or more properties. ...
Definition: XPropertyState.idl:48
string DDECommandType
specifies the type of the command string for a DDE operation.
Definition: TextSection.idl:93
short EndnoteRestartNumberingAt
determines at which number the endnote numbering inside of the section starts.
Definition: TextSection.idl:157
boolean EndnoteIsOwnNumbering
determines whether the endnotes within the section use an own numbering format.
Definition: TextSection.idl:161
is an object which can be anchored in a text, like instances of TextFrame or TextField.
Definition: TextContent.idl:48
short FootnoteNumberingType
determines the numbering type of the footnote numbering as a value of com::sun::star::style::Numberin...
Definition: TextSection.idl:137
string BackGraphicURL
contains the URL for the background graphic.
Definition: TextSection.idl:106
GraphicLocation
These enumeration values are used to specify the location of a graphic object within its surroundings...
Definition: GraphicLocation.idl:29
A component that supports this service preserves XML attributes, unknown by its parser, that belong to the XML element representing it (the component).
Definition: UserDefinedAttributesSupplier.idl:32
boolean EndnoteIsRestartNumbering
determines whether the endnotes numbering restarts within the section.
Definition: TextSection.idl:153
com::sun::star::text::SectionFileLink FileLink
If this property is set, then the content of the section is read from the specified document...
Definition: TextSection.idl:77
boolean FootnoteIsOwnNumbering
determines whether the footnotes within the section use an own numbering format.
Definition: TextSection.idl:132
string Condition
This property contains a conditional expression.
Definition: TextSection.idl:55
string EndnoteNumberingPrefix
determines the prefix that is display before the endnote number.
Definition: TextSection.idl:170
boolean IsVisible
If this property is FALSE, the text section is hidden.
Definition: TextSection.idl:66
string EndnoteNumberingSuffix
determines the suffix that is display after the endnote number.
Definition: TextSection.idl:174
string DDECommandFile
specifies the source file name of the command string for a DDE operation.
Definition: TextSection.idl:97
short EndnoteNumberingType
determines the numbering type of the endnote numbering as a value of com::sun::star::style::Numbering...
Definition: TextSection.idl:166
com::sun::star::text::XTextColumns TextColumns
allows columns to be set into the text section
Definition: TextSection.idl:180
provide special data of a TextSection.
Definition: XTextSection.idl:30
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:63
boolean FootnoteIsRestartNumbering
determines whether the footnotes numbering restarts within the section.
Definition: TextSection.idl:124
string FootnoteNumberingSuffix
determines the suffix that is display after of the footnote number.
Definition: TextSection.idl:145
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the position of the background graphic.
Definition: TextSection.idl:116
A TextSection is a range of complete paragraphs within a text.
Definition: TextSection.idl:46
manages columns within the object.
Definition: XTextColumns.idl:40