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