1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_text_DocumentIndexFormat_idl__
28#define __com_sun_star_text_DocumentIndexFormat_idl__
29
30
31//=============================================================================
32
33module com { module sun { module star { module text {
34
35//=============================================================================
36/** specifies the formatting of document indexes.
37
38    @deprecated
39        the service was never implemented, none of it's properties do exist.
40
41*/
42published service DocumentIndexFormat
43{
44	//-------------------------------------------------------------------------
45	/** 	This property contains the name of the paragraph style that is
46	used for the index title.
47
48	*/
49	[property] string TitleStyle;
50
51	//-------------------------------------------------------------------------
52	/** 	This property contains the name of the paragraph style that is
53	used for the separator. This entry is ignored for user indexes
54	and content indexes.
55
56	*/
57	[property] string SeparatorStyle;
58
59	//-------------------------------------------------------------------------
60	/**	contains the number of levels in the document index.
61	*/
62	[readonly, property] short LevelCount;
63
64	//-------------------------------------------------------------------------
65	/** This sequence contains the names of the paragraph styles that are
66	 	applied to the level corresponding to the position in the sequence.
67	 */
68	[property] sequence<string> LevelStyles;
69
70	//-------------------------------------------------------------------------
71	/**	This method specifies whether the form supports hyperlinks.
72	*/
73	[readonly, property] boolean HasHyperlinks;
74
75	//-------------------------------------------------------------------------
76	/** return an object that provides the service "com.sun.star.text.DocumentIndexLevelFormat"
77	 @see com.sun.star.text.DocumentIndexLevelFormat
78	 */
79	[property] sequence<string> LevelFormat;
80};
81
82//=============================================================================
83
84}; }; }; };
85
86#endif
87