offapi/com/sun/star/text/UserIndex.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 user defined indexes within a document.
  24     @see com::sun::star::text::BaseIndex
  25 */
  26 published service UserIndex
  27 {
  28     service  com::sun::star::text::BaseIndex;
  29
  30     /** contains the interface to access the paragraph style names that are included
  31      in this index.
  32      @see DocumentIndexParagraphStyles
  33      */
  34     [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles;
  35
  36     /** determines if the document index marks are included in this index.
  37      */
  38     [optional, property] boolean CreateFromMarks;
  39
  40     /** determines if the outline level of the location of the indexed object is
  41      used as index level of the index entry.*/
  42     [optional, property] boolean UseLevelFromSource;
  43
  44     /** determines if tables are included in the index.
  45      */
  46     [optional, property] boolean CreateFromTables;
  47
  48     /** determines if text frames are included in the index.
  49      */
  50     [optional, property] boolean CreateFromTextFrames;
  51
  52     /** determines if graphic objects are included in the index.
  53      */
  54     [optional, property] boolean CreateFromGraphicObjects;
  55
  56     /** determines if embedded objects are included in the index.
  57      */
  58     [optional, property] boolean CreateFromEmbeddedObjects;
  59     /** contains the name of the user index.
  60      */
  61     [property] string UserIndexName;
  62 };
  63
  64
  65 }; }; }; };
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */