xref: /AOO41X/main/offapi/com/sun/star/sheet/TableAutoFormatField.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * 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_sheet_TableAutoFormatField_idl__
#define __com_sun_star_sheet_TableAutoFormatField_idl__

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

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

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif

#ifndef __com_sun_star_awt_FontSlant_idl__
#include <com/sun/star/awt/FontSlant.idl>
#endif

#ifndef __com_sun_star_table_ShadowFormat_idl__
#include <com/sun/star/table/ShadowFormat.idl>
#endif

#ifndef __com_sun_star_table_CellHoriJustify_idl__
#include <com/sun/star/table/CellHoriJustify.idl>
#endif

#ifndef __com_sun_star_table_CellVertJustify_idl__
#include <com/sun/star/table/CellVertJustify.idl>
#endif

#ifndef __com_sun_star_table_CellOrientation_idl__
#include <com/sun/star/table/CellOrientation.idl>
#endif

#ifndef __com_sun_star_table_TableBorder_idl__
#include <com/sun/star/table/TableBorder.idl>
#endif

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

module com {  module sun {  module star {  module sheet {

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

/** represents a field in an AutoFormat. A field contains all cell
	properties for a specific position in an AutoFormat.
 */
published service TableAutoFormatField
{
	//-------------------------------------------------------------------------

//!	service com::sun::star::beans::PropertySet;
	/** provides access to the properties.
	 */
	interface com::sun::star::beans::XPropertySet;

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

    /** specifies the name of the western font.
	 */
	[property] string CharFontName;

    /** specifies the name of the asian font.
	 */
    [optional, property] string CharFontNameAsian;

    /** specifies the name of the complex font.
	 */
    [optional, property] string CharFontNameComplex;

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

    /** specifies the name of the western font style.
	 */
    [property] string CharFontStyleName;

    /** specifies the name of the asian font style.
	 */
    [optional, property] string CharFontStyleNameAsian;

    /** specifies the name of the complex font style.
	 */
    [optional, property] string CharFontStyleNameComplex;

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

    /** contains the value of the character set of the western font.
	 */
    [property] string CharFontCharSet;

    /** contains the value of the character set of the asian font.
	 */
    [optional, property] string CharFontCharSetAsian;

    /** contains the value of the character set of the complex font.
	 */
    [optional, property] string CharFontCharSetComplex;

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

    /** contains the value of the western font family.
	 */
    [property] string CharFontFamily;

    /** contains the value of the asian font family.
	 */
    [optional, property] string CharFontFamilyAsian;

    /** contains the value of the complex font family.
	 */
    [optional, property] string CharFontFamilyComplex;

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

    /** contains the value of the pitch of the western font.
	 */
    [property] string CharFontPitch;

    /** contains the value of the pitch of the asian font.
	 */
    [optional, property] string CharFontPitchAsian;

    /** contains the value of the pitch of the complex font.
	 */
    [optional, property] string CharFontPitchComplex;

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

    /** contains the height of characters of the western font in point.
	 */
	[property] float CharHeight;

    /** contains the height of characters of the asian font in point.
	 */
    [optional, property] float CharHeightAsian;

    /** contains the height of characters of the complex font in point.
	 */
    [optional, property] float CharHeightComplex;

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

    /** contains the value for the weight of characters of the western font.
	 */
	[property] float CharWeight;

    /** contains the value for the weight of characters of the asian font.
	 */
    [optional, property] float CharWeightAsian;

    /** contains the value for the weight of characters of the complex font.
	 */
    [optional, property] float CharWeightComplex;

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

    /** contains the value of the posture of characters of the western font.
	 */
	[property] com::sun::star::awt::FontSlant CharPosture;

    /** contains the value of the posture of characters of the asian font.
	 */
    [optional, property] com::sun::star::awt::FontSlant CharPostureAsian;

    /** contains the value of the posture of characters of the comlex font.
	 */
    [optional, property] com::sun::star::awt::FontSlant CharPostureComplex;

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

	/** contains the value for the character underline.
	 */
	[property] short CharUnderline;

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

	/** is <TRUE/> if the characters are crossed out.
	 */
	[property] boolean CharCrossedOut;

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

	/** is <TRUE/> if the characters are contoured.
	 */
	[property] boolean CharContoured;

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

	/** is <TRUE/> if the characters are shadowed.
	 */
	[property] boolean CharShadowed;

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

	/** contains the value of the text color.
	 */
	[property] com::sun::star::util::Color CharColor;

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

	/** contains the cell background color.
	 */
	[property] com::sun::star::util::Color CellBackColor;

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

	/** is <TRUE/> if the cell background is transparent.

		<p>In this case the <member>TableAutoFormatField::CellBackColor</member>
		value is not used.</p>
	 */
	[property] boolean IsCellBackgroundTransparent;

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

	/** contains a description of the shadow.
	 */
	[optional, property] com::sun::star::table::ShadowFormat ShadowFormat;

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

    /** specifies the horizontal alignment of the cell contents.
	 */
    [optional, property] com::sun::star::table::CellHoriJustify HoriJustify;

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

    /** specifies the vertical alignment of the cell contents.
	 */
    [optional, property] com::sun::star::table::CellVertJustify VertJustify;

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

    /** is <TRUE/> if text breaks automatically at cell borders.
	 */
    [optional, property] boolean IsTextWrapped;

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

    /** contains the orientation of the cell contents
		(i.e. top-to-bottom or stacked).
	 */
    [optional, property] com::sun::star::table::CellOrientation Orientation;

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

    /** contains the rotation angle of the cell contents.
	 */
    [optional, property] long RotateAngle;

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

    /** contains the reference egde of the cell rotation.
	 */
    [optional, property] com::sun::star::table::CellVertJustify RotateReference;

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

    /** contains the margin between cell contents and top border
		(in 1/100 mm).
	 */
    [optional, property] long ParaTopMargin;

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

    /** contains the margin between cell contents and bottom border
		(in 1/100 mm).
	 */
    [optional, property] long ParaBottomMargin;

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

    /** contains the margin between cell contents and left border
		(in 1/100 mm).
	 */
    [optional, property] long ParaLeftMargin;

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

    /** contains the margin between cell contents and right border
		(in 1/100 mm).
	 */
    [optional, property] long ParaRightMargin;

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

	/** property containing a description of the cell border.

		@since OOo 1.1.2
	 */
	[optional, property] com::sun::star::table::TableBorder TableBorder;
};

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

}; }; }; };

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

#endif