offapi/com/sun/star/text/ContentIndex.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: ContentIndex.idl,v $
  10  * $Revision: 1.8 $
  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_ContentIndex_idl__
  33 #define __com_sun_star_text_ContentIndex_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 content indexes within a document.@see com::sun::star::text::BaseIndex
  44  */
  45 published service ContentIndex
  46 {
  47     // DocMerge: empty anyway
  48     service  com::sun::star::text::BaseIndex;
  49
  50     /** determins the depth of outline levels that are included into the content index.*/
  51
  52     /// @missing
  53     [optional, property] short Level;
  54
  55     /** determins if the document index is created from outlines.
  56     */
  57     [optional, property] boolean CreateFromOutline;
  58
  59     /** contains the interface to access the paragraph style names that are included
  60      in this index.
  61      @see DocumentIndexParagraphStyles
  62      */
  63     [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles;
  64
  65     /** contains <TRUE/> if the document index marks are included in this index.
  66     */
  67     [optional, property] boolean CreateFromMarks;
  68
  69
  70 };
  71
  72 //=============================================================================
  73
  74 }; }; }; };
  75
  76 #endif
  77