xref: /aoo41x/main/offapi/com/sun/star/text/BaseIndex.idl (revision d1766043)
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
25#ifndef __com_sun_star_text_BaseIndex_idl__
26#define __com_sun_star_text_BaseIndex_idl__
27
28#ifndef __com_sun_star_util_Color_idl__
29#include <com/sun/star/util/Color.idl>
30#endif
31
32#ifndef __com_sun_star_text_XDocumentIndex_idl__
33#include <com/sun/star/text/XDocumentIndex.idl>
34#endif
35#ifndef _com_sun_star_container_XIndexReplace_idl__
36#include <com/sun/star/container/XIndexReplace.idl>
37#endif
38#ifndef _com_sun_star_text_XTextColumns_idl__
39#include <com/sun/star/text/XTextColumns.idl>
40#endif
41#ifndef __com_sun_star_style_GraphicLocation_idl__
42#include <com/sun/star/style/GraphicLocation.idl>
43#endif
44#ifndef __com_sun_star_lang_Locale_idl__
45#include <com/sun/star/lang/Locale.idl>
46#endif
47#ifndef _com_sun_star_text_XTextSection_idl__
48#include <com/sun/star/text/XTextSection.idl>
49#endif
50
51
52//=============================================================================
53
54 module com {  module sun {  module star {  module text {
55
56//=============================================================================
57
58// DocMerge from xml: service com::sun::star::text::BaseIndex
59/** specifies the basic service of different indexes within a document.@see com::sun::star::text::DocumentIndex
60		@see com::sun::star::text::ContentIndex
61		@see com::sun::star::text::UserDefinedIndex
62		@see com::sun::star::text::IllustrationIndex
63		@see com::sun::star::text::TableIndex
64		@see com::sun::star::text::ObjectIndex
65 */
66published service BaseIndex
67{
68	// DocMerge: empty anyway
69	interface com::sun::star::text::XDocumentIndex;
70
71	//-------------------------------------------------------------------------
72	/** contains the title of the index.*/
73
74	// DocMerge: empty anyway
75	[property] string Title;
76	/** determins if the index is protected.*/
77
78	// DocMerge: empty anyway
79	[property] boolean IsProtected;
80	/** contains the name of the paragraph style that is applied to the heading.*/
81
82	// DocMerge: empty anyway
83	[property] string ParaStyleHeading;
84	/** contains the name of the paragraph style that is applied to the 1st level.*/
85
86	// DocMerge: empty anyway
87	[property] string ParaStyleLevel1;
88	/** contains the name of the paragraph style that is applied to the 2nd level.*/
89
90	// DocMerge: empty anyway
91	[optional, property] string ParaStyleLevel2;
92	/** contains the name of the paragraph style that is applied to the 3rd level.*/
93
94	// DocMerge: empty anyway
95	[optional, property] string ParaStyleLevel3;
96	/** contains the name of the paragraph style that is applied to the 4th level.*/
97
98	// DocMerge: empty anyway
99	[optional, property] string ParaStyleLevel4;
100	/** contains the name of the paragraph style that is applied to the 5th level.*/
101
102	// DocMerge: empty anyway
103	[optional, property] string ParaStyleLevel5;
104	/** contains the name of the paragraph style that is applied to the 6th level.*/
105
106	// DocMerge: empty anyway
107	[optional, property] string ParaStyleLevel6;
108	/** contains the name of the paragraph style that is applied to the 7th level.*/
109
110	// DocMerge: empty anyway
111	[optional, property] string ParaStyleLevel7;
112	/** contains the name of the paragraph style that is applied to the 8th level.*/
113
114	// DocMerge: empty anyway
115	[optional, property] string ParaStyleLevel8;
116	/** contains the name of the paragraph style that is applied to the 9th level.*/
117
118	// DocMerge: empty anyway
119	[optional, property] string ParaStyleLevel9;
120	/** contains the name of the paragraph style that is applied to the 10th level.*/
121
122	// DocMerge: empty anyway
123	[optional, property] string ParaStyleLevel10;
124	/** contains the name of the paragraph style that is applied to the separator level.*/
125
126	// DocMerge: empty anyway
127	[optional, property] string ParaStyleSeparator;
128	/** contains the column interface.*/
129
130	// DocMerge: empty anyway
131	[property] XTextColumns TextColumns;
132	/** contains the URL of a graphic file that is displayed as background graphic*/
133
134	// DocMerge: empty anyway
135	[property] string BackGraphicURL;
136	/** contains the name of the filter of the graphic file that is
137	 	displayed as background graphic*/
138
139	// DocMerge: empty anyway
140	[property] string BackGraphicFilter;
141
142	// DocMerge from xml: property com::sun::star::text::BaseIndex::BackGraphicLocation
143	/** determines the position of the background graphic.@see GraphicLocation
144	 */
145	[property] com::sun::star::style::GraphicLocation BackGraphicLocation;
146
147	// DocMerge from xml: property com::sun::star::text::BaseIndex::BackTransparent
148	/** specifies the color of the background.
149	 */
150	[property] com::sun::star::util::Color BackColor;
151
152	/** If <TRUE/>, the background color value in "BackColor" is not visible.
153	 */
154	[property] boolean BackTransparent;
155
156	/** returns the interface of the level format of the index.
157	 <p>
158		The description of the format of the levels depends on the type of the document index.
159	 </p>
160	 @see DocumentIndexLevelFormat
161	 */
162	// DocMerge: empty anyway
163	[optional, property] com::sun::star::container::XIndexReplace LevelFormat;
164	/** determins if the content of the document index is created from the
165	 	complete document content or from the current chapter only.
166	 <p> It is not available in the bibliography</p>*/
167	[optional, property] boolean CreateFromChapter;
168    //------------------------------------------------------------------------
169	/** the text section containing the content of the index */
170	[property] com::sun::star::text::XTextSection ContentSection;
171    //------------------------------------------------------------------------
172    //------------------------------------------------------------------------
173	/** the text section containing the header of the index */
174	[property] com::sun::star::text::XTextSection HeaderSection;
175    //------------------------------------------------------------------------
176};
177
178//=============================================================================
179
180}; }; }; };
181
182#endif
183
184
185