offapi/com/sun/star/text/fieldmaster/Bibliography.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: Bibliography.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
  31 #ifndef __com_sun_star_text_fieldmaster_Bibliography_idl_
  32 #define __com_sun_star_text_fieldmaster_Bibliography_idl_
  33
  34 #include <com/sun/star/text/TextFieldMaster.idl>
  35 #include <com/sun/star/beans/PropertyValues.idl>
  36 #include <com/sun/star/lang/Locale.idl>
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module text { module fieldmaster {
  41
  42 //=============================================================================
  43 /** specifies service of a Bibliography field master.
  44     @see com::sun::star::text::TextField
  45 */
  46 published service Bibliography
  47 {
  48     service  com::sun::star::text::TextFieldMaster;
  49
  50     //------------------------------------------------------------------------
  51     /** determins whether the bibiliography text fields are numbered. If <FALSE/> the
  52      short name of the bibliography entry is displayed instead.
  53      */
  54     [property] boolean IsNumberEntries;
  55     //------------------------------------------------------------------------
  56     /** determins whether the bibliography entries in a bibliography index are sorted
  57      by the document position. If <FALSE/> the SortKey property determins the
  58      sorting of the entries.
  59      */
  60     [property] boolean IsSortByPosition;
  61     //------------------------------------------------------------------------
  62     /** determins the opening bracket used to display the bibliography text fields.
  63      */
  64     [property] string BracketBefore;
  65     //------------------------------------------------------------------------
  66     /** determins the closing bracket used to display the bibliography text fields.
  67      */
  68     [property] string BracketAfter;
  69     //------------------------------------------------------------------------
  70     /** determins the sorting of the bibliography entries in a bibliography index.
  71         This property is used if the property IsSortByPosition is not set.
  72         Each contained element of the sequence is a sequence of the following
  73         two properties:
  74         <UL>
  75             <LI><P>[property] short SortKey;</P>
  76             <UL>
  77                 <LI><P>Determins the bibliography field that is used to sort by.</P>
  78             </UL>
  79             <LI><P>[property] boolean IsSortAscending;</P>
  80             <UL>
  81                 <LI><P>Determins wheter the sorting is ascending or descending.
  82                  It uses the type <type scope="com::sun::star::text">BibliographyDataField</type></P>
  83             </UL>
  84         </UL>
  85      */
  86     [property] sequence< com::sun::star::beans::PropertyValues >  SortKeys;
  87     //------------------------------------------------------------------------
  88     /** contains the locale of the field master
  89      */
  90     [property] com::sun::star::lang::Locale  Locale;
  91     //------------------------------------------------------------------------
  92     /** contains the name of the sort algorithm that is used to sort the text fields.
  93      */
  94     [property] string SortAlgorithm;
  95
  96 };
  97
  98 //=============================================================================
  99
 100 }; }; }; }; };
 101
 102 #endif
 103