xref: /trunk/main/offapi/com/sun/star/sheet/TableConditionalFormat.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_TableConditionalFormat_idl__
#define __com_sun_star_sheet_TableConditionalFormat_idl__

#ifndef __com_sun_star_sheet_XSheetConditionalEntries_idl__
#include <com/sun/star/sheet/XSheetConditionalEntries.idl>
#endif

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

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

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

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

/** represents a collection of conditional formatting settings for a
	cell or cell range.

	<p>The style of the first fulfilled condition (in index order) will
	be applied to the cell(s).</p>

	@see com::sun::star::sheet::SheetCell
	@see com::sun::star::sheet::SheetCellRange
	@see com::sun::star::sheet::SheetCellRanges
 */
published service TableConditionalFormat
{
	//-------------------------------------------------------------------------

	/** provides methods to insert and remove conditions and to access
		the condition via index.

		@see com::sun::star::sheet::TableConditionalEntry
	 */
	interface com::sun::star::sheet::XSheetConditionalEntries;

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

	/** provides methods to access the condition via name.

		<p>The name of a condition is "Entry", followed by its index
		(i.e. Entry0, Entry1, ...).</p>

		@see com::sun::star::sheet::TableConditionalEntry
	 */
	interface com::sun::star::container::XNameAccess;

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

	/** creates an enumeration of all conditional entries.

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

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

	/** provides methods to access the contained conditional entries by index.

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

};

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

}; }; }; };

#endif