summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/IllustrationsIndex.idl
blob: a2555cb13043c4cae8d51f475dbfcd7f8f17e38d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: IllustrationsIndex.idl,v $
 *
 * $Revision: 1.3 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_text_IllustrationsIndex_idl__
#define __com_sun_star_text_IllustrationsIndex_idl__

#include <com/sun/star/text/BaseIndex.idl>

//=============================================================================

module com { module sun { module star { module text {

//=============================================================================
/** specifies service of illustration indexes within a document.
    @see com::sun::star::text::BaseIndex
*/
published service IllustrationsIndex
{
    service  com::sun::star::text::BaseIndex;

    /* determins if the name or the label of an object is used to create the index.
     */
    [optional, property] boolean CreateFromLabels; //tables, illustrations
    /* determins the name of the sequence field that is evaluated to create the index.
     */
    [optional, property] string LabelCategory; //tables, illustrations
    /* determins the way the paragraph containing a label is included in the index.
        @see ChapterFormat*/
    [optional, property] short LabelDisplayType;//tables, illustrations
};

//=============================================================================

}; }; }; };

#endif