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