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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_table_XMergeableCellRange_idl__
  20 #define __com_sun_star_table_XMergeableCellRange_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/lang/IllegalArgumentException.idl>
  24 #include <com/sun/star/lang/NoSupportException.idl>
  25
  26
  27 module com {  module sun {  module star {  module table {
  28
  29
  30 /** represents a range of cells that can possibly be merged or unmerged.
  31  */
  32 interface XMergeableCellRange : com::sun::star::uno::XInterface
  33 {
  34     /** merges the area specified by this range.
  35
  36         @throws com::sun::star::lang::NoSupportException
  37             if a merge is not possible for this range. You can use
  38             isMergeable() to check if a merge is possible.
  39      */
  40     void merge() raises( ::com::sun::star::lang::NoSupportException );
  41
  42
  43     /** splits the cells in this range.
  44         This will be done by inserting rows and columns if needed or unmerging
  45         cells that are already split.
  46
  47         @param Columns
  48             this is the number of columns that will be added to each cell. Zero
  49             means no new columns
  50
  51         @param Rows
  52             this is the number of rows that will be added to each cell. Zero
  53             means no new rows
  54
  55         @throws com::sun::star::lang::IllegalArgumentException
  56             if at least one of the parameters is less than zero.
  57
  58         @throws com::sun::star::lang::NoSupportException
  59             if a split is not possible for this range.
  60     */
  61     void split( [in] long Columns, [in] long Rows )
  62         raises( ::com::sun::star::lang::NoSupportException,
  63                 ::com::sun::star::lang::IllegalArgumentException );
  64
  65
  66     /** @returns
  67             `TRUE` if all cells from this range can be merged to one
  68             or `FALSE` otherwise.
  69      */
  70     boolean isMergeable();
  71 };
  72
  73
  74 }; }; }; };
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */