LibreOffice
LibreOffice 6.2 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 
20 #ifndef __com_sun_star_text_BaseIndex_idl__
21 #define __com_sun_star_text_BaseIndex_idl__
22 
32 
33 module com { module sun { module star { module text {
34 
42 published service BaseIndex
43 {
45 
47  [optional] interface com::sun::star::util::XRefreshable;
48 
50  [property] string Title;
52  [property] boolean IsProtected;
54  [property] string ParaStyleHeading;
56  [property] string ParaStyleLevel1;
58  [optional, property] string ParaStyleLevel2;
60  [optional, property] string ParaStyleLevel3;
62  [optional, property] string ParaStyleLevel4;
64  [optional, property] string ParaStyleLevel5;
66  [optional, property] string ParaStyleLevel6;
68  [optional, property] string ParaStyleLevel7;
70  [optional, property] string ParaStyleLevel8;
72  [optional, property] string ParaStyleLevel9;
74  [optional, property] string ParaStyleLevel10;
76  [optional, property] string ParaStyleSeparator;
79 
90  [property] string BackGraphicURL;
91 
94  [property] string BackGraphicFilter;
101 
104  [property] boolean BackTransparent;
105 
116  [optional, property] boolean CreateFromChapter;
121 
127 };
128 
129 
130 }; }; }; };
131 
132 #endif
133 
134 
135 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::text::XTextSection ContentSection
the text section containing the content of the index
Definition: BaseIndex.idl:118
This is the generic interface for supporting the replacement of indexed elements. ...
Definition: XIndexReplace.idl:38
This is the main interface for a document index.
Definition: XDocumentIndex.idl:46
string Title
contains the title of the index.
Definition: BaseIndex.idl:47
com::sun::star::text::XTextSection HeaderSection
the text section containing the header of the index
Definition: BaseIndex.idl:120
string ParaStyleHeading
contains the name of the paragraph style that is applied to the heading.
Definition: BaseIndex.idl:54
com::sun::star::util::Color BackColor
specifies the color of the background.
Definition: BaseIndex.idl:100
Definition: Ambiguous.idl:22
boolean CreateFromChapter
determines if the content of the document index is created from the complete document content or from...
Definition: BaseIndex.idl:116
string ParaStyleLevel5
contains the name of the paragraph style that is applied to the 5th level.
Definition: BaseIndex.idl:64
string ParaStyleLevel6
contains the name of the paragraph style that is applied to the 6th level.
Definition: BaseIndex.idl:66
XTextColumns TextColumns
contains the column interface.
Definition: BaseIndex.idl:78
This interface acts as a container for the loaded graphic.
Definition: XGraphic.idl:43
GraphicLocation
These enumeration values are used to specify the location of a graphic object within its surroundings...
Definition: GraphicLocation.idl:29
string ParaStyleLevel8
contains the name of the paragraph style that is applied to the 8th level.
Definition: BaseIndex.idl:70
string ParaStyleLevel2
contains the name of the paragraph style that is applied to the 2nd level.
Definition: BaseIndex.idl:58
string ParaStyleLevel4
contains the name of the paragraph style that is applied to the 4th level.
Definition: BaseIndex.idl:62
string ParaStyleSeparator
contains the name of the paragraph style that is applied to the separator level.
Definition: BaseIndex.idl:76
string ParaStyleLevel1
contains the name of the paragraph style that is applied to the 1st level.
Definition: BaseIndex.idl:56
string ParaStyleLevel7
contains the name of the paragraph style that is applied to the 7th level.
Definition: BaseIndex.idl:68
string BackGraphicURL
contains the URL of a graphic file that is displayed as background graphic
Definition: BaseIndex.idl:90
string BackGraphicFilter
contains the name of the filter of the graphic file that is displayed as background graphic ...
Definition: BaseIndex.idl:94
boolean IsProtected
determines if the index is protected.
Definition: BaseIndex.idl:52
com::sun::star::graphic::XGraphic BackGraphic
contains the graphic object that is displayed as background graphic.
Definition: BaseIndex.idl:126
boolean BackTransparent
If TRUE, the background color value in "BackColor" is not visible.
Definition: BaseIndex.idl:104
is supported by objects with data that can be refreshed from a data source.
Definition: XRefreshable.idl:33
string ParaStyleLevel9
contains the name of the paragraph style that is applied to the 9th level.
Definition: BaseIndex.idl:72
com::sun::star::style::GraphicLocation BackGraphicLocation
determines the position of the background graphic.
Definition: BaseIndex.idl:97
specifies the basic service of different indexes within a document.
Definition: BaseIndex.idl:42
string ParaStyleLevel3
contains the name of the paragraph style that is applied to the 3rd level.
Definition: BaseIndex.idl:60
string ParaStyleLevel10
contains the name of the paragraph style that is applied to the 10th level.
Definition: BaseIndex.idl:74
com::sun::star::container::XIndexReplace LevelFormat
returns the interface of the level format of the index.
Definition: BaseIndex.idl:112
provide special data of a TextSection.
Definition: XTextSection.idl:30
long Color
describes an RGB color value with an optional alpha channel.
Definition: Color.idl:36
manages columns within the object.
Definition: XTextColumns.idl:40