offapi/com/sun/star/text/ContentIndex.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 #ifndef __com_sun_star_text_ContentIndex_idl__
  22 #define __com_sun_star_text_ContentIndex_idl__
  23
  24 #include <com/sun/star/text/BaseIndex.idl>
  25
  26
  27 module com {  module sun {  module star {  module text {
  28
  29
  30 /** specifies service of content indexes within a document.@see com::sun::star::text::BaseIndex
  31  */
  32 published service ContentIndex
  33 {
  34     service  com::sun::star::text::BaseIndex;
  35
  36     /** determines the depth of outline levels that are included into the content index.*/
  37
  38     [optional, property] short Level;
  39
  40     /** determines if the document index is created from outlines.
  41     */
  42     [optional, property] boolean CreateFromOutline;
  43
  44     /** contains the interface to access the paragraph style names that are included
  45      in this index.
  46      @see DocumentIndexParagraphStyles
  47      */
  48     [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles;
  49
  50     /** contains `TRUE` if the document index marks are included in this index.
  51     */
  52     [optional, property] boolean CreateFromMarks;
  53
  54
  55 };
  56
  57
  58 }; }; }; };
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */