offapi/com/sun/star/text/BaseIndex.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: BaseIndex.idl,v $
  10  * $Revision: 1.17 $
  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_BaseIndex_idl__
  33 #define __com_sun_star_text_BaseIndex_idl__
  34
  35 #ifndef __com_sun_star_util_Color_idl__
  36 #include <com/sun/star/util/Color.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_text_XDocumentIndex_idl__
  40 #include <com/sun/star/text/XDocumentIndex.idl>
  41 #endif
  42 #ifndef _com_sun_star_container_XIndexReplace_idl__
  43 #include <com/sun/star/container/XIndexReplace.idl>
  44 #endif
  45 #ifndef _com_sun_star_text_XTextColumns_idl__
  46 #include <com/sun/star/text/XTextColumns.idl>
  47 #endif
  48 #ifndef __com_sun_star_style_GraphicLocation_idl__
  49 #include <com/sun/star/style/GraphicLocation.idl>
  50 #endif
  51 #ifndef __com_sun_star_lang_Locale_idl__
  52 #include <com/sun/star/lang/Locale.idl>
  53 #endif
  54 #ifndef _com_sun_star_text_XTextSection_idl__
  55 #include <com/sun/star/text/XTextSection.idl>
  56 #endif
  57
  58
  59 //=============================================================================
  60
  61  module com {  module sun {  module star {  module text {
  62
  63 //=============================================================================
  64
  65 // DocMerge from xml: service com::sun::star::text::BaseIndex
  66 /** specifies the basic service of different indexes within a document.@see com::sun::star::text::DocumentIndex
  67         @see com::sun::star::text::ContentIndex
  68         @see com::sun::star::text::UserDefinedIndex
  69         @see com::sun::star::text::IllustrationIndex
  70         @see com::sun::star::text::TableIndex
  71         @see com::sun::star::text::ObjectIndex
  72  */
  73 published service BaseIndex
  74 {
  75     // DocMerge: empty anyway
  76     interface com::sun::star::text::XDocumentIndex;
  77
  78     //-------------------------------------------------------------------------
  79     /** contains the title of the index.*/
  80
  81     // DocMerge: empty anyway
  82     [property] string Title;
  83     /** determins if the index is protected.*/
  84
  85     // DocMerge: empty anyway
  86     [property] boolean IsProtected;
  87     /** contains the name of the paragraph style that is applied to the heading.*/
  88
  89     // DocMerge: empty anyway
  90     [property] string ParaStyleHeading;
  91     /** contains the name of the paragraph style that is applied to the 1st level.*/
  92
  93     // DocMerge: empty anyway
  94     [property] string ParaStyleLevel1;
  95     /** contains the name of the paragraph style that is applied to the 2nd level.*/
  96
  97     // DocMerge: empty anyway
  98     [optional, property] string ParaStyleLevel2;
  99     /** contains the name of the paragraph style that is applied to the 3rd level.*/
 100
 101     // DocMerge: empty anyway
 102     [optional, property] string ParaStyleLevel3;
 103     /** contains the name of the paragraph style that is applied to the 4th level.*/
 104
 105     // DocMerge: empty anyway
 106     [optional, property] string ParaStyleLevel4;
 107     /** contains the name of the paragraph style that is applied to the 5th level.*/
 108
 109     // DocMerge: empty anyway
 110     [optional, property] string ParaStyleLevel5;
 111     /** contains the name of the paragraph style that is applied to the 6th level.*/
 112
 113     // DocMerge: empty anyway
 114     [optional, property] string ParaStyleLevel6;
 115     /** contains the name of the paragraph style that is applied to the 7th level.*/
 116
 117     // DocMerge: empty anyway
 118     [optional, property] string ParaStyleLevel7;
 119     /** contains the name of the paragraph style that is applied to the 8th level.*/
 120
 121     // DocMerge: empty anyway
 122     [optional, property] string ParaStyleLevel8;
 123     /** contains the name of the paragraph style that is applied to the 9th level.*/
 124
 125     // DocMerge: empty anyway
 126     [optional, property] string ParaStyleLevel9;
 127     /** contains the name of the paragraph style that is applied to the 10th level.*/
 128
 129     // DocMerge: empty anyway
 130     [optional, property] string ParaStyleLevel10;
 131     /** contains the name of the paragraph style that is applied to the separator level.*/
 132
 133     // DocMerge: empty anyway
 134     [optional, property] string ParaStyleSeparator;
 135     /** contains the column interface.*/
 136
 137     // DocMerge: empty anyway
 138     [property] XTextColumns TextColumns;
 139     /** contains the URL of a graphic file that is displayed as background graphic*/
 140
 141     // DocMerge: empty anyway
 142     [property] string BackGraphicURL;
 143     /** contains the name of the filter of the graphic file that is
 144          displayed as background graphic*/
 145
 146     // DocMerge: empty anyway
 147     [property] string BackGraphicFilter;
 148
 149     // DocMerge from xml: property com::sun::star::text::BaseIndex::BackGraphicLocation
 150     /** determines the position of the background graphic.@see GraphicLocation
 151      */
 152     [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
 153
 154     // DocMerge from xml: property com::sun::star::text::BaseIndex::BackTransparent
 155     /** specifies the color of the background.
 156      */
 157     [property] com::sun::star::util::Color BackColor;
 158
 159     /** If <TRUE/>, the background color value in "BackColor" is not visible.
 160      */
 161     [property] boolean BackTransparent;
 162
 163     /** returns the interface of the level format of the index.
 164      <p>
 165         The description of the format of the levels depends on the type of the document index.
 166      </p>
 167      @see DocumentIndexLevelFormat
 168      */
 169     // DocMerge: empty anyway
 170     [optional, property] com::sun::star::container::XIndexReplace LevelFormat;
 171     /** determins if the content of the document index is created from the
 172          complete document content or from the current chapter only.
 173      <p> It is not available in the bibliography</p>*/
 174     [optional, property] boolean CreateFromChapter;
 175     //------------------------------------------------------------------------
 176     /** the text section containing the content of the index */
 177     [property] com::sun::star::text::XTextSection ContentSection;
 178     //------------------------------------------------------------------------
 179     //------------------------------------------------------------------------
 180     /** the text section containing the header of the index */
 181     [property] com::sun::star::text::XTextSection HeaderSection;
 182     //------------------------------------------------------------------------
 183 };
 184
 185 //=============================================================================
 186
 187 }; }; }; };
 188
 189 #endif
 190
 191