offapi/com/sun/star/text/IllustrationsIndex.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 module com { module sun { module star { module text {
  22
  23 /** specifies service of illustration indexes within a document.
  24     @see com::sun::star::text::BaseIndex
  25 */
  26 published service IllustrationsIndex
  27 {
  28     service  com::sun::star::text::BaseIndex;
  29
  30     /* determines if the name or the label of an object is used to create the index.
  31      */
  32     [optional, property] boolean CreateFromLabels; //tables, illustrations
  33     /* determines the name of the sequence field that is evaluated to create the index.
  34      */
  35     [optional, property] string LabelCategory; //tables, illustrations
  36     /* determines the way the paragraph containing a label is included in the index.
  37         @see ChapterFormat*/
  38     [optional, property] short LabelDisplayType;//tables, illustrations
  39
  40     /** determines if paragraphs with one particular style applied are
  41         included in the index.
  42         @since LibreOffice 7.6
  43      */
  44     [optional, property, maybevoid] string CreateFromParagraphStyle;
  45 };
  46
  47 }; }; }; };
  48
  49 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */