xref: /aoo41x/main/offapi/com/sun/star/style/ParagraphStyle.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_style_ParagraphStyle_idl__
#define __com_sun_star_style_ParagraphStyle_idl__

#ifndef __com_sun_star_style_ParagraphProperties_idl__
#include <com/sun/star/style/ParagraphProperties.idl>
#endif

#ifndef __com_sun_star_style_Style_idl__
#include <com/sun/star/style/Style.idl>
#endif

#ifndef _com_sun_star_xml_ParaUserDefinedAttributesSupplier_idl_
#include <com/sun/star/xml/ParaUserDefinedAttributesSupplier.idl>
#endif

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

 module com {  module sun {  module star {  module style {

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

/** specifies a stylesheet for paragraphs within a
	<type scope="com::sun::star::text">Text</type>.
 */
published service ParagraphStyle
{
	//-------------------------------------------------------------------------
	/// specifies administrative properties.
	service Style;

    //-------------------------------------------------------------------------
    /** contains user defined attributes for paragraphs.

        @see    <type scope="com::sun::star::xml">ParaUserDefinedAttributesSupplier</type>
     */
    [optional] service com::sun::star::xml::ParaUserDefinedAttributesSupplier;

	//-------------------------------------------------------------------------
	/// specifies the style properties.
	service ParagraphProperties;

	/** determines the left margin of the paragraph relative to the ParaLeftMargin
		of the parent style.

		<p> If the value of ParaLeftMarginRelative is 100 the current
		ParaLeftMargin value is used. </p>
	 */
	[property] long ParaLeftMarginRelative;

	//-------------------------------------------------------------------------

	/** determines the right margin of the paragraph relative to the ParaRightMargin
		of the parent style.

		<p> If the value of ParaRightMarginRelative is 100 the current
		ParaRightMargin value is used. </p>
	 */
	[property] long ParaRightMarginRelative;

	//-------------------------------------------------------------------------

	/** determines the top margin of the paragraph relative to the ParaTopMargin
		of the parent style.

		<p> If the value of ParaTopMarginRelative is 100 the current
		ParaTopMargin value is used. </p>
	 */
	[property] long ParaTopMarginRelative;

	//-------------------------------------------------------------------------

	/** determines the Bottom margin of the paragraph relative to the ParaBottomMargin
		of the parent style.

		<p> If the value of ParaBottomMarginRelative is 100 the current
		ParaBottomMargin value is used. </p>
	 */
	[property] long ParaBottomMarginRelative;
	//-------------------------------------------------------------------------

	/** determines the category of a paragraph style.@see com.sun.star.style.ParagraphStyleCategory
	 */
	[property] short Category;
    //-------------------------------------------------------------------------

    [property] float CharDiffHeight;
    //-------------------------------------------------------------------------

	/** This value contains the character height as percentage value relative to the height of
	 the character in the parent style.
	 */
	[property] short CharPropHeight;
    //-------------------------------------------------------------------------

	/** This value contains the character height as difference in point to the height of
	 the character in the parent style in Asian text.
	 */
	[property] float CharDiffHeightAsian;
    //-------------------------------------------------------------------------

	/** This value contains the character height as percentage value relative to the height of
	 the character in the parent style in Asian text.
	 */
	[property] short CharPropHeightAsian;
    //-------------------------------------------------------------------------

	/** This value contains the character height as difference in point to the height of
	 the character in the parent style in complex text.
	 */
	[property] float CharDiffHeightComplex;
    //-------------------------------------------------------------------------

	/** This value contains the character height as percentage value relative to the height of
	 the character in the parent style in complex text.
	 */
	[property] short CharPropHeightComplex;
    //-------------------------------------------------------------------------

    /** returns the name of the page style in use

        <P>For setting the page style you have to use the
        <member scope="com::sun::star::text">PageDescName</member>
        properties.
        </P>
    */
    [optional, readonly, property] string PageStyleName;
};

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

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif