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