offapi/com/sun/star/text/UserIndex.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: UserIndex.idl,v $
  10  * $Revision: 1.9 $
  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 #ifndef __com_sun_star_text_UserIndex_idl__
  32 #define __com_sun_star_text_UserIndex_idl__
  33
  34 #include <com/sun/star/text/BaseIndex.idl>
  35
  36 //=============================================================================
  37
  38 module com { module sun { module star { module text {
  39
  40 //=============================================================================
  41 /**     specifies service of user defined indexes within a document.
  42     @see com::sun::star::text::BaseIndex
  43 */
  44 published service UserIndex
  45 {
  46     service  com::sun::star::text::BaseIndex;
  47
  48     /** contains the interface to access the paragraph style names that are included
  49      in this index.
  50      @see DocumentIndexParagraphStyles
  51      */
  52     [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles;
  53
  54     /** determins if the document index marks are included in this index.
  55      */
  56     [optional, property] boolean CreateFromMarks;
  57
  58     /** determins if the outline level of the location of the indexed object is
  59      used as index level of the index entry.*/
  60     [optional, property] boolean UseLevelFromSource;
  61
  62     /** determins if tables are included in the index.
  63      */
  64     [optional, property] boolean CreateFromTables;
  65
  66     /** determins if text frames are included in the index.
  67      */
  68     [optional, property] boolean CreateFromTextFrames;
  69
  70     /** determins if graphic objects are included in the index.
  71      */
  72     [optional, property] boolean CreateFromGraphicObjects;
  73
  74     /** determins if embedded objects are included in the index.
  75      */
  76     [optional, property] boolean CreateFromEmbeddedObjects;
  77     /** contains the name of the user index.
  78      */
  79     [property] string UserIndexName;
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 #endif
  87