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