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