offapi/com/sun/star/text/BaseIndex.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21 #ifndef __com_sun_star_text_BaseIndex_idl__
  22 #define __com_sun_star_text_BaseIndex_idl__
  23
  24 #include <com/sun/star/util/Color.idl>
  25 #include <com/sun/star/util/XRefreshable.idl>
  26 #include <com/sun/star/text/XDocumentIndex.idl>
  27 #include <com/sun/star/container/XIndexReplace.idl>
  28 #include <com/sun/star/text/XTextColumns.idl>
  29 #include <com/sun/star/style/GraphicLocation.idl>
  30 #include <com/sun/star/lang/Locale.idl>
  31 #include <com/sun/star/text/XTextSection.idl>
  32
  33
  34  module com {  module sun {  module star {  module text {
  35
  36 /** specifies the basic service of different indexes within a document.@see com::sun::star::text::DocumentIndex
  37         @see com::sun::star::text::ContentIndex
  38         @see com::sun::star::text::UserDefinedIndex
  39         @see com::sun::star::text::IllustrationsIndex
  40         @see com::sun::star::text::TableIndex
  41         @see com::sun::star::text::ObjectIndex
  42  */
  43 published service BaseIndex
  44 {
  45     interface com::sun::star::text::XDocumentIndex;
  46
  47     /** @since LibreOffice 4.0 */
  48     [optional] interface com::sun::star::util::XRefreshable;
  49
  50     /** contains the title of the index.*/
  51     [property] string Title;
  52     /** determines if the index is protected.*/
  53     [property] boolean IsProtected;
  54     /** contains the name of the paragraph style that is applied to the heading.*/
  55     [property] string ParaStyleHeading;
  56     /** contains the name of the paragraph style that is applied to the 1st level.*/
  57     [property] string ParaStyleLevel1;
  58     /** contains the name of the paragraph style that is applied to the 2nd level.*/
  59     [optional, property] string ParaStyleLevel2;
  60     /** contains the name of the paragraph style that is applied to the 3rd level.*/
  61     [optional, property] string ParaStyleLevel3;
  62     /** contains the name of the paragraph style that is applied to the 4th level.*/
  63     [optional, property] string ParaStyleLevel4;
  64     /** contains the name of the paragraph style that is applied to the 5th level.*/
  65     [optional, property] string ParaStyleLevel5;
  66     /** contains the name of the paragraph style that is applied to the 6th level.*/
  67     [optional, property] string ParaStyleLevel6;
  68     /** contains the name of the paragraph style that is applied to the 7th level.*/
  69     [optional, property] string ParaStyleLevel7;
  70     /** contains the name of the paragraph style that is applied to the 8th level.*/
  71     [optional, property] string ParaStyleLevel8;
  72     /** contains the name of the paragraph style that is applied to the 9th level.*/
  73     [optional, property] string ParaStyleLevel9;
  74     /** contains the name of the paragraph style that is applied to the 10th level.*/
  75     [optional, property] string ParaStyleLevel10;
  76     /** contains the name of the paragraph style that is applied to the separator level.*/
  77     [optional, property] string ParaStyleSeparator;
  78     /** contains the column interface.*/
  79     [property] XTextColumns TextColumns;
  80     /** contains the URL of a graphic file that is displayed as background graphic*/
  81     [property] string BackGraphicURL;
  82     /** contains the name of the filter of the graphic file that is
  83          displayed as background graphic*/
  84     [property] string BackGraphicFilter;
  85     /** determines the position of the background graphic.@see GraphicLocation
  86      */
  87     [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
  88     /** specifies the color of the background.
  89      */
  90     [property] com::sun::star::util::Color BackColor;
  91
  92     /** If `TRUE`, the background color value in "BackColor" is not visible.
  93      */
  94     [property] boolean BackTransparent;
  95
  96     /** returns the interface of the level format of the index.
  97      <p>
  98         The description of the format of the levels depends on the type of the document index.
  99      </p>
 100      @see DocumentIndexLevelFormat
 101      */
 102     [optional, property] com::sun::star::container::XIndexReplace LevelFormat;
 103     /** determines if the content of the document index is created from the
 104          complete document content or from the current chapter only.
 105      <p> It is not available in the bibliography</p>*/
 106     [optional, property] boolean CreateFromChapter;
 107     /** the text section containing the content of the index */
 108     [property] com::sun::star::text::XTextSection ContentSection;
 109     /** the text section containing the header of the index */
 110     [property] com::sun::star::text::XTextSection HeaderSection;
 111 };
 112
 113
 114 }; }; }; };
 115
 116 #endif
 117
 118
 119 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */