LibreOffice
LibreOffice 6.2 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 
32 
33 module com { module sun { module star { module text {
34 
45 published service TextSection
46 {
48 
50 
55 
61  [property] string Condition;
62 
65  [property] boolean IsVisible;
66 
70  [property] boolean IsProtected;
71 
77 
87  [property] string LinkRegion;
88 
92  [property] string DDECommandType;
93 
96  [property] string DDECommandFile;
97 
101  [property] string DDECommandElement;
102 
113  [property] string BackGraphicURL;
114 
117  [property] string BackGraphicFilter;
118 
127  [property] boolean FootnoteIsCollectAtTextEnd;
131  [property] boolean FootnoteIsRestartNumbering;
135  [property] short FootnoteRestartNumberingAt;
139  [property] boolean FootnoteIsOwnNumbering;
144  [property] short FootnoteNumberingType;
148  [property] string FootnoteNumberingPrefix;
152  [property] string FootnoteNumberingSuffix;
156  [property] boolean EndnoteIsCollectAtTextEnd;
160  [property] boolean EndnoteIsRestartNumbering;
164  [property] short EndnoteRestartNumberingAt;
168  [property] boolean EndnoteIsOwnNumbering;
173  [property] short EndnoteNumberingType;
177  [property] string EndnoteNumberingPrefix;
181  [property] string EndnoteNumberingSuffix;
184  [property] boolean IsAutomaticUpdate;
190  [optional, property] long SectionLeftMargin;
193  [optional, property] long SectionRightMargin;
194 
200 };
201 
202 
203 }; }; }; };
204 
205 #endif
206 
207 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
long SectionLeftMargin
determines the left margin of the section
Definition: TextSection.idl:190
specifies the name of the object.
Definition: XNamed.idl:32
long SectionRightMargin
determines the left margin of the section
Definition: TextSection.idl:193
boolean EndnoteIsCollectAtTextEnd
determines whether endnotes inside the section are displayed at the end of the section text...
Definition: TextSection.idl:156
string BackGraphicFilter
contains the name of the file filter for the background graphic.
Definition: TextSection.idl:117
boolean FootnoteIsCollectAtTextEnd
determines whether footnotes inside the section are displayed at the end of the section text...
Definition: TextSection.idl:127
string LinkRegion
specifies the source of a file link in the document that is specified in TextSection::FileLink.
Definition: TextSection.idl:87
string DDECommandElement
specifies the source element of the command string for a DDE operation.
Definition: TextSection.idl:101
boolean IsProtected
If this property is TRUE, the text section is protected and cannot be modified from the user interfac...
Definition: TextSection.idl:70
string FootnoteNumberingPrefix
determines the prefix that is display before the footnote number.
Definition: TextSection.idl:148
boolean IsAutomaticUpdate
determines if a DDE link is updated automatically.
Definition: TextSection.idl:184
short FootnoteRestartNumberingAt
determines at which number the footnote numbering inside of the section starts.
Definition: TextSection.idl:135
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:92
short EndnoteRestartNumberingAt
determines at which number the endnote numbering inside of the section starts.
Definition: TextSection.idl:164
boolean EndnoteIsOwnNumbering
determines whether the endnotes within the section use an own numbering format.
Definition: TextSection.idl:168
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:144
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:43
string BackGraphicURL
contains the URL for the background graphic.
Definition: TextSection.idl:113
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:160
com::sun::star::graphic::XGraphic BackGraphic
contains the graphic of the background.
Definition: TextSection.idl:199
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:76
boolean FootnoteIsOwnNumbering
determines whether the footnotes within the section use an own numbering format.
Definition: TextSection.idl:139
string Condition
This property contains a conditional expression.
Definition: TextSection.idl:54
string EndnoteNumberingPrefix
determines the prefix that is display before the endnote number.
Definition: TextSection.idl:177
boolean IsVisible
If this property is FALSE, the text section is hidden.
Definition: TextSection.idl:65
string EndnoteNumberingSuffix
determines the suffix that is display after the endnote number.
Definition: TextSection.idl:181
string DDECommandFile
specifies the source file name of the command string for a DDE operation.
Definition: TextSection.idl:96
short EndnoteNumberingType
determines the numbering type of the endnote numbering as a value of com::sun::star::style::Numbering...
Definition: TextSection.idl:173
com::sun::star::text::XTextColumns TextColumns
allows columns to be set into the text section
Definition: TextSection.idl:187
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:131
string FootnoteNumberingSuffix
determines the suffix that is display after of the footnote number.
Definition: TextSection.idl:152
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the position of the background graphic.
Definition: TextSection.idl:123
A TextSection is a range of complete paragraphs within a text.
Definition: TextSection.idl:45
manages columns within the object.
Definition: XTextColumns.idl:40