xref: /trunk/main/sc/inc/viewuno.hxx (revision 91144cd0085a7583d2099b982122deb2184ab956)
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 
24 #ifndef SC_VIEWUNO_HXX
25 #define SC_VIEWUNO_HXX
26 
27 #include <sfx2/sfxbasecontroller.hxx>
28 #include <svl/svarray.hxx>
29 #include <svl/itemprop.hxx>
30 #include <com/sun/star/view/XFormLayerAccess.hpp>
31 #include <com/sun/star/view/XSelectionChangeListener.hpp>
32 #include <com/sun/star/view/XSelectionSupplier.hpp>
33 #include <com/sun/star/sheet/XCellRangeReferrer.hpp>
34 #include <com/sun/star/sheet/XViewSplitable.hpp>
35 #include <com/sun/star/sheet/XViewFreezable.hpp>
36 #include <com/sun/star/sheet/XSpreadsheetView.hpp>
37 #include <com/sun/star/sheet/XEnhancedMouseClickBroadcaster.hpp>
38 #include <com/sun/star/sheet/XActivationBroadcaster.hpp>
39 #include <com/sun/star/sheet/XViewPane.hpp>
40 #include <com/sun/star/sheet/XRangeSelection.hpp>
41 #include <com/sun/star/lang/XServiceInfo.hpp>
42 #include <com/sun/star/container/XEnumerationAccess.hpp>
43 #include <com/sun/star/beans/XPropertySet.hpp>
44 #include <com/sun/star/lang/XUnoTunnel.hpp>
45 #include <com/sun/star/datatransfer/XTransferableSupplier.hpp>
46 
47 #include "address.hxx"
48 
49 class ScTabViewShell;
50 
51 #define SC_VIEWPANE_ACTIVE  0xFFFF
52 
53 
54 typedef ::com::sun::star::uno::Reference<
55             ::com::sun::star::sheet::XRangeSelectionListener >* XRangeSelectionListenerPtr;
56 SV_DECL_PTRARR_DEL( XRangeSelectionListenerArr_Impl, XRangeSelectionListenerPtr, 4, 4 )
57 
58 typedef ::com::sun::star::uno::Reference<
59             ::com::sun::star::sheet::XRangeSelectionChangeListener >* XRangeSelectionChangeListenerPtr;
60 SV_DECL_PTRARR_DEL( XRangeSelectionChangeListenerArr_Impl, XRangeSelectionChangeListenerPtr, 4, 4 )
61 
62 typedef ::com::sun::star::uno::Reference<
63             ::com::sun::star::view::XSelectionChangeListener >* XSelectionChangeListenerPtr;
64 SV_DECL_PTRARR_DEL( XSelectionChangeListenerArr_Impl, XSelectionChangeListenerPtr, 4, 4 )
65 
66 typedef ::com::sun::star::uno::Reference<
67             ::com::sun::star::beans::XPropertyChangeListener >* XViewPropertyChangeListenerPtr;
68 SV_DECL_PTRARR_DEL( XViewPropertyChangeListenerArr_Impl, XViewPropertyChangeListenerPtr, 4, 4 )
69 
70 typedef ::com::sun::star::uno::Reference<
71             ::com::sun::star::awt::XEnhancedMouseClickHandler >* XMouseClickHandlerPtr;
72 SV_DECL_PTRARR_DEL( XMouseClickHandlerArr_Impl, XMouseClickHandlerPtr, 4, 4 )
73 
74 typedef ::com::sun::star::uno::Reference<
75             ::com::sun::star::sheet::XActivationEventListener >* XActivationEventListenerPtr;
76 SV_DECL_PTRARR_DEL( XActivationEventListenerArr_Impl, XActivationEventListenerPtr, 4, 4 )
77 
78 
79 //  ScViewPaneBase not derived from OWeakObject
80 //  to avoid duplicate OWeakObject in ScTabViewObj
81 
82 class ScViewPaneBase : public com::sun::star::sheet::XViewPane,
83                        public com::sun::star::sheet::XCellRangeReferrer,
84                        public com::sun::star::view::XFormLayerAccess,
85                        public com::sun::star::lang::XServiceInfo,
86                        public com::sun::star::lang::XTypeProvider,
87                        public SfxListener
88 {
89 private:
90     ScTabViewShell*         pViewShell;
91     sal_uInt16                  nPane;          // ScSplitPos oder SC_VIEWPANE_ACTIVE
92 
93 protected:
94     ::com::sun::star::awt::Rectangle GetVisArea() const;
95 
96 public:
97                             ScViewPaneBase(ScTabViewShell* pViewSh, sal_uInt16 nP);
98     virtual                 ~ScViewPaneBase();
99 
GetViewShell() const100     ScTabViewShell*         GetViewShell() const    { return pViewShell; }
101 
102     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
103                                 const ::com::sun::star::uno::Type & rType );
104 
105     virtual void            Notify( SfxBroadcaster& rBC, const SfxHint& rHint );
106 
107                             // XViewPane
108     virtual sal_Int32 SAL_CALL getFirstVisibleColumn();
109     virtual void SAL_CALL   setFirstVisibleColumn( sal_Int32 nFirstVisibleColumn );
110     virtual sal_Int32 SAL_CALL getFirstVisibleRow();
111     virtual void SAL_CALL   setFirstVisibleRow( sal_Int32 nFirstVisibleRow );
112     virtual ::com::sun::star::table::CellRangeAddress SAL_CALL getVisibleRange();
113 
114                             // XCellRangeReferrer
115     virtual ::com::sun::star::uno::Reference< ::com::sun::star::table::XCellRange > SAL_CALL
116                             getReferredCells();
117 
118                             // XFormLayerAccess
119     virtual ::com::sun::star::uno::Reference< ::com::sun::star::form::runtime::XFormController > SAL_CALL
120                             getFormController( const ::com::sun::star::uno::Reference<
121                                 ::com::sun::star::form::XForm >& Form );
122     virtual ::sal_Bool SAL_CALL
123                             isFormDesignMode(  );
124     virtual void SAL_CALL   setFormDesignMode( ::sal_Bool DesignMode );
125 
126                             // XControlAccess
127     virtual ::com::sun::star::uno::Reference< ::com::sun::star::awt::XControl > SAL_CALL
128                             getControl( const ::com::sun::star::uno::Reference<
129                                 ::com::sun::star::awt::XControlModel >& xModel );
130 
131                             // XServiceInfo
132     virtual ::rtl::OUString SAL_CALL getImplementationName();
133     virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName );
134     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames();
135 
136                             // XTypeProvider
137     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes();
138     virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId();
139 };
140 
141 
142 //  ScViewPaneObj for direct use (including OWeakObject)
143 
144 class ScViewPaneObj : public ScViewPaneBase, public cppu::OWeakObject
145 {
146 public:
147                             ScViewPaneObj(ScTabViewShell* pViewSh, sal_uInt16 nP);
148     virtual                 ~ScViewPaneObj();
149 
150     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
151                                 const ::com::sun::star::uno::Type & rType );
152     virtual void SAL_CALL   acquire() throw();
153     virtual void SAL_CALL   release() throw();
154 };
155 
156 //  OWeakObject is base of SfxBaseController -> use ScViewPaneBase
157 
158 class ScTabViewObj : public ScViewPaneBase,
159                      public SfxBaseController,
160                      public com::sun::star::sheet::XSpreadsheetView,
161                      public com::sun::star::sheet::XEnhancedMouseClickBroadcaster,
162                      public com::sun::star::sheet::XActivationBroadcaster,
163                      public com::sun::star::container::XEnumerationAccess,
164                      public com::sun::star::container::XIndexAccess,
165                      public com::sun::star::view::XSelectionSupplier,
166                      public com::sun::star::beans::XPropertySet,
167                      public com::sun::star::sheet::XViewSplitable,
168                      public com::sun::star::sheet::XViewFreezable,
169                      public com::sun::star::sheet::XRangeSelection,
170                      public com::sun::star::lang::XUnoTunnel,
171                      public com::sun::star::datatransfer::XTransferableSupplier
172 {
173 private:
174     SfxItemPropertySet                      aPropSet;
175     XSelectionChangeListenerArr_Impl        aSelectionListeners;
176     XRangeSelectionListenerArr_Impl         aRangeSelListeners;
177     XRangeSelectionChangeListenerArr_Impl   aRangeChgListeners;
178     XViewPropertyChangeListenerArr_Impl     aPropertyChgListeners;
179     XMouseClickHandlerArr_Impl              aMouseClickHandlers;
180     XActivationEventListenerArr_Impl        aActivationListeners;
181     SCTAB                                   nPreviousTab;
182     sal_Bool                                bDrawSelModeSet;
183 
184     ScViewPaneObj*          GetObjectByIndex_Impl(sal_uInt16 nIndex) const;
185     sal_Int16                   GetZoom(void) const;
186     void                    SetZoom(sal_Int16 Zoom);
187     sal_Int16                   GetZoomType(void) const;
188     void                    SetZoomType(sal_Int16 ZoomType);
189 
190     com::sun::star::uno::Reference< com::sun::star::uno::XInterface > GetClickedObject(const Point& rPoint) const;
191     void                    StartMouseListening();
192     void                    EndMouseListening();
193     void                    StartActivationListening();
194     void                    EndActivationListening();
195 
196     ScTabViewObj(); // disabled
197 public:
198                             ScTabViewObj(ScTabViewShell* pViewSh);
199     virtual                 ~ScTabViewObj();
200 
201     virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
202                                 const ::com::sun::star::uno::Type & rType );
203     virtual void SAL_CALL   acquire() throw();
204     virtual void SAL_CALL   release() throw();
205 
206     void                    SelectionChanged();
207     void                    VisAreaChanged();
208     // bSameTabButMoved = true if the same sheet as before is activated, used after moving/copying/inserting/deleting a sheet
209     void                    SheetChanged( bool bSameTabButMoved = false );
210     bool                    IsMouseListening() const;
211     sal_Bool                MousePressed( const ::com::sun::star::awt::MouseEvent& e );
212     sal_Bool                MouseReleased( const ::com::sun::star::awt::MouseEvent& e );
213 
214     void                    RangeSelDone( const String& rText );
215     void                    RangeSelAborted( const String& rText );
216     void                    RangeSelChanged( const String& rText );
217 
218                             // XSelectionSupplier
219     virtual sal_Bool SAL_CALL select( const ::com::sun::star::uno::Any& aSelection );
220     virtual ::com::sun::star::uno::Any SAL_CALL getSelection();
221     virtual void SAL_CALL   addSelectionChangeListener( const ::com::sun::star::uno::Reference<
222                                 ::com::sun::star::view::XSelectionChangeListener >& xListener );
223     virtual void SAL_CALL   removeSelectionChangeListener( const ::com::sun::star::uno::Reference<
224                                 ::com::sun::star::view::XSelectionChangeListener >& xListener );
225 
226     //! XPrintable?
227 
228                             // XPropertySet
229     virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo >
230                             SAL_CALL getPropertySetInfo();
231     virtual void SAL_CALL   setPropertyValue( const ::rtl::OUString& aPropertyName,
232                                     const ::com::sun::star::uno::Any& aValue );
233     virtual ::com::sun::star::uno::Any SAL_CALL getPropertyValue(
234                                     const ::rtl::OUString& PropertyName );
235     virtual void SAL_CALL   addPropertyChangeListener( const ::rtl::OUString& aPropertyName,
236                                     const ::com::sun::star::uno::Reference<
237                                         ::com::sun::star::beans::XPropertyChangeListener >& xListener );
238     virtual void SAL_CALL   removePropertyChangeListener( const ::rtl::OUString& aPropertyName,
239                                     const ::com::sun::star::uno::Reference<
240                                         ::com::sun::star::beans::XPropertyChangeListener >& aListener );
241     virtual void SAL_CALL   addVetoableChangeListener( const ::rtl::OUString& PropertyName,
242                                     const ::com::sun::star::uno::Reference<
243                                         ::com::sun::star::beans::XVetoableChangeListener >& aListener );
244     virtual void SAL_CALL   removeVetoableChangeListener( const ::rtl::OUString& PropertyName,
245                                     const ::com::sun::star::uno::Reference<
246                                         ::com::sun::star::beans::XVetoableChangeListener >& aListener );
247 
248                             // XEnumerationAccess
249     virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XEnumeration > SAL_CALL
250                             createEnumeration();
251 
252                             // XIndexAccess
253     virtual sal_Int32 SAL_CALL getCount();
254     virtual ::com::sun::star::uno::Any SAL_CALL getByIndex( sal_Int32 Index );
255 
256                             // XElementAccess
257     virtual ::com::sun::star::uno::Type SAL_CALL getElementType();
258     virtual sal_Bool SAL_CALL hasElements();
259 
260                             // XSpreadsheetView
261     virtual ::com::sun::star::uno::Reference< ::com::sun::star::sheet::XSpreadsheet > SAL_CALL
262                             getActiveSheet();
263     virtual void SAL_CALL   setActiveSheet( const ::com::sun::star::uno::Reference<
264                                 ::com::sun::star::sheet::XSpreadsheet >& xActiveSheet );
265 
266                             //XEnhancedMouseClickBroadcaster
267 
268     virtual void SAL_CALL addEnhancedMouseClickHandler( const ::com::sun::star::uno::Reference<
269                                 ::com::sun::star::awt::XEnhancedMouseClickHandler >& aListener );
270     virtual void SAL_CALL removeEnhancedMouseClickHandler( const ::com::sun::star::uno::Reference<
271                                 ::com::sun::star::awt::XEnhancedMouseClickHandler >& aListener );
272 
273                             //XActivationBroadcaster
274 
275     virtual void SAL_CALL addActivationEventListener( const ::com::sun::star::uno::Reference<
276                                 ::com::sun::star::sheet::XActivationEventListener >& aListener );
277     virtual void SAL_CALL removeActivationEventListener( const ::com::sun::star::uno::Reference<
278                                 ::com::sun::star::sheet::XActivationEventListener >& aListener );
279 
280                             // XViewSplitable
281     virtual sal_Bool SAL_CALL getIsWindowSplit();
282     virtual sal_Int32 SAL_CALL getSplitHorizontal();
283     virtual sal_Int32 SAL_CALL getSplitVertical();
284     virtual sal_Int32 SAL_CALL getSplitColumn();
285     virtual sal_Int32 SAL_CALL getSplitRow();
286     virtual void SAL_CALL   splitAtPosition( sal_Int32 nPixelX, sal_Int32 nPixelY );
287 
288                             // XViewFreezable
289     virtual sal_Bool SAL_CALL hasFrozenPanes();
290     virtual void SAL_CALL   freezeAtPosition( sal_Int32 nColumns, sal_Int32 nRows );
291 
292                             // XRangeSelection
293     virtual void SAL_CALL   startRangeSelection( const ::com::sun::star::uno::Sequence<
294                                 ::com::sun::star::beans::PropertyValue >& aArguments );
295     virtual void SAL_CALL   abortRangeSelection();
296     virtual void SAL_CALL   addRangeSelectionListener( const ::com::sun::star::uno::Reference<
297                                 ::com::sun::star::sheet::XRangeSelectionListener >& aListener );
298     virtual void SAL_CALL   removeRangeSelectionListener( const ::com::sun::star::uno::Reference<
299                                 ::com::sun::star::sheet::XRangeSelectionListener >& aListener );
300     virtual void SAL_CALL   addRangeSelectionChangeListener( const ::com::sun::star::uno::Reference<
301                                 ::com::sun::star::sheet::XRangeSelectionChangeListener >& aListener );
302     virtual void SAL_CALL   removeRangeSelectionChangeListener( const ::com::sun::star::uno::Reference<
303                                 ::com::sun::star::sheet::XRangeSelectionChangeListener >& aListener );
304 
305                             // XServiceInfo
306     virtual ::rtl::OUString SAL_CALL getImplementationName();
307     virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName );
308     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames();
309 
310                             // XUnoTunnel
311     virtual sal_Int64 SAL_CALL getSomething( const ::com::sun::star::uno::Sequence<
312                                     sal_Int8 >& aIdentifier );
313 
314     static const com::sun::star::uno::Sequence<sal_Int8>& getUnoTunnelId();
315     static ScTabViewObj* getImplementation( const com::sun::star::uno::Reference<
316                                     com::sun::star::uno::XInterface> xObj );
317 
318                             // XTypeProvider
319     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type > SAL_CALL getTypes();
320     virtual ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId();
321 
322     //XTransferableSupplier
323     virtual ::com::sun::star::uno::Reference< ::com::sun::star::datatransfer::XTransferable > SAL_CALL getTransferable(  );
324     virtual void SAL_CALL insertTransferable( const ::com::sun::star::uno::Reference< ::com::sun::star::datatransfer::XTransferable >& xTrans );
325 };
326 
327 
328 #endif
329