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
28
29#ifndef __com_sun_star_text_UserDefinedIndex_idl__
30#define __com_sun_star_text_UserDefinedIndex_idl__
31
32#include <com/sun/star/text/BaseIndex.idl>
33#ifndef __com_sun_star_text_XDocumentIndexMark_idl__
34#include <com/sun/star/text/XDocumentIndexMark.idl>
35#endif
36
37//=============================================================================
38
39module com {  module sun {  module star {  module text {
40
41//=============================================================================
42
43/** specifies service of user defined indexes within a document.@see com::sun::star::text::BaseIndex
44 */
45published service UserDefinedIndex
46{
47	service  com::sun::star::text::BaseIndex;
48
49	/** contains the interface to access the paragraph style names that are included
50	 in this index.
51	 @see DocumentIndexParagraphStyles
52	 */
53	[optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles;
54
55	/** determins if the document index marks are included in this index.
56	 */
57	[optional, property] boolean CreateFromMarks;
58
59	/** determins if the outline level of the location of the indexed object is
60	 used as index level of the index entry.*/
61	[optional, property] boolean UseLevelFromSource;
62
63	/** determins if tables are included in the index.
64	 */
65	[optional, property] boolean CreateFromTables;
66
67	/** determins if text frames are included in the index.
68	 */
69	[optional, property] boolean CreateFromTextFrames;
70
71	/** determins if graphic objects are included in the index.
72	 */
73	[optional, property] boolean CreateFromGraphicObjects;
74
75	/** determins if embedded objects are included in the index.
76	 */
77	[optional, property] boolean CreateFromEmbeddedObjects;
78
79	/**
80	 contains all index marks that are related to this index.
81	 */
82    [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks;
83};
84
85//=============================================================================
86
87}; }; }; };
88#endif
89
90