xref: /aoo42x/main/offapi/com/sun/star/table/CellProperties.idl (revision a893be29)

/**************************************************************
 *
 * 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_table_CellProperties_idl__
#define __com_sun_star_table_CellProperties_idl__

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

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.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_util_CellProtection_idl__
#include <com/sun/star/util/CellProtection.idl>
#endif

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

#ifndef __com_sun_star_table_BorderLine_idl__
#include <com/sun/star/table/BorderLine.idl>
#endif

#ifndef __com_sun_star_container_XNameContainer_idl__
#include <com/sun/star/container/XNameContainer.idl>
#endif

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

module com {  module sun {  module star {  module table {

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

/** contains the properties of a table cell.

	@see com::sun::star::table::Cell
	@see com::sun::star::table::CellRange
 */
published service CellProperties
{
	//-------------------------------------------------------------------------

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

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

	/** contains the name of the style of the cell.
	 */
	[optional, property] string CellStyle;

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

	/** 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>CellProperties::CellBackColor</member>
		value is not used.</p>
	 */
	[property] boolean IsCellBackgroundTransparent;

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

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

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

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

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

	/** is <TRUE/>, if text in the cells will be wrapped automatically
		at the right border.
	 */
	[property] boolean IsTextWrapped;

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

	/** defines the indentation of the cell contents (in 1/100 mm).
	 */
	[property] short ParaIndent;

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

	/** contains the orientation of the cell contents.

		<p>If the <member>CellProperties::RotateAngle</member> property
		is non-zero, this value is not used.</p>
	 */
	[property] com::sun::star::table::CellOrientation Orientation;

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

	/** defines how much the content of cells is rotated (in 1/100 degrees).
	 */
	[property] long RotateAngle;

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

	/** defines at which edge rotated cells are aligned.
	 */
	[property] com::sun::star::table::CellVertJustify RotateReference;

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

	/** selects Asian character orientation in vertical orientation.

		<p>If the <member>CellProperties::Orientation</member> property is
		<const>CellOrientation::STACKED</const>, in Asian mode only Asian
		characters are printed in horizontal orientation instead of all
		characters.
		For other values of <member>CellProperties::Orientation</member>,
		this value is not used.</p>
	 */
	[optional, property] boolean AsianVerticalMode;

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

	/** contains a description of the cell or cell range border.

		<p>If used with a cell range, the top, left, right, and bottom
		lines are at the edges of the entire range, not at the edges of
		the individual cell.</p>
	 */
	[property] com::sun::star::table::TableBorder TableBorder;

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

	/** contains a description of the top border line of each cell.
	 */
	[property] com::sun::star::table::BorderLine TopBorder;

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

	/** contains a description of the bottom border line of each cell.
	*/
	[property] com::sun::star::table::BorderLine BottomBorder;

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

	/** contains a description of the left border line of each cell.
	 */
	[property] com::sun::star::table::BorderLine LeftBorder;

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

	/** contains a description of the right border line of each cell.
	 */
	[property] com::sun::star::table::BorderLine RightBorder;

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

	/** contains the index of the number format that is used in the cells.

		<p>The proper value can be determined by using the
		<type scope="com::sun::star::util">NumberFormatter</type>
		interface of the document.</p>
	 */
	[property] long NumberFormat;

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

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

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

	/** contains a description of the cell protection.

		<p>Cell protection is active only if the sheet is protected.</p>
	 */
	[property] com::sun::star::util::CellProtection CellProtection;

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

	/** stores additional attributes.

		<p>This property is used i.e. by the XML filters to load and
		restore unknown attributes.</p>
   	 */
	[optional, property] com::sun::star::container::XNameContainer
		UserDefinedAttributes;

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

	/** contains a description of the top left to bottom right diagonal line of each cell.
	 */
	[optional, property] com::sun::star::table::BorderLine DiagonalTLBR;

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

	/** contains a description of the bottom left to top right diagonal line of each cell.
	 */
	[optional, property] com::sun::star::table::BorderLine DiagonalBLTR;

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

	/** is <TRUE/>, if the cell content will be shrunk to fit in the cell.
	 */
	[optional, property] boolean ShrinkToFit;

	//-------------------------------------------------------------------------
};

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

}; }; }; };

#endif