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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DocumentIndexFormat.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_text_DocumentIndexFormat_idl__
  31 #define __com_sun_star_text_DocumentIndexFormat_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module text {
  37
  38 //=============================================================================
  39 /** specifies the formatting of document indexes.
  40
  41     @deprecated
  42         the service was never implemented, none of it's properties do exist.
  43
  44 */
  45 published service DocumentIndexFormat
  46 {
  47     //-------------------------------------------------------------------------
  48     /**         This property contains the name of the paragraph style that is
  49     used for the index title.
  50
  51     */
  52     [property] string TitleStyle;
  53
  54     //-------------------------------------------------------------------------
  55     /**         This property contains the name of the paragraph style that is
  56     used for the separator. This entry is ignored for user indexes
  57     and content indexes.
  58
  59     */
  60     [property] string SeparatorStyle;
  61
  62     //-------------------------------------------------------------------------
  63     /** contains the number of levels in the document index.
  64     */
  65     [readonly, property] short LevelCount;
  66
  67     //-------------------------------------------------------------------------
  68     /** This sequence contains the names of the paragraph styles that are
  69          applied to the level corresponding to the position in the sequence.
  70      */
  71     [property] sequence<string> LevelStyles;
  72
  73     //-------------------------------------------------------------------------
  74     /** This method specifies whether the form supports hyperlinks.
  75     */
  76     [readonly, property] boolean HasHyperlinks;
  77
  78     //-------------------------------------------------------------------------
  79     /** return an object that provides the service "com.sun.star.text.DocumentIndexLevelFormat"
  80      @see com.sun.star.text.DocumentIndexLevelFormat
  81      */
  82     [property] sequence<string> LevelFormat;
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif