offapi/com/sun/star/text/DocumentIndex.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 content indexes within a document.@see com::sun::star::text::BaseIndex
  26  */
  27 published service DocumentIndex
  28 {
  29     service  com::sun::star::text::BaseIndex;
  30
  31     /** determines if alphabetical separators are generated.
  32      */
  33     [optional, property] boolean UseAlphabeticalSeparators;
  34
  35     /** determines if an index entry is generated for each primary/secondary key.
  36      */
  37     [optional, property] boolean UseKeyAsEntry;
  38
  39     /** determines if same entries on different pages are combined into one index entry.
  40      */
  41     [optional, property] boolean UseCombinedEntries;
  42
  43     /** determines if the similarity of index entries is checked case sensitively.
  44      */
  45     [optional, property] boolean IsCaseSensitive;
  46
  47     /** determines if following page numbers are displayed using a "pp.".
  48      */
  49     [optional, property] boolean UsePP;
  50
  51     /** determines if following page numbers are displayed using a dash.
  52      */
  53     [optional, property] boolean UseDash;
  54
  55     /** determines if all entries start with a capital letter.
  56      */
  57     [optional, property] boolean UseUpperCase;
  58
  59     /** determines the name of the character style that is applied to the number
  60      of a page where main index entry is located.
  61      */
  62     [optional, property] string MainEntryCharacterStyleName;
  63
  64     /**
  65      contains all index marks that are related to this index.
  66      */
  67     [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks;
  68
  69     /** contains the locale of the index.
  70      */
  71     [property] com::sun::star::lang::Locale  Locale;
  72
  73     /** contains the name of the sort algorithm that is used to sort the entries.
  74      */
  75     [property] string SortAlgorithm;
  76 };
  77
  78
  79 }; }; }; };
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */