offapi/com/sun/star/text/IllustrationsIndex.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: IllustrationsIndex.idl,v $
  10  *
  11  * $Revision: 1.3 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #ifndef __com_sun_star_text_IllustrationsIndex_idl__
  33 #define __com_sun_star_text_IllustrationsIndex_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 /**     specifies service of illustration indexes within a document.
  43     @see com::sun::star::text::BaseIndex
  44 */
  45 published service IllustrationsIndex
  46 {
  47     service  com::sun::star::text::BaseIndex;
  48
  49     /* determins if the name or the label of an object is used to create the index.
  50      */
  51     [optional, property] boolean CreateFromLabels; //tables, illustrations
  52     /* determins the name of the sequence field that is evaluated to create the index.
  53      */
  54     [optional, property] string LabelCategory; //tables, illustrations
  55     /* determins the way the paragraph containing a label is included in the index.
  56         @see ChapterFormat*/
  57     [optional, property] short LabelDisplayType;//tables, illustrations
  58 };
  59
  60 //=============================================================================
  61
  62 }; }; }; };
  63
  64 #endif
  65