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
  20
  21 module com {  module sun {  module star {  module table {
  22
  23
  24 /** represents a range of cells that can possibly be merged or unmerged.
  25  */
  26 interface XMergeableCellRange : com::sun::star::uno::XInterface
  27 {
  28     /** merges the area specified by this range.
  29
  30         @throws com::sun::star::lang::NoSupportException
  31             if a merge is not possible for this range. You can use
  32             isMergeable() to check if a merge is possible.
  33      */
  34     void merge() raises( ::com::sun::star::lang::NoSupportException );
  35
  36
  37     /** splits the cells in this range.
  38         This will be done by inserting rows and columns if needed or unmerging
  39         cells that are already split.
  40
  41         @param Columns
  42             this is the number of columns that will be added to each cell. Zero
  43             means no new columns
  44
  45         @param Rows
  46             this is the number of rows that will be added to each cell. Zero
  47             means no new rows
  48
  49         @throws com::sun::star::lang::IllegalArgumentException
  50             if at least one of the parameters is less than zero.
  51
  52         @throws com::sun::star::lang::NoSupportException
  53             if a split is not possible for this range.
  54     */
  55     void split( [in] long Columns, [in] long Rows )
  56         raises( ::com::sun::star::lang::NoSupportException,
  57                 ::com::sun::star::lang::IllegalArgumentException );
  58
  59
  60     /** @returns
  61             `TRUE` if all cells from this range can be merged to one
  62             or `FALSE` otherwise.
  63      */
  64     boolean isMergeable();
  65 };
  66
  67
  68 }; }; }; };
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */