xref: /aoo4110/main/offapi/com/sun/star/text/UserIndex.idl (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski/**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_text_UserIndex_idl__
25*b1cdbd2cSJim Jagielski#define __com_sun_star_text_UserIndex_idl__
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski#include <com/sun/star/text/BaseIndex.idl>
28*b1cdbd2cSJim Jagielski
29*b1cdbd2cSJim Jagielski//=============================================================================
30*b1cdbd2cSJim Jagielski
31*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module text {
32*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielski//=============================================================================
34*b1cdbd2cSJim Jagielski/**	specifies service of user defined indexes within a document.
35*b1cdbd2cSJim Jagielski	@see com::sun::star::text::BaseIndex
36*b1cdbd2cSJim Jagielski*/
37*b1cdbd2cSJim Jagielskipublished service UserIndex
38*b1cdbd2cSJim Jagielski{
39*b1cdbd2cSJim Jagielski	service  com::sun::star::text::BaseIndex;
40*b1cdbd2cSJim Jagielski
41*b1cdbd2cSJim Jagielski	/** contains the interface to access the paragraph style names that are included
42*b1cdbd2cSJim Jagielski	 in this index.
43*b1cdbd2cSJim Jagielski	 @see DocumentIndexParagraphStyles
44*b1cdbd2cSJim Jagielski	 */
45*b1cdbd2cSJim Jagielski	[optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles;
46*b1cdbd2cSJim Jagielski
47*b1cdbd2cSJim Jagielski	/** determins if the document index marks are included in this index.
48*b1cdbd2cSJim Jagielski	 */
49*b1cdbd2cSJim Jagielski	[optional, property] boolean CreateFromMarks;
50*b1cdbd2cSJim Jagielski
51*b1cdbd2cSJim Jagielski	/** determins if the outline level of the location of the indexed object is
52*b1cdbd2cSJim Jagielski	 used as index level of the index entry.*/
53*b1cdbd2cSJim Jagielski	[optional, property] boolean UseLevelFromSource;
54*b1cdbd2cSJim Jagielski
55*b1cdbd2cSJim Jagielski	/** determins if tables are included in the index.
56*b1cdbd2cSJim Jagielski	 */
57*b1cdbd2cSJim Jagielski	[optional, property] boolean CreateFromTables;
58*b1cdbd2cSJim Jagielski
59*b1cdbd2cSJim Jagielski	/** determins if text frames are included in the index.
60*b1cdbd2cSJim Jagielski	 */
61*b1cdbd2cSJim Jagielski	[optional, property] boolean CreateFromTextFrames;
62*b1cdbd2cSJim Jagielski
63*b1cdbd2cSJim Jagielski	/** determins if graphic objects are included in the index.
64*b1cdbd2cSJim Jagielski	 */
65*b1cdbd2cSJim Jagielski	[optional, property] boolean CreateFromGraphicObjects;
66*b1cdbd2cSJim Jagielski
67*b1cdbd2cSJim Jagielski	/** determins if embedded objects are included in the index.
68*b1cdbd2cSJim Jagielski	 */
69*b1cdbd2cSJim Jagielski	[optional, property] boolean CreateFromEmbeddedObjects;
70*b1cdbd2cSJim Jagielski    /** contains the name of the user index.
71*b1cdbd2cSJim Jagielski	 */
72*b1cdbd2cSJim Jagielski    [property] string UserIndexName;
73*b1cdbd2cSJim Jagielski};
74*b1cdbd2cSJim Jagielski
75*b1cdbd2cSJim Jagielski//=============================================================================
76*b1cdbd2cSJim Jagielski
77*b1cdbd2cSJim Jagielski}; }; }; };
78*b1cdbd2cSJim Jagielski
79*b1cdbd2cSJim Jagielski#endif
80*b1cdbd2cSJim Jagielski
81