summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/SpreadsheetView.idl
blob: 89e37e968407cc93ea0637df93113187de304409 (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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*************************************************************************
 *
 * 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: SpreadsheetView.idl,v $
 * $Revision: 1.9 $
 *
 * 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_SpreadsheetView_idl__
#define __com_sun_star_sheet_SpreadsheetView_idl__

#ifndef __com_sun_star_frame_Controller_idl__
#include <com/sun/star/frame/Controller.idl>
#endif

#ifndef __com_sun_star_sheet_SpreadsheetViewSettings_idl__
#include <com/sun/star/sheet/SpreadsheetViewSettings.idl>
#endif

#ifndef __com_sun_star_sheet_SpreadsheetViewPane_idl__
#include <com/sun/star/sheet/SpreadsheetViewPane.idl>
#endif

#ifndef __com_sun_star_sheet_XSpreadsheetView_idl__
#include <com/sun/star/sheet/XSpreadsheetView.idl>
#endif

#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif

#ifndef __com_sun_star_view_XSelectionSupplier_idl__
#include <com/sun/star/view/XSelectionSupplier.idl>
#endif

#ifndef __com_sun_star_sheet_XViewSplitable_idl__
#include <com/sun/star/sheet/XViewSplitable.idl>
#endif

#ifndef __com_sun_star_sheet_XViewFreezable_idl__
#include <com/sun/star/sheet/XViewFreezable.idl>
#endif

#ifndef __com_sun_star_sheet_XRangeSelection_idl__
#include <com/sun/star/sheet/XRangeSelection.idl>
#endif

#ifndef __com_sun_star_container_XEnumerationAccess_idl__
#include <com/sun/star/container/XEnumerationAccess.idl>
#endif

#ifndef __com_sun_star_sheet_XActivationBroadcaster_idl__
#include <com/sun/star/sheet/XActivationBroadcaster.idl>
#endif

#ifndef __com_sun_star_sheet_XEnhancedMouseClickBroadcaster_idl__
#include <com/sun/star/sheet/XEnhancedMouseClickBroadcaster.idl>
#endif

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

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

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

/** represents a view of a spreadsheet document.
 */
published service SpreadsheetView
{
    /** provides the integration into the framework.
     */
    service com::sun::star::frame::Controller;

    /** provides the view's settings.
     */
    service com::sun::star::sheet::SpreadsheetViewSettings;

    /** provides direct access to the view's active pane.
     */
    service com::sun::star::sheet::SpreadsheetViewPane;

    /** provides access to the active sheet in the view.
     */
    interface com::sun::star::sheet::XSpreadsheetView;

    /** provides access to the collection of view panes.
     */
    interface com::sun::star::container::XIndexAccess;

    /** creates an enumeration of view panes.

        @see com::sun::star::sheet::SpreadsheetViewPanesEnumeration

     */
    interface com::sun::star::container::XEnumerationAccess;

    /** provides access to the view's selection.
    <p>The selection in a spreadsheet view can be a
        <type scope="com::sun::star::sheet">SheetCell</type>,
        <type scope="com::sun::star::sheet">SheetCellRange</type>,
        <type scope="com::sun::star::sheet">SheetCellRanges</type>,
        <type scope="com::sun::star::drawing">Shape</type> or
        <type scope="com::sun::star::drawing">Shapes</type> object.
    </p>
     */
    interface com::sun::star::view::XSelectionSupplier;

    /** allows to split the view.
     */
    interface com::sun::star::sheet::XViewSplitable;

    /** allows to freeze columns and rows of the view.
     */
    interface com::sun::star::sheet::XViewFreezable;

    /** allows to let the user interactively select a cell range.
     */
    interface com::sun::star::sheet::XRangeSelection;

    [optional] interface com::sun::star::sheet::XEnhancedMouseClickBroadcaster;

    [optional] interface com::sun::star::sheet::XActivationBroadcaster;
};

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

}; }; }; };

#endif