LibreOffice LibreOffice 25.8 SDK API Reference

BaseIndex.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
20module com { module sun { module star { module text {
21
29published service BaseIndex
30{
31 interface com::sun::star::text::XDocumentIndex;
32
34 [optional] interface com::sun::star::util::XRefreshable;
35
37 [property] string Title;
39 [property] boolean IsProtected;
41 [property] string ParaStyleHeading;
43 [property] string ParaStyleLevel1;
45 [optional, property] string ParaStyleLevel2;
47 [optional, property] string ParaStyleLevel3;
49 [optional, property] string ParaStyleLevel4;
51 [optional, property] string ParaStyleLevel5;
53 [optional, property] string ParaStyleLevel6;
55 [optional, property] string ParaStyleLevel7;
57 [optional, property] string ParaStyleLevel8;
59 [optional, property] string ParaStyleLevel9;
61 [optional, property] string ParaStyleLevel10;
63 [optional, property] string ParaStyleSeparator;
65 [property] XTextColumns TextColumns;
66
77 [property] string BackGraphicURL;
78
81 [property] string BackGraphicFilter;
84 [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
87 [property] com::sun::star::util::Color BackColor;
88
91 [property] boolean BackTransparent;
92
99 [optional, property] com::sun::star::container::XIndexReplace LevelFormat;
103 [optional, property] boolean CreateFromChapter;
105 [property] com::sun::star::text::XTextSection ContentSection;
107 [property] com::sun::star::text::XTextSection HeaderSection;
108
113 [optional, property] com::sun::star::graphic::XGraphic BackGraphic;
114};
115
116
117}; }; }; };
118
119
120/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::XIndexReplace
This is the generic interface for supporting the replacement of indexed elements.
Definition: XIndexReplace.idl:29
com::sun::star::graphic::XGraphic
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:38
com::sun::star::text::XDocumentIndex
This is the main interface for a document index.
Definition: XDocumentIndex.idl:43
com::sun::star::text::XTextColumns
manages columns within the object.
Definition: XTextColumns.idl:35
com::sun::star::text::XTextSection
provide special data of a TextSection.
Definition: XTextSection.idl:27
com::sun::star::util::XRefreshable
is supported by objects with data that can be refreshed from a data source.
Definition: XRefreshable.idl:28
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:28
com::sun::star::util::Color
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:34
com
Definition: Ambiguous.idl:20
com::sun::star::text::BaseIndex
specifies the basic service of different indexes within a document.
Definition: BaseIndex.idl:30
com::sun::star::text::BaseIndex::BackGraphicLocation
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the position of the background graphic.
Definition: BaseIndex.idl:84
com::sun::star::text::BaseIndex::ParaStyleHeading
string ParaStyleHeading
contains the name of the paragraph style that is applied to the heading.
Definition: BaseIndex.idl:41
com::sun::star::text::BaseIndex::ParaStyleLevel1
string ParaStyleLevel1
contains the name of the paragraph style that is applied to the 1st level.
Definition: BaseIndex.idl:43
com::sun::star::text::BaseIndex::ParaStyleLevel9
string ParaStyleLevel9
contains the name of the paragraph style that is applied to the 9th level.
Definition: BaseIndex.idl:59
com::sun::star::text::BaseIndex::ContentSection
com::sun::star::text::XTextSection ContentSection
the text section containing the content of the index
Definition: BaseIndex.idl:105
com::sun::star::text::BaseIndex::ParaStyleLevel7
string ParaStyleLevel7
contains the name of the paragraph style that is applied to the 7th level.
Definition: BaseIndex.idl:55
com::sun::star::text::BaseIndex::ParaStyleLevel6
string ParaStyleLevel6
contains the name of the paragraph style that is applied to the 6th level.
Definition: BaseIndex.idl:53
com::sun::star::text::BaseIndex::BackColor
com::sun::star::util::Color BackColor
specifies the color of the background.
Definition: BaseIndex.idl:87
com::sun::star::text::BaseIndex::BackGraphic
com::sun::star::graphic::XGraphic BackGraphic
contains the graphic object that is displayed as background graphic.
Definition: BaseIndex.idl:113
com::sun::star::text::BaseIndex::BackGraphicURL
string BackGraphicURL
contains the URL of a graphic file that is displayed as background graphic
Definition: BaseIndex.idl:77
com::sun::star::text::BaseIndex::LevelFormat
com::sun::star::container::XIndexReplace LevelFormat
returns the interface of the level format of the index.
Definition: BaseIndex.idl:99
com::sun::star::text::BaseIndex::TextColumns
XTextColumns TextColumns
contains the column interface.
Definition: BaseIndex.idl:65
com::sun::star::text::BaseIndex::ParaStyleLevel3
string ParaStyleLevel3
contains the name of the paragraph style that is applied to the 3rd level.
Definition: BaseIndex.idl:47
com::sun::star::text::BaseIndex::ParaStyleLevel10
string ParaStyleLevel10
contains the name of the paragraph style that is applied to the 10th level.
Definition: BaseIndex.idl:61
com::sun::star::text::BaseIndex::Title
string Title
contains the title of the index.
Definition: BaseIndex.idl:34
com::sun::star::text::BaseIndex::IsProtected
boolean IsProtected
determines if the index is protected.
Definition: BaseIndex.idl:39
com::sun::star::text::BaseIndex::ParaStyleLevel4
string ParaStyleLevel4
contains the name of the paragraph style that is applied to the 4th level.
Definition: BaseIndex.idl:49
com::sun::star::text::BaseIndex::ParaStyleLevel5
string ParaStyleLevel5
contains the name of the paragraph style that is applied to the 5th level.
Definition: BaseIndex.idl:51
com::sun::star::text::BaseIndex::BackGraphicFilter
string BackGraphicFilter
contains the name of the filter of the graphic file that is displayed as background graphic
Definition: BaseIndex.idl:81
com::sun::star::text::BaseIndex::CreateFromChapter
boolean CreateFromChapter
determines if the content of the document index is created from the complete document content or from...
Definition: BaseIndex.idl:103
com::sun::star::text::BaseIndex::ParaStyleLevel8
string ParaStyleLevel8
contains the name of the paragraph style that is applied to the 8th level.
Definition: BaseIndex.idl:57
com::sun::star::text::BaseIndex::BackTransparent
boolean BackTransparent
If TRUE, the background color value in "BackColor" is not visible.
Definition: BaseIndex.idl:91
com::sun::star::text::BaseIndex::ParaStyleLevel2
string ParaStyleLevel2
contains the name of the paragraph style that is applied to the 2nd level.
Definition: BaseIndex.idl:45
com::sun::star::text::BaseIndex::ParaStyleSeparator
string ParaStyleSeparator
contains the name of the paragraph style that is applied to the separator level.
Definition: BaseIndex.idl:63
com::sun::star::text::BaseIndex::HeaderSection
com::sun::star::text::XTextSection HeaderSection
the text section containing the header of the index
Definition: BaseIndex.idl:107