/* -*- 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_UserIndex_idl__
#define __com_sun_star_text_UserIndex_idl__

#include <com/sun/star/text/BaseIndex.idl>


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

/** specifies service of user defined indexes within a document.
    @see com::sun::star::text::BaseIndex
*/
published service UserIndex
{
    service  com::sun::star::text::BaseIndex;

    /** contains the interface to access the paragraph style names that are included
     in this index.
     @see DocumentIndexParagraphStyles
     */
    [optional, property] com::sun::star::container::XIndexReplace LevelParagraphStyles;

    /** determines if the document index marks are included in this index.
     */
    [optional, property] boolean CreateFromMarks;

    /** determines if the outline level of the location of the indexed object is
     used as index level of the index entry.*/
    [optional, property] boolean UseLevelFromSource;

    /** determines if tables are included in the index.
     */
    [optional, property] boolean CreateFromTables;

    /** determines if text frames are included in the index.
     */
    [optional, property] boolean CreateFromTextFrames;

    /** determines if graphic objects are included in the index.
     */
    [optional, property] boolean CreateFromGraphicObjects;

    /** determines if embedded objects are included in the index.
     */
    [optional, property] boolean CreateFromEmbeddedObjects;
    /** contains the name of the user index.
     */
    [property] string UserIndexName;
};


}; }; }; };

#endif

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