offapi/com/sun/star/table/XMergeableCellRange.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XMergeableCellRange.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_table_XMergeableCellRange_idl__
  31 #define __com_sun_star_table_XMergeableCellRange_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  38 #include <com/sun/star/lang/IllegalArgumentException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_NoSupportException_idl__
  42 #include <com/sun/star/lang/NoSupportException.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com {  module sun {  module star {  module table {
  48
  49 //=============================================================================
  50
  51 /** represents a range of cells that can possibly be merged or unmerged.
  52  */
  53 interface XMergeableCellRange : com::sun::star::uno::XInterface
  54 {
  55     /** merges the area specified by this range.
  56
  57         @throws <type scope="com::sun::star::lang">NoSupportException</type>
  58             if a merge is not possible for this range. You can use
  59             <method>isMergeable()</method> to check if a merge is possible.
  60      */
  61     void merge() raises( ::com::sun::star::lang::NoSupportException );
  62
  63     //-------------------------------------------------------------------------
  64
  65     /** splits the cells in this range.
  66         This will be done by inserting rows and columns if needed or unmerging
  67         cells taht are already splitted.
  68
  69         @param Columns
  70             this is the number of columns that will be added to each cell. Zero
  71             means no new columns
  72
  73         @param Rows
  74             this is the number of rows that will be added to each cell. Zero
  75             means no new rows
  76
  77         @throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
  78             if at least one of the parameters is less than zero.
  79
  80         @throws <type scope="com::sun::star::lang">NoSupportException</type>
  81             if a split is not possible for this range.
  82     */
  83     void split( [in] long Columns, [in] long Rows )
  84         raises( ::com::sun::star::lang::NoSupportException,
  85                 ::com::sun::star::lang::IllegalArgumentException );
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** @returns
  90             <TRUE/> if all cells from this range can be merged to one
  91             or <FALSE/> otherwise.
  92      */
  93     boolean isMergeable();
  94 };
  95
  96 //=============================================================================
  97
  98 }; }; }; };
  99
 100 #endif