xref: /aoo42x/main/offapi/com/sun/star/text/TableIndex.idl (revision d1766043)
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_TableIndex_idl__
26#define __com_sun_star_text_TableIndex_idl__
27
28#include <com/sun/star/text/BaseIndex.idl>
29
30//=============================================================================
31
32 module com {  module sun {  module star {  module text {
33
34//=============================================================================
35
36/** specifies service of table indexes within a document.
37    @see com::sun::star::text::BaseIndex
38 */
39published service TableIndex
40{
41	service  com::sun::star::text::BaseIndex;
42
43    //-------------------------------------------------------------------------
44	/** determines if the name or the label of an object is used to create the index.
45	 */
46	[optional, property] boolean CreateFromLabels; //tables, illustrations
47
48    //-------------------------------------------------------------------------
49    /** determines the name of the sequence field that is evaluated to create the index.
50	 */
51    [optional, property] string LabelCategory; //tables, illustrations
52
53    //-------------------------------------------------------------------------
54	/** determines the way the paragraph containing a label is included in the index.
55        @see ReferenceFieldPart allowed constant values: only TEXT, CATEGORY_AND_NUMBER and
56		ONLY_CAPTION
57     */
58	[optional, property] short LabelDisplayType;//tables, illustrations
59};
60
61//=============================================================================
62
63}; }; }; };
64
65#endif
66
67
68