xref: /AOO41X/main/offapi/com/sun/star/text/DocumentIndexFormat.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#ifndef __com_sun_star_text_DocumentIndexFormat_idl__
24#define __com_sun_star_text_DocumentIndexFormat_idl__
25
26
27//=============================================================================
28
29module com { module sun { module star { module text {
30
31//=============================================================================
32/** specifies the formatting of document indexes.
33
34    @deprecated
35        the service was never implemented, none of it's properties do exist.
36
37*/
38published service DocumentIndexFormat
39{
40    //-------------------------------------------------------------------------
41    /**     This property contains the name of the paragraph style that is
42    used for the index title.
43
44    */
45    [property] string TitleStyle;
46
47    //-------------------------------------------------------------------------
48    /**     This property contains the name of the paragraph style that is
49    used for the separator. This entry is ignored for user indexes
50    and content indexes.
51
52    */
53    [property] string SeparatorStyle;
54
55    //-------------------------------------------------------------------------
56    /** contains the number of levels in the document index.
57    */
58    [readonly, property] short LevelCount;
59
60    //-------------------------------------------------------------------------
61    /** This sequence contains the names of the paragraph styles that are
62        applied to the level corresponding to the position in the sequence.
63     */
64    [property] sequence<string> LevelStyles;
65
66    //-------------------------------------------------------------------------
67    /** This method specifies whether the form supports hyperlinks.
68    */
69    [readonly, property] boolean HasHyperlinks;
70
71    //-------------------------------------------------------------------------
72    /** return an object that provides the service "com.sun.star.text.DocumentIndexLevelFormat"
73     @see com.sun.star.text.DocumentIndexLevelFormat
74     */
75    [property] sequence<string> LevelFormat;
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83