xref: /aoo42x/main/offapi/com/sun/star/text/ContentIndex.idl (revision cdf0e10c)

/*************************************************************************
 *
 * 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_ContentIndex_idl__
#define __com_sun_star_text_ContentIndex_idl__

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

//=============================================================================

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

//=============================================================================

/** specifies service of content indexes within a document.@see com::sun::star::text::BaseIndex
 */
published service ContentIndex
{
	// DocMerge: empty anyway
	service  com::sun::star::text::BaseIndex;

	/** determins the depth of outline levels that are included into the content index.*/

	/// @missing
	[optional, property] short Level;

	/** determins if the document index is created from outlines.
	*/
	[optional, property] boolean CreateFromOutline;

	/** 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;

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


};

//=============================================================================

}; }; }; };

#endif