offapi/com/sun/star/text/TableIndex.idl

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