xref: /aoo42x/main/offapi/com/sun/star/text/DocumentIndexFormat.idl (revision 361c8c00)

/**************************************************************
 *
 * 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_DocumentIndexFormat_idl__
#define __com_sun_star_text_DocumentIndexFormat_idl__


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

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

//=============================================================================
/** specifies the formatting of document indexes.

    @deprecated
        the service was never implemented, none of it's properties do exist.

*/
published service DocumentIndexFormat
{
	//-------------------------------------------------------------------------
	/** 	This property contains the name of the paragraph style that is
	used for the index title.

	*/
	[property] string TitleStyle;

	//-------------------------------------------------------------------------
	/** 	This property contains the name of the paragraph style that is
	used for the separator. This entry is ignored for user indexes
	and content indexes.

	*/
	[property] string SeparatorStyle;

	//-------------------------------------------------------------------------
	/**	contains the number of levels in the document index.
	*/
	[readonly, property] short LevelCount;

	//-------------------------------------------------------------------------
	/** This sequence contains the names of the paragraph styles that are
	 	applied to the level corresponding to the position in the sequence.
	 */
	[property] sequence<string> LevelStyles;

	//-------------------------------------------------------------------------
	/**	This method specifies whether the form supports hyperlinks.
	*/
	[readonly, property] boolean HasHyperlinks;

	//-------------------------------------------------------------------------
	/** return an object that provides the service "com.sun.star.text.DocumentIndexLevelFormat"
	 @see com::sun::star::text::DocumentIndexLevelFormat
	 */
	[property] sequence<string> LevelFormat;
};

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

}; }; }; };

#endif