LibreOffice: com/sun/star/text/TextSection.idl Source File

LibreOffice LibreOffice 7.3 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
22#include <com/sun/star/text/TextContent.idl>
23#include <com/sun/star/text/XTextSection.idl>
24#include <com/sun/star/container/XNamed.idl>
25#include <com/sun/star/beans/XPropertySet.idl>
26#include <com/sun/star/beans/XPropertyState.idl>
27#include <com/sun/star/text/SectionFileLink.idl>
28#include <com/sun/star/style/GraphicLocation.idl>
29#include <com/sun/star/text/XTextColumns.idl>
30#include <com/sun/star/xml/UserDefinedAttributesSupplier.idl>
31#include <com/sun/star/graphic/XGraphic.idl>
32
33module com { module sun { module star { module text {
34
45published service TextSection
46{
47 service com::sun::star::text::TextContent;
48
49 [optional] service com::sun::star::xml::UserDefinedAttributesSupplier;
50
51 interface com::sun::star::text::XTextSection;
52 interface com::sun::star::container::XNamed;
53 interface com::sun::star::beans::XPropertySet;
54 interface com::sun::star::beans::XPropertyState;
55
61 [property] string Condition;
62
65 [property] boolean IsVisible;
66
70 [property] boolean IsProtected;
71
76 [property] com::sun::star::text::SectionFileLink FileLink;
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
123 [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
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;
187 [property] com::sun::star::text::XTextColumns TextColumns;
190 [optional, property] long SectionLeftMargin;
193 [optional, property] long SectionRightMargin;
194
199 [optional, property] com::sun::star::graphic::XGraphic BackGraphic;
200};
201
202
203}; }; }; };
204
205#endif
206
207/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
GraphicLocation.idl
SectionFileLink.idl
TextContent.idl
UserDefinedAttributesSupplier.idl
XGraphic.idl
XNamed.idl
XPropertySet.idl
XPropertyState.idl
XTextColumns.idl
XTextSection.idl
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:64
com::sun::star::beans::XPropertyState
makes it possible to query information about the state of one or more properties.
Definition: XPropertyState.idl:49
com::sun::star::container::XNamed
specifies the name of the object.
Definition: XNamed.idl:33
com::sun::star::graphic::XGraphic
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:44
com::sun::star::text::XTextColumns
manages columns within the object.
Definition: XTextColumns.idl:41
com::sun::star::text::XTextSection
provide special data of a TextSection.
Definition: XTextSection.idl:31
com::sun::star::style::GraphicLocation
GraphicLocation
These enumeration values are used to specify the location of a graphic object within its surroundings...
Definition: GraphicLocation.idl:30
com
Definition: Ambiguous.idl:22
com::sun::star::text::TextContent
is an object which can be anchored in a text, like instances of TextFrame or TextField.
Definition: TextContent.idl:49
com::sun::star::text::TextSection
A TextSection is a range of complete paragraphs within a text.
Definition: TextSection.idl:46
com::sun::star::text::TextSection::SectionLeftMargin
long SectionLeftMargin
determines the left margin of the section
Definition: TextSection.idl:190
com::sun::star::text::TextSection::BackGraphicLocation
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the position of the background graphic.
Definition: TextSection.idl:123
com::sun::star::text::TextSection::DDECommandElement
string DDECommandElement
specifies the source element of the command string for a DDE operation.
Definition: TextSection.idl:101
com::sun::star::text::TextSection::Condition
string Condition
This property contains a conditional expression.
Definition: TextSection.idl:54
com::sun::star::text::TextSection::FootnoteIsCollectAtTextEnd
boolean FootnoteIsCollectAtTextEnd
determines whether footnotes inside the section are displayed at the end of the section text.
Definition: TextSection.idl:127
com::sun::star::text::TextSection::FootnoteRestartNumberingAt
short FootnoteRestartNumberingAt
determines at which number the footnote numbering inside of the section starts.
Definition: TextSection.idl:135
com::sun::star::text::TextSection::EndnoteIsOwnNumbering
boolean EndnoteIsOwnNumbering
determines whether the endnotes within the section use an own numbering format.
Definition: TextSection.idl:168
com::sun::star::text::TextSection::FootnoteNumberingSuffix
string FootnoteNumberingSuffix
determines the suffix that is display after of the footnote number.
Definition: TextSection.idl:152
com::sun::star::text::TextSection::SectionRightMargin
long SectionRightMargin
determines the left margin of the section
Definition: TextSection.idl:193
com::sun::star::text::TextSection::BackGraphic
com::sun::star::graphic::XGraphic BackGraphic
contains the graphic of the background.
Definition: TextSection.idl:199
com::sun::star::text::TextSection::BackGraphicURL
string BackGraphicURL
contains the URL for the background graphic.
Definition: TextSection.idl:113
com::sun::star::text::TextSection::EndnoteIsRestartNumbering
boolean EndnoteIsRestartNumbering
determines whether the endnotes numbering restarts within the section.
Definition: TextSection.idl:160
com::sun::star::text::TextSection::EndnoteNumberingSuffix
string EndnoteNumberingSuffix
determines the suffix that is display after the endnote number.
Definition: TextSection.idl:181
com::sun::star::text::TextSection::DDECommandType
string DDECommandType
specifies the type of the command string for a DDE operation.
Definition: TextSection.idl:92
com::sun::star::text::TextSection::FootnoteNumberingType
short FootnoteNumberingType
determines the numbering type of the footnote numbering as a value of com::sun::star::style::Numberin...
Definition: TextSection.idl:144
com::sun::star::text::TextSection::EndnoteRestartNumberingAt
short EndnoteRestartNumberingAt
determines at which number the endnote numbering inside of the section starts.
Definition: TextSection.idl:164
com::sun::star::text::TextSection::LinkRegion
string LinkRegion
specifies the source of a file link in the document that is specified in TextSection::FileLink.
Definition: TextSection.idl:87
com::sun::star::text::TextSection::IsVisible
boolean IsVisible
If this property is FALSE, the text section is hidden.
Definition: TextSection.idl:65
com::sun::star::text::TextSection::IsAutomaticUpdate
boolean IsAutomaticUpdate
determines if a DDE link is updated automatically.
Definition: TextSection.idl:184
com::sun::star::text::TextSection::IsProtected
boolean IsProtected
If this property is TRUE, the text section is protected and cannot be modified from the user interfac...
Definition: TextSection.idl:70
com::sun::star::text::TextSection::EndnoteNumberingPrefix
string EndnoteNumberingPrefix
determines the prefix that is display before the endnote number.
Definition: TextSection.idl:177
com::sun::star::text::TextSection::FootnoteNumberingPrefix
string FootnoteNumberingPrefix
determines the prefix that is display before the footnote number.
Definition: TextSection.idl:148
com::sun::star::text::TextSection::FileLink
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
com::sun::star::text::TextSection::TextColumns
com::sun::star::text::XTextColumns TextColumns
allows columns to be set into the text section
Definition: TextSection.idl:187
com::sun::star::text::TextSection::FootnoteIsRestartNumbering
boolean FootnoteIsRestartNumbering
determines whether the footnotes numbering restarts within the section.
Definition: TextSection.idl:131
com::sun::star::text::TextSection::BackGraphicFilter
string BackGraphicFilter
contains the name of the file filter for the background graphic.
Definition: TextSection.idl:117
com::sun::star::text::TextSection::FootnoteIsOwnNumbering
boolean FootnoteIsOwnNumbering
determines whether the footnotes within the section use an own numbering format.
Definition: TextSection.idl:139
com::sun::star::text::TextSection::DDECommandFile
string DDECommandFile
specifies the source file name of the command string for a DDE operation.
Definition: TextSection.idl:96
com::sun::star::text::TextSection::EndnoteNumberingType
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::TextSection::EndnoteIsCollectAtTextEnd
boolean EndnoteIsCollectAtTextEnd
determines whether endnotes inside the section are displayed at the end of the section text.
Definition: TextSection.idl:156
com::sun::star::xml::UserDefinedAttributesSupplier
A component that supports this service preserves XML attributes, unknown by its parser,...
Definition: UserDefinedAttributesSupplier.idl:33
com::sun::star::text::SectionFileLink
describes the link for a text section.
Definition: SectionFileLink.idl:45