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