offapi/com/sun/star/text/DocumentIndex.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28
  29 #ifndef __com_sun_star_text_DocumentIndex_idl__
  30 #define __com_sun_star_text_DocumentIndex_idl__
  31
  32 #include <com/sun/star/text/BaseIndex.idl>
  33 #ifndef __com_sun_star_text_XDocumentIndexMark_idl__
  34 #include <com/sun/star/text/XDocumentIndexMark.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com {  module sun {  module star {  module text {
  40
  41 //=============================================================================
  42
  43 /** specifies service of content indexes within a document.@see com::sun::star::text::BaseIndex
  44  */
  45 published service DocumentIndex
  46 {
  47     service  com::sun::star::text::BaseIndex;
  48
  49     /** determins if alphabetical separators are genererated.
  50      */
  51     [optional, property] boolean UseAlphabeticalSeparators;
  52
  53     /** determins if a index entry is generated for each primary/secondary key.
  54      */
  55     [optional, property] boolean UseKeyAsEntry;
  56
  57     /** determins if same entries on different pages are combined into one index entry.
  58      */
  59     [optional, property] boolean UseCombinedEntries;
  60
  61     /** determins if the similarity of index entries is checked case sensitively.
  62      */
  63     [optional, property] boolean IsCaseSensitive;
  64
  65     /** determins if following page numbers are displayed using a 'pp.'.
  66      */
  67     [optional, property] boolean UsePP;
  68
  69     /** determins if if following page numbers are displayed using a dash.
  70      */
  71     [optional, property] boolean UseDash;
  72
  73     /** determins if all entries start with a capital letter.
  74      */
  75     [optional, property] boolean UseUpperCase;
  76
  77     /** determins the name of the character style that is applied to the number
  78      of a page where main index entry is located.
  79      */
  80     [optional, property] string MainEntryCharacterStyleName;
  81
  82     /**
  83      contains all index marks that are related to this index.
  84      */
  85     [readonly, property] sequence <com::sun::star::text::XDocumentIndexMark> DocumentIndexMarks;
  86
  87     //------------------------------------------------------------------------
  88     /** contains the locale of the index.
  89      */
  90     [property] com::sun::star::lang::Locale  Locale;
  91
  92     //------------------------------------------------------------------------
  93     /** contains the name of the sort algorithm that is used to sort the entries.
  94      */
  95     [property] string SortAlgorithm;
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; };
 101
 102 #endif