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