xref: /AOO41X/main/offapi/com/sun/star/sheet/SpreadsheetView.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sheet_SpreadsheetView_idl__
24#define __com_sun_star_sheet_SpreadsheetView_idl__
25
26#ifndef __com_sun_star_frame_Controller_idl__
27#include <com/sun/star/frame/Controller.idl>
28#endif
29
30#ifndef __com_sun_star_sheet_SpreadsheetViewSettings_idl__
31#include <com/sun/star/sheet/SpreadsheetViewSettings.idl>
32#endif
33
34#ifndef __com_sun_star_sheet_SpreadsheetViewPane_idl__
35#include <com/sun/star/sheet/SpreadsheetViewPane.idl>
36#endif
37
38#ifndef __com_sun_star_sheet_XSpreadsheetView_idl__
39#include <com/sun/star/sheet/XSpreadsheetView.idl>
40#endif
41
42#ifndef __com_sun_star_container_XIndexAccess_idl__
43#include <com/sun/star/container/XIndexAccess.idl>
44#endif
45
46#ifndef __com_sun_star_view_XSelectionSupplier_idl__
47#include <com/sun/star/view/XSelectionSupplier.idl>
48#endif
49
50#ifndef __com_sun_star_sheet_XViewSplitable_idl__
51#include <com/sun/star/sheet/XViewSplitable.idl>
52#endif
53
54#ifndef __com_sun_star_sheet_XViewFreezable_idl__
55#include <com/sun/star/sheet/XViewFreezable.idl>
56#endif
57
58#ifndef __com_sun_star_sheet_XRangeSelection_idl__
59#include <com/sun/star/sheet/XRangeSelection.idl>
60#endif
61
62#ifndef __com_sun_star_container_XEnumerationAccess_idl__
63#include <com/sun/star/container/XEnumerationAccess.idl>
64#endif
65
66#ifndef __com_sun_star_sheet_XActivationBroadcaster_idl__
67#include <com/sun/star/sheet/XActivationBroadcaster.idl>
68#endif
69
70#ifndef __com_sun_star_sheet_XEnhancedMouseClickBroadcaster_idl__
71#include <com/sun/star/sheet/XEnhancedMouseClickBroadcaster.idl>
72#endif
73
74//=============================================================================
75
76 module com {  module sun {  module star {  module sheet {
77
78//=============================================================================
79
80/** represents a view of a spreadsheet document.
81 */
82published service SpreadsheetView
83{
84    /** provides the integration into the framework.
85     */
86    service com::sun::star::frame::Controller;
87
88    /** provides the view's settings.
89     */
90    service com::sun::star::sheet::SpreadsheetViewSettings;
91
92    /** provides direct access to the view's active pane.
93     */
94    service com::sun::star::sheet::SpreadsheetViewPane;
95
96    /** provides access to the active sheet in the view.
97     */
98    interface com::sun::star::sheet::XSpreadsheetView;
99
100    /** provides access to the collection of view panes.
101     */
102    interface com::sun::star::container::XIndexAccess;
103
104    /** creates an enumeration of view panes.
105
106        @see com::sun::star::sheet::SpreadsheetViewPanesEnumeration
107
108     */
109    interface com::sun::star::container::XEnumerationAccess;
110
111    /** provides access to the view's selection.
112    <p>The selection in a spreadsheet view can be a
113        <type scope="com::sun::star::sheet">SheetCell</type>,
114        <type scope="com::sun::star::sheet">SheetCellRange</type>,
115        <type scope="com::sun::star::sheet">SheetCellRanges</type>,
116        <type scope="com::sun::star::drawing">Shape</type> or
117        <type scope="com::sun::star::drawing">Shapes</type> object.
118    </p>
119     */
120    interface com::sun::star::view::XSelectionSupplier;
121
122    /** allows to split the view.
123     */
124    interface com::sun::star::sheet::XViewSplitable;
125
126    /** allows to freeze columns and rows of the view.
127     */
128    interface com::sun::star::sheet::XViewFreezable;
129
130    /** allows to let the user interactively select a cell range.
131     */
132    interface com::sun::star::sheet::XRangeSelection;
133
134    [optional] interface com::sun::star::sheet::XEnhancedMouseClickBroadcaster;
135
136    [optional] interface com::sun::star::sheet::XActivationBroadcaster;
137};
138
139//=============================================================================
140
141}; }; }; };
142
143#endif
144
145