/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef __com_sun_star_text_fieldmaster_Bibliography_idl_
#define __com_sun_star_text_fieldmaster_Bibliography_idl_

#include <com/sun/star/text/TextFieldMaster.idl>
#include <com/sun/star/beans/PropertyValues.idl>
#include <com/sun/star/lang/Locale.idl>


module com { module sun { module star { module text { module fieldmaster {

/** specifies service of a Bibliography field master.
    @see com::sun::star::text::TextField
*/
published service Bibliography
{
    service  com::sun::star::text::TextFieldMaster;

    /** determines whether the bibliography text fields are numbered. If `FALSE` the
     short name of the bibliography entry is displayed instead.
     */
    [property] boolean IsNumberEntries;
    /** determines whether the bibliography entries in a bibliography index are sorted
     by the document position. If `FALSE` the SortKey property determines the
     sorting of the entries.
     */
    [property] boolean IsSortByPosition;
    /** determines the opening bracket used to display the bibliography text fields.
     */
    [property] string BracketBefore;
    /** determines the closing bracket used to display the bibliography text fields.
     */
    [property] string BracketAfter;
    /** determines the sorting of the bibliography entries in a bibliography index.
        This property is used if the property IsSortByPosition is not set.
        Each contained element of the sequence is a sequence of the following
        two properties:
        <UL>
            <LI><P>[property] short SortKey;</P>
            <UL>
                <LI><P>Determines the bibliography field that is used to sort by.</P>
            </UL>
            <LI><P>[property] boolean IsSortAscending;</P>
            <UL>
                <LI><P>Determines whether the sorting is ascending or descending.
                 It uses the type com::sun::star::text::BibliographyDataField</P>
            </UL>
        </UL>
     */
    [property] sequence< com::sun::star::beans::PropertyValues >  SortKeys;
    /** contains the locale of the field master
     */
    [property] com::sun::star::lang::Locale  Locale;
    /** contains the name of the sort algorithm that is used to sort the text fields.
     */
    [property] string SortAlgorithm;

};


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
