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