xref: /aoo42x/main/offapi/com/sun/star/text/BaseIndex.idl (revision c6798233)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_text_BaseIndex_idl__
25#define __com_sun_star_text_BaseIndex_idl__
26
27#ifndef __com_sun_star_util_Color_idl__
28#include <com/sun/star/util/Color.idl>
29#endif
30
31#ifndef __com_sun_star_text_XDocumentIndex_idl__
32#include <com/sun/star/text/XDocumentIndex.idl>
33#endif
34#ifndef _com_sun_star_container_XIndexReplace_idl__
35#include <com/sun/star/container/XIndexReplace.idl>
36#endif
37#ifndef _com_sun_star_text_XTextColumns_idl__
38#include <com/sun/star/text/XTextColumns.idl>
39#endif
40#ifndef __com_sun_star_style_GraphicLocation_idl__
41#include <com/sun/star/style/GraphicLocation.idl>
42#endif
43#ifndef __com_sun_star_lang_Locale_idl__
44#include <com/sun/star/lang/Locale.idl>
45#endif
46#ifndef _com_sun_star_text_XTextSection_idl__
47#include <com/sun/star/text/XTextSection.idl>
48#endif
49
50
51//=============================================================================
52
53 module com { module sun { module star { module text {
54
55//=============================================================================
56
57// DocMerge from xml: service com::sun::star::text::BaseIndex
58/** specifies the basic service of different indexes within a document.@see com::sun::star::text::DocumentIndex
59		@see com::sun::star::text::ContentIndex
60		@see com::sun::star::text::UserDefinedIndex
61		@see com::sun::star::text::IllustrationsIndex
62		@see com::sun::star::text::TableIndex
63		@see com::sun::star::text::ObjectIndex
64 */
65published service BaseIndex
66{
67	// DocMerge: empty anyway
68	interface com::sun::star::text::XDocumentIndex;
69
70	//-------------------------------------------------------------------------
71	/** contains the title of the index.*/
72
73	// DocMerge: empty anyway
74	[property] string Title;
75	/** determines if the index is protected.*/
76
77	// DocMerge: empty anyway
78	[property] boolean IsProtected;
79	/** contains the name of the paragraph style that is applied to the heading.*/
80
81	// DocMerge: empty anyway
82	[property] string ParaStyleHeading;
83	/** contains the name of the paragraph style that is applied to the 1st level.*/
84
85	// DocMerge: empty anyway
86	[property] string ParaStyleLevel1;
87	/** contains the name of the paragraph style that is applied to the 2nd level.*/
88
89	// DocMerge: empty anyway
90	[optional, property] string ParaStyleLevel2;
91	/** contains the name of the paragraph style that is applied to the 3rd level.*/
92
93	// DocMerge: empty anyway
94	[optional, property] string ParaStyleLevel3;
95	/** contains the name of the paragraph style that is applied to the 4th level.*/
96
97	// DocMerge: empty anyway
98	[optional, property] string ParaStyleLevel4;
99	/** contains the name of the paragraph style that is applied to the 5th level.*/
100
101	// DocMerge: empty anyway
102	[optional, property] string ParaStyleLevel5;
103	/** contains the name of the paragraph style that is applied to the 6th level.*/
104
105	// DocMerge: empty anyway
106	[optional, property] string ParaStyleLevel6;
107	/** contains the name of the paragraph style that is applied to the 7th level.*/
108
109	// DocMerge: empty anyway
110	[optional, property] string ParaStyleLevel7;
111	/** contains the name of the paragraph style that is applied to the 8th level.*/
112
113	// DocMerge: empty anyway
114	[optional, property] string ParaStyleLevel8;
115	/** contains the name of the paragraph style that is applied to the 9th level.*/
116
117	// DocMerge: empty anyway
118	[optional, property] string ParaStyleLevel9;
119	/** contains the name of the paragraph style that is applied to the 10th level.*/
120
121	// DocMerge: empty anyway
122	[optional, property] string ParaStyleLevel10;
123	/** contains the name of the paragraph style that is applied to the separator level.*/
124
125	// DocMerge: empty anyway
126	[optional, property] string ParaStyleSeparator;
127	/** contains the column interface.*/
128
129	// DocMerge: empty anyway
130	[property] XTextColumns TextColumns;
131	/** contains the URL of a graphic file that is displayed as background graphic*/
132
133	// DocMerge: empty anyway
134	[property] string BackGraphicURL;
135	/** contains the name of the filter of the graphic file that is
136	 	displayed as background graphic*/
137
138	// DocMerge: empty anyway
139	[property] string BackGraphicFilter;
140
141	// DocMerge from xml: property com::sun::star::text::BaseIndex::BackGraphicLocation
142	/** determines the position of the background graphic.@see GraphicLocation
143	 */
144	[property] com::sun::star::style::GraphicLocation BackGraphicLocation;
145
146	// DocMerge from xml: property com::sun::star::text::BaseIndex::BackTransparent
147	/** specifies the color of the background.
148	 */
149	[property] com::sun::star::util::Color BackColor;
150
151	/** If <TRUE/>, the background color value in "BackColor" is not visible.
152	 */
153	[property] boolean BackTransparent;
154
155	/** returns the interface of the level format of the index.
156	 <p>
157		The description of the format of the levels depends on the type of the document index.
158	 </p>
159	 @see DocumentIndexLevelFormat
160	 */
161	// DocMerge: empty anyway
162	[optional, property] com::sun::star::container::XIndexReplace LevelFormat;
163	/** determines if the content of the document index is created from the
164	 	complete document content or from the current chapter only.
165	 <p> It is not available in the bibliography</p>*/
166	[optional, property] boolean CreateFromChapter;
167	//------------------------------------------------------------------------
168	/** the text section containing the content of the index */
169	[property] com::sun::star::text::XTextSection ContentSection;
170	//------------------------------------------------------------------------
171	//------------------------------------------------------------------------
172	/** the text section containing the header of the index */
173	[property] com::sun::star::text::XTextSection HeaderSection;
174	//------------------------------------------------------------------------
175};
176
177//=============================================================================
178
179}; }; }; };
180
181#endif
182