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