xref: /trunk/main/offapi/com/sun/star/text/fieldmaster/Bibliography.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#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;

    //------------------------------------------------------------------------
    /** determins whether the bibiliography text fields are numbered. If <FALSE/> the
     short name of the bibliography entry is displayed instead.
     */
    [property] boolean IsNumberEntries;
    //------------------------------------------------------------------------
    /** determins whether the bibliography entries in a bibliography index are sorted
     by the document position. If <FALSE/> the SortKey property determins the
     sorting of the entries.
     */
    [property] boolean IsSortByPosition;
    //------------------------------------------------------------------------
    /** determins the opening bracket used to display the bibliography text fields.
     */
    [property] string BracketBefore;
    //------------------------------------------------------------------------
    /** determins the closing bracket used to display the bibliography text fields.
     */
    [property] string BracketAfter;
    //------------------------------------------------------------------------
    /** determins 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>Determins the bibliography field that is used to sort by.</P>
            </UL>
            <LI><P>[property] boolean IsSortAscending;</P>
            <UL>
                <LI><P>Determins wheter the sorting is ascending or descending.
                It uses the type <type scope="com::sun::star::text">BibliographyDataField</type></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