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