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

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