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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: TableIndex.idl,v $
  10  * $Revision: 1.11 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31
  32 #ifndef __com_sun_star_text_TableIndex_idl__
  33 #define __com_sun_star_text_TableIndex_idl__
  34
  35 #include <com/sun/star/text/BaseIndex.idl>
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module text {
  40
  41 //=============================================================================
  42
  43 /** specifies service of table indexes within a document.
  44     @see com::sun::star::text::BaseIndex
  45  */
  46 published service TableIndex
  47 {
  48     service  com::sun::star::text::BaseIndex;
  49
  50     //-------------------------------------------------------------------------
  51     /** determines if the name or the label of an object is used to create the index.
  52      */
  53     [optional, property] boolean CreateFromLabels; //tables, illustrations
  54
  55     //-------------------------------------------------------------------------
  56     /** determines the name of the sequence field that is evaluated to create the index.
  57      */
  58     [optional, property] string LabelCategory; //tables, illustrations
  59
  60     //-------------------------------------------------------------------------
  61     /** determines the way the paragraph containing a label is included in the index.
  62         @see ReferenceFieldPart allowed constant values: only TEXT, CATEGORY_AND_NUMBER and
  63         ONLY_CAPTION
  64      */
  65     [optional, property] short LabelDisplayType;//tables, illustrations
  66 };
  67
  68 //=============================================================================
  69
  70 }; }; }; };
  71
  72 #endif
  73
  74