summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XRangeSelection.idl
blob: e5a43d211a15ad4006c66bf8c0623c1c5a2d549b (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_XRangeSelection_idl__
#define __com_sun_star_sheet_XRangeSelection_idl__

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

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

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

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

 published interface XRangeSelectionListener;
 published interface XRangeSelectionChangeListener;

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

/** allows to let the user to select a cell range.

    @see com::sun::star::sheet::SpreadsheetView
 */
published interface XRangeSelection: com::sun::star::uno::XInterface
{
    /** starts the range selection.

        @param aArguments
        the <type>RangeSelectionArguments</type> that specify how the
        range selection is done.
     */
    void startRangeSelection(
                [in] sequence<com::sun::star::beans::PropertyValue> aArguments );

    /** aborts the range selection.
     */
    void abortRangeSelection();

    /** adds a listener that is notified when range selection is completed
        or aborted.
     */
    void addRangeSelectionListener(
                [in] com::sun::star::sheet::XRangeSelectionListener aListener );

    /** removes the specified listener.
     */
    void removeRangeSelectionListener(
                [in] com::sun::star::sheet::XRangeSelectionListener aListener );

    /** adds a listener that is notified when the selected range is changed.
     */
    void addRangeSelectionChangeListener(
                [in] com::sun::star::sheet::XRangeSelectionChangeListener aListener );

    /** removes the specified listener.
     */
    void removeRangeSelectionChangeListener(
                [in] com::sun::star::sheet::XRangeSelectionChangeListener aListener );

};

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

}; }; }; };

#endif