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 module com {  module sun {  module star {  module text {
  21
  22 /** specifies the basic service of different indexes within a document.@see com::sun::star::text::DocumentIndex
  23         @see com::sun::star::text::ContentIndex
  24         @see com::sun::star::text::UserDefinedIndex
  25         @see com::sun::star::text::IllustrationsIndex
  26         @see com::sun::star::text::TableIndex
  27         @see com::sun::star::text::ObjectIndex
  28  */
  29 published service BaseIndex
  30 {
  31     interface com::sun::star::text::XDocumentIndex;
  32
  33     /** @since LibreOffice 4.0 */
  34     [optional] interface com::sun::star::util::XRefreshable;
  35
  36     /** contains the title of the index.*/
  37     [property] string Title;
  38     /** determines if the index is protected.*/
  39     [property] boolean IsProtected;
  40     /** contains the name of the paragraph style that is applied to the heading.*/
  41     [property] string ParaStyleHeading;
  42     /** contains the name of the paragraph style that is applied to the 1st level.*/
  43     [property] string ParaStyleLevel1;
  44     /** contains the name of the paragraph style that is applied to the 2nd level.*/
  45     [optional, property] string ParaStyleLevel2;
  46     /** contains the name of the paragraph style that is applied to the 3rd level.*/
  47     [optional, property] string ParaStyleLevel3;
  48     /** contains the name of the paragraph style that is applied to the 4th level.*/
  49     [optional, property] string ParaStyleLevel4;
  50     /** contains the name of the paragraph style that is applied to the 5th level.*/
  51     [optional, property] string ParaStyleLevel5;
  52     /** contains the name of the paragraph style that is applied to the 6th level.*/
  53     [optional, property] string ParaStyleLevel6;
  54     /** contains the name of the paragraph style that is applied to the 7th level.*/
  55     [optional, property] string ParaStyleLevel7;
  56     /** contains the name of the paragraph style that is applied to the 8th level.*/
  57     [optional, property] string ParaStyleLevel8;
  58     /** contains the name of the paragraph style that is applied to the 9th level.*/
  59     [optional, property] string ParaStyleLevel9;
  60     /** contains the name of the paragraph style that is applied to the 10th level.*/
  61     [optional, property] string ParaStyleLevel10;
  62     /** contains the name of the paragraph style that is applied to the separator level.*/
  63     [optional, property] string ParaStyleSeparator;
  64     /** contains the column interface.*/
  65     [property] XTextColumns TextColumns;
  66
  67     /** contains the URL of a graphic file that is displayed as background graphic
  68
  69         @deprecated as of LibreOffice 6.1 - use BackGraphic instead
  70
  71         Note the new behaviour since it this was deprecated:
  72         This property can only be set and only external URLs are
  73         supported (no more vnd.sun.star.GraphicObject scheme). When an
  74         URL is set, then it will load the graphic and set the BackGraphic
  75         property.
  76     */
  77     [property] string BackGraphicURL;
  78
  79     /** contains the name of the filter of the graphic file that is
  80          displayed as background graphic*/
  81     [property] string BackGraphicFilter;
  82     /** determines the position of the background graphic.@see GraphicLocation
  83      */
  84     [property] com::sun::star::style::GraphicLocation BackGraphicLocation;
  85     /** specifies the color of the background.
  86      */
  87     [property] com::sun::star::util::Color BackColor;
  88
  89     /** If `TRUE`, the background color value in "BackColor" is not visible.
  90      */
  91     [property] boolean BackTransparent;
  92
  93     /** returns the interface of the level format of the index.
  94      <p>
  95         The description of the format of the levels depends on the type of the document index.
  96      </p>
  97      @see DocumentIndexLevelFormat
  98      */
  99     [optional, property] com::sun::star::container::XIndexReplace LevelFormat;
 100     /** determines if the content of the document index is created from the
 101          complete document content or from the current chapter only.
 102      <p> It is not available in the bibliography</p>*/
 103     [optional, property] boolean CreateFromChapter;
 104     /** the text section containing the content of the index */
 105     [property] com::sun::star::text::XTextSection ContentSection;
 106     /** the text section containing the header of the index */
 107     [property] com::sun::star::text::XTextSection HeaderSection;
 108
 109     /** contains the graphic object that is displayed as background graphic.
 110
 111         @since LibreOffice 6.1
 112     */
 113     [optional, property] com::sun::star::graphic::XGraphic BackGraphic;
 114 };
 115
 116
 117 }; }; }; };
 118
 119
 120 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */