summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XCellRangeMovement.idl
blob: f59fb26e29255420a7a68ac2942eabc35a4474ac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XCellRangeMovement.idl,v $
 * $Revision: 1.8 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XCellRangeMovement_idl__
#define __com_sun_star_sheet_XCellRangeMovement_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif

#ifndef __com_sun_star_sheet_CellInsertMode_idl__
#include <com/sun/star/sheet/CellInsertMode.idl>
#endif

#ifndef __com_sun_star_sheet_CellDeleteMode_idl__
#include <com/sun/star/sheet/CellDeleteMode.idl>
#endif

#ifndef __com_sun_star_table_CellAddress_idl__
#include <com/sun/star/table/CellAddress.idl>
#endif

//=============================================================================

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

//=============================================================================

/** provides methods for moving ranges of cells in a sheet.
 */
published interface XCellRangeMovement: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** inserts cells, moving other cells down or right.

        <p>Non-empty cells cannot be moved off the sheet.</p>

        @param aRange
            the cell range in which empty cells will be inserted.

        @param nMode
            describes how to move existing cells.
     */
    void insertCells(
            [in] com::sun::star::table::CellRangeAddress aRange,
            [in] com::sun::star::sheet::CellInsertMode nMode );

    //-------------------------------------------------------------------------

    /** deletes cells, moving other cells up or left.

        @param aRange
            the cell range to remove.

        @param nMode
            describes how to move following cells.
     */
    void removeRange(
            [in] com::sun::star::table::CellRangeAddress aRange,
            [in] com::sun::star::sheet::CellDeleteMode nMode );

    //-------------------------------------------------------------------------

    /** moves a cell range to another position in the document.

        <p>After copying the contents of the cell range, all cells
        will be cleared.</p>

        @param aDestination
            the address of the top left cell of the destination range.

        @param aSource
            the cell range which will be copied.
     */
    void moveRange(
            [in] com::sun::star::table::CellAddress aDestination,
            [in] com::sun::star::table::CellRangeAddress aSource );

    //-------------------------------------------------------------------------

    /** copies a cell range to another position in the document.

        <p>The source cell range keeps unchanged.</p>

        @param aDestination
            the address of the top left cell of the destination range.

        @param aSource
            the cell range which will be copied.
     */
    void copyRange(
            [in] com::sun::star::table::CellAddress aDestination,
            [in] com::sun::star::table::CellRangeAddress aSource );

};

//=============================================================================

}; }; }; };

#endif