xref: /AOO41X/main/offapi/com/sun/star/text/ContentIndex.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_ContentIndex_idl__
26#define __com_sun_star_text_ContentIndex_idl__
27
28#include <com/sun/star/text/BaseIndex.idl>
29
30//=============================================================================
31
32module com {  module sun {  module star {  module text {
33
34//=============================================================================
35
36/** specifies service of content indexes within a document.@see com::sun::star::text::BaseIndex
37 */
38published service ContentIndex
39{
40    // DocMerge: empty anyway
41    service  com::sun::star::text::BaseIndex;
42
43    /** determins the depth of outline levels that are included into the content index.*/
44
45    /// @missing
46    [optional, property] short Level;
47
48    /** determins if the document index is created from outlines.
49    */
50    [optional, property] boolean CreateFromOutline;
51
52    /** contains the interface to access the paragraph style names that are included
53     in this index.
54     @see DocumentIndexParagraphStyles
55     */
56    [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles;
57
58    /** contains <TRUE/> if the document index marks are included in this index.
59    */
60    [optional, property] boolean CreateFromMarks;
61
62
63};
64
65//=============================================================================
66
67}; }; }; };
68
69#endif
70
71