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