1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24#ifndef __com_sun_star_text_fieldmaster_Bibliography_idl_ 25#define __com_sun_star_text_fieldmaster_Bibliography_idl_ 26 27#include <com/sun/star/text/TextFieldMaster.idl> 28#include <com/sun/star/beans/PropertyValues.idl> 29#include <com/sun/star/lang/Locale.idl> 30 31//============================================================================= 32 33module com { module sun { module star { module text { module fieldmaster { 34 35//============================================================================= 36/** specifies service of a Bibliography field master. 37 @see com::sun::star::text::TextField 38*/ 39published service Bibliography 40{ 41 service com::sun::star::text::TextFieldMaster; 42 43 //------------------------------------------------------------------------ 44 /** determins whether the bibiliography text fields are numbered. If <FALSE/> the 45 short name of the bibliography entry is displayed instead. 46 */ 47 [property] boolean IsNumberEntries; 48 //------------------------------------------------------------------------ 49 /** determins whether the bibliography entries in a bibliography index are sorted 50 by the document position. If <FALSE/> the SortKey property determins the 51 sorting of the entries. 52 */ 53 [property] boolean IsSortByPosition; 54 //------------------------------------------------------------------------ 55 /** determins the opening bracket used to display the bibliography text fields. 56 */ 57 [property] string BracketBefore; 58 //------------------------------------------------------------------------ 59 /** determins the closing bracket used to display the bibliography text fields. 60 */ 61 [property] string BracketAfter; 62 //------------------------------------------------------------------------ 63 /** determins the sorting of the bibliography entries in a bibliography index. 64 This property is used if the property IsSortByPosition is not set. 65 Each contained element of the sequence is a sequence of the following 66 two properties: 67 <UL> 68 <LI><P>[property] short SortKey;</P> 69 <UL> 70 <LI><P>Determins the bibliography field that is used to sort by.</P> 71 </UL> 72 <LI><P>[property] boolean IsSortAscending;</P> 73 <UL> 74 <LI><P>Determins wheter the sorting is ascending or descending. 75 It uses the type <type scope="com::sun::star::text">BibliographyDataField</type></P> 76 </UL> 77 </UL> 78 */ 79 [property] sequence< com::sun::star::beans::PropertyValues > SortKeys; 80 //------------------------------------------------------------------------ 81 /** contains the locale of the field master 82 */ 83 [property] com::sun::star::lang::Locale Locale; 84 //------------------------------------------------------------------------ 85 /** contains the name of the sort algorithm that is used to sort the text fields. 86 */ 87 [property] string SortAlgorithm; 88 89}; 90 91//============================================================================= 92 93}; }; }; }; }; 94 95#endif 96 97