1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_table_XMergeableCellRange_idl__
24#define __com_sun_star_table_XMergeableCellRange_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#endif
33
34#ifndef __com_sun_star_lang_NoSupportException_idl__
35#include <com/sun/star/lang/NoSupportException.idl>
36#endif
37
38//=============================================================================
39
40module com {  module sun {  module star {  module table {
41
42//=============================================================================
43
44/** represents a range of cells that can possibly be merged or unmerged.
45 */
46interface XMergeableCellRange : com::sun::star::uno::XInterface
47{
48	/** merges the area specified by this range.
49
50		@throws <type scope="com::sun::star::lang">NoSupportException</type>
51			if a merge is not possible for this range. You can use
52			<method>isMergeable()</method> to check if a merge is possible.
53	 */
54	void merge() raises( ::com::sun::star::lang::NoSupportException );
55
56	//-------------------------------------------------------------------------
57
58	/** splits the cells in this range.
59		This will be done by inserting rows and columns if needed or unmerging
60		cells that are already splitted.
61
62		@param Columns
63			this is the number of columns that will be added to each cell. Zero
64			means no new columns
65
66		@param Rows
67			this is the number of rows that will be added to each cell. Zero
68			means no new rows
69
70		@throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
71			if at least one of the parameters is less than zero.
72
73		@throws <type scope="com::sun::star::lang">NoSupportException</type>
74			if a split is not possible for this range.
75	*/
76	void split( [in] long Columns, [in] long Rows )
77		raises( ::com::sun::star::lang::NoSupportException,
78				::com::sun::star::lang::IllegalArgumentException );
79
80	//-------------------------------------------------------------------------
81
82	/** @returns
83			<TRUE/> if all cells from this range can be merged to one
84			or <FALSE/> otherwise.
85	 */
86	boolean isMergeable();
87};
88
89//=============================================================================
90
91}; }; }; };
92
93#endif
94