/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_table_XMergeableCellRange_idl__
#define __com_sun_star_table_XMergeableCellRange_idl__

#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/lang/NoSupportException.idl>


module com {  module sun {  module star {  module table {


/** represents a range of cells that can possibly be merged or unmerged.
 */
interface XMergeableCellRange : com::sun::star::uno::XInterface
{
    /** merges the area specified by this range.

        @throws com::sun::star::lang::NoSupportException
            if a merge is not possible for this range. You can use
            isMergeable() to check if a merge is possible.
     */
    void merge() raises( ::com::sun::star::lang::NoSupportException );


    /** splits the cells in this range.
        This will be done by inserting rows and columns if needed or unmerging
        cells that are already split.

        @param Columns
            this is the number of columns that will be added to each cell. Zero
            means no new columns

        @param Rows
            this is the number of rows that will be added to each cell. Zero
            means no new rows

        @throws com::sun::star::lang::IllegalArgumentException
            if at least one of the parameters is less than zero.

        @throws com::sun::star::lang::NoSupportException
            if a split is not possible for this range.
    */
    void split( [in] long Columns, [in] long Rows )
        raises( ::com::sun::star::lang::NoSupportException,
                ::com::sun::star::lang::IllegalArgumentException );


    /** @returns
            `TRUE` if all cells from this range can be merged to one
            or `FALSE` otherwise.
     */
    boolean isMergeable();
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
