/* -*- 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 .
 */


module com {  module sun {  module star {  module sheet {


/** provides advanced methods to control the position of a cursor in a
    spreadsheet.

    @see com::sun::star::sheet::SheetCellCursor
 */
published interface XSheetCellCursor: com::sun::star::sheet::XSheetCellRange
{

    /** expands the cursor into the region containing the cells to which
        it currently points.

        <p>A region is a cell range bounded by empty cells.</p>
     */
    void collapseToCurrentRegion();


    /** collapses the cursor into the range of the array formula to which
        it is currently pointing.

        <p>To get the correct result, the top left cell of the original
        cursor must point to any cell containing an array formula.
        If not, the cursor is left unchanged.</p>
     */
    void collapseToCurrentArray();


    /** expands the cursor to merged cell ranges.

        <p>Expands the current cursor range in a way so that all merged
        cell ranges intersecting the current range will fit completely.
        If the cursor does not point to any range with merged cells, it
        is left unchanged.</p>
     */
    void collapseToMergedArea();


    /** expands the cursor to include the entire columns of the cells
        to which it is currently pointing.
     */
    void expandToEntireColumns();


    /** expands the cursor to include the entire rows of the cells to
        which it is currently pointing.
     */
    void expandToEntireRows();


    /** changes the size of a cursor range.

        <p>The top left cell of the cursor keeps unmodified. </p>

        @param nColumns
            the number of columns of the new cursor range.
        @param nRows
            the number of rows of the new cursor range.
     */
    void collapseToSize( [in] long nColumns, [in] long nRows );

};


}; }; }; };

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