xref: /aoo41x/main/offapi/com/sun/star/text/TextTableRow.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_text_TextTableRow_idl__
#define __com_sun_star_text_TextTableRow_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_style_GraphicLocation_idl__
#include <com/sun/star/style/GraphicLocation.idl>
#endif

#ifndef __com_sun_star_text_TableColumnSeparator_idl__
#include <com/sun/star/text/TableColumnSeparator.idl>
#endif


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

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

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

/** specifies the properties of a text table row.

    @see com::sun::star::TextTable
 */
published service TextTableRow
{
	interface com::sun::star::beans::XPropertySet;

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

	/** 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;

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

	/** contains the URL of a background graphic.
	 */
	[property] string BackGraphicURL;

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

	/** contains the name of the file filter of a background graphic.
	 */
	[property] string BackGraphicFilter;

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

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

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

	/** contains the description of the columns in the table row.
	 */
    [property] sequence< com::sun::star::text::TableColumnSeparator >   TableColumnSeparators;

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

	/** contains the height of the table row.
	 */
	[property] long Height;

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

	/** If the value of this property is <TRUE/>, the height of the table row
		depends on the content of the table cells.
	 */
	[property] boolean IsAutoHeight;

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

        /** If <TRUE/>, the row is allowed to be split at page or column breaks.

                @since OOo 2.0
         */
        [optional, property, maybevoid] boolean IsSplitAllowed;


};

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

}; }; }; };


#endif