xref: /aoo42x/main/offapi/com/sun/star/text/BaseIndex.idl (revision c6798233)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_text_BaseIndex_idl__
#define __com_sun_star_text_BaseIndex_idl__

#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif

#ifndef __com_sun_star_text_XDocumentIndex_idl__
#include <com/sun/star/text/XDocumentIndex.idl>
#endif
#ifndef _com_sun_star_container_XIndexReplace_idl__
#include <com/sun/star/container/XIndexReplace.idl>
#endif
#ifndef _com_sun_star_text_XTextColumns_idl__
#include <com/sun/star/text/XTextColumns.idl>
#endif
#ifndef __com_sun_star_style_GraphicLocation_idl__
#include <com/sun/star/style/GraphicLocation.idl>
#endif
#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif
#ifndef _com_sun_star_text_XTextSection_idl__
#include <com/sun/star/text/XTextSection.idl>
#endif


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

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

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

// DocMerge from xml: service com::sun::star::text::BaseIndex
/** specifies the basic service of different indexes within a document.@see com::sun::star::text::DocumentIndex
		@see com::sun::star::text::ContentIndex
		@see com::sun::star::text::UserDefinedIndex
		@see com::sun::star::text::IllustrationsIndex
		@see com::sun::star::text::TableIndex
		@see com::sun::star::text::ObjectIndex
 */
published service BaseIndex
{
	// DocMerge: empty anyway
	interface com::sun::star::text::XDocumentIndex;

	//-------------------------------------------------------------------------
	/** contains the title of the index.*/

	// DocMerge: empty anyway
	[property] string Title;
	/** determines if the index is protected.*/

	// DocMerge: empty anyway
	[property] boolean IsProtected;
	/** contains the name of the paragraph style that is applied to the heading.*/

	// DocMerge: empty anyway
	[property] string ParaStyleHeading;
	/** contains the name of the paragraph style that is applied to the 1st level.*/

	// DocMerge: empty anyway
	[property] string ParaStyleLevel1;
	/** contains the name of the paragraph style that is applied to the 2nd level.*/

	// DocMerge: empty anyway
	[optional, property] string ParaStyleLevel2;
	/** contains the name of the paragraph style that is applied to the 3rd level.*/

	// DocMerge: empty anyway
	[optional, property] string ParaStyleLevel3;
	/** contains the name of the paragraph style that is applied to the 4th level.*/

	// DocMerge: empty anyway
	[optional, property] string ParaStyleLevel4;
	/** contains the name of the paragraph style that is applied to the 5th level.*/

	// DocMerge: empty anyway
	[optional, property] string ParaStyleLevel5;
	/** contains the name of the paragraph style that is applied to the 6th level.*/

	// DocMerge: empty anyway
	[optional, property] string ParaStyleLevel6;
	/** contains the name of the paragraph style that is applied to the 7th level.*/

	// DocMerge: empty anyway
	[optional, property] string ParaStyleLevel7;
	/** contains the name of the paragraph style that is applied to the 8th level.*/

	// DocMerge: empty anyway
	[optional, property] string ParaStyleLevel8;
	/** contains the name of the paragraph style that is applied to the 9th level.*/

	// DocMerge: empty anyway
	[optional, property] string ParaStyleLevel9;
	/** contains the name of the paragraph style that is applied to the 10th level.*/

	// DocMerge: empty anyway
	[optional, property] string ParaStyleLevel10;
	/** contains the name of the paragraph style that is applied to the separator level.*/

	// DocMerge: empty anyway
	[optional, property] string ParaStyleSeparator;
	/** contains the column interface.*/

	// DocMerge: empty anyway
	[property] XTextColumns TextColumns;
	/** contains the URL of a graphic file that is displayed as background graphic*/

	// DocMerge: empty anyway
	[property] string BackGraphicURL;
	/** contains the name of the filter of the graphic file that is
	 	displayed as background graphic*/

	// DocMerge: empty anyway
	[property] string BackGraphicFilter;

	// DocMerge from xml: property com::sun::star::text::BaseIndex::BackGraphicLocation
	/** determines the position of the background graphic.@see GraphicLocation
	 */
	[property] com::sun::star::style::GraphicLocation BackGraphicLocation;

	// DocMerge from xml: property com::sun::star::text::BaseIndex::BackTransparent
	/** specifies the color of the background.
	 */
	[property] com::sun::star::util::Color BackColor;

	/** If <TRUE/>, the background color value in "BackColor" is not visible.
	 */
	[property] boolean BackTransparent;

	/** returns the interface of the level format of the index.
	 <p>
		The description of the format of the levels depends on the type of the document index.
	 </p>
	 @see DocumentIndexLevelFormat
	 */
	// DocMerge: empty anyway
	[optional, property] com::sun::star::container::XIndexReplace LevelFormat;
	/** determines if the content of the document index is created from the
	 	complete document content or from the current chapter only.
	 <p> It is not available in the bibliography</p>*/
	[optional, property] boolean CreateFromChapter;
	//------------------------------------------------------------------------
	/** the text section containing the content of the index */
	[property] com::sun::star::text::XTextSection ContentSection;
	//------------------------------------------------------------------------
	//------------------------------------------------------------------------
	/** the text section containing the header of the index */
	[property] com::sun::star::text::XTextSection HeaderSection;
	//------------------------------------------------------------------------
};

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

}; }; }; };

#endif