xref: /trunk/main/offapi/com/sun/star/sheet/TableAutoFormat.idl (revision d1766043)

/**************************************************************
 *
 * 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_sheet_TableAutoFormat_idl__
#define __com_sun_star_sheet_TableAutoFormat_idl__

#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif

#ifndef __com_sun_star_container_XEnumerationAccess_idl__
#include <com/sun/star/container/XEnumerationAccess.idl>
#endif

#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif

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

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

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

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

/** represents an AutoFormat, containing exactly 16 AutoFormat fields.

	<p>Each of the 16 fields contain formatting properties for a table
	cell at a specific position in the AutoFormat range. The rows of the
	range are divided into a header row, a footer row and 2 data rows
	(repeated in turn between header and footer row). The columns are
	divided similar. This results in 16 different types of cells in the
	range. The AutoFormats are numbered row by row, then column by column.</p>

	@see com::sun::star::sheet::TableAutoFormatField
 */
published service TableAutoFormat
{
	//-------------------------------------------------------------------------

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

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

	/** provides methods to access the AutoFormat fields via index.

		@see com::sun::star::sheet::TableAutoFormatField
	 */
	interface com::sun::star::container::XIndexAccess;

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

	/** creates an enumeration of all 16 AutoFormat fields.

		@see com::sun::star::sheet::TableAutoFormatEnumeration
	 */
	interface com::sun::star::container::XEnumerationAccess;

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

	/** provides methods to access the name of the AutoFormat.
	 */
	interface com::sun::star::container::XNamed;

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

	/** specifies whether the font settings from the fields are used.
	 */
	[property] boolean IncludeFont;

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

	/** specifies whether the justification settings from the fields
		are used.
	 */
	[property] boolean IncludeJustify;

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

	/** specifies whether the border settings from the fields are used.
	 */
	[property] boolean IncludeBorder;

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

	/** specifies whether the background settings from the fields are used.
	 */
	[property] boolean IncludeBackground;

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

	/** specifies whether the number format settings from the fields
		are used.
	 */
	[property] boolean IncludeNumberFormat;

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

	/** specifies whether the column widths and row heights should be
		updated after applying the format.
	 */
	[property] boolean IncludeWidthAndHeight;

};

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

}; }; }; };

#endif