sc/inc/viewuno.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <sfx2/sfxbasecontroller.hxx>
  23 #include <svl/itemprop.hxx>
  24 #include <svl/lstner.hxx>
  25 #include <tools/gen.hxx>
  26 #include <com/sun/star/view/XFormLayerAccess.hpp>
  27 #include <com/sun/star/view/XSelectionSupplier.hpp>
  28 #include <com/sun/star/sheet/XCellRangeReferrer.hpp>
  29 #include <com/sun/star/sheet/XViewSplitable.hpp>
  30 #include <com/sun/star/sheet/XViewFreezable.hpp>
  31 #include <com/sun/star/sheet/XSelectedSheetsSupplier.hpp>
  32 #include <com/sun/star/sheet/XSpreadsheetView.hpp>
  33 #include <com/sun/star/sheet/XEnhancedMouseClickBroadcaster.hpp>
  34 #include <com/sun/star/sheet/XActivationBroadcaster.hpp>
  35 #include <com/sun/star/sheet/XViewPane.hpp>
  36 #include <com/sun/star/sheet/XRangeSelection.hpp>
  37 #include <com/sun/star/lang/XServiceInfo.hpp>
  38 #include <com/sun/star/container/XEnumerationAccess.hpp>
  39 #include <com/sun/star/beans/XPropertySet.hpp>
  40 #include <com/sun/star/lang/XUnoTunnel.hpp>
  41 #include <com/sun/star/datatransfer/XTransferableSupplier.hpp>
  42 #include <comphelper/servicehelper.hxx>
  43
  44 #include "types.hxx"
  45
  46 namespace com::sun::star::view { class XSelectionChangeListener; }
  47
  48 class ScTabViewShell;
  49 class ScPreviewShell;
  50
  51 #define SC_VIEWPANE_ACTIVE  0xFFFF
  52
  53 //  ScViewPaneBase not derived from OWeakObject
  54 //  to avoid duplicate OWeakObject in ScTabViewObj
  55
  56 class ScViewPaneBase : public css::sheet::XViewPane,
  57                        public css::sheet::XCellRangeReferrer,
  58                        public css::view::XFormLayerAccess,
  59                        public css::lang::XServiceInfo,
  60                        public css::lang::XTypeProvider,
  61                        public SfxListener
  62 {
  63 private:
  64     ScTabViewShell*         pViewShell;
  65     sal_uInt16                  nPane;          // ScSplitPos or SC_VIEWPANE_ACTIVE
  66
  67 protected:
  68     css::awt::Rectangle GetVisArea() const;
  69
  70 public:
  71                             ScViewPaneBase(ScTabViewShell* pViewSh, sal_uInt16 nP);
  72     virtual                 ~ScViewPaneBase() override;
  73
  74     ScTabViewShell*         GetViewShell() const    { return pViewShell; }
  75
  76     virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) override;
  77
  78     virtual void            Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) override;
  79
  80                             // XViewPane
  81     virtual sal_Int32 SAL_CALL getFirstVisibleColumn() override;
  82     virtual void SAL_CALL   setFirstVisibleColumn( sal_Int32 nFirstVisibleColumn ) override;
  83     virtual sal_Int32 SAL_CALL getFirstVisibleRow() override;
  84     virtual void SAL_CALL   setFirstVisibleRow( sal_Int32 nFirstVisibleRow ) override;
  85     virtual css::table::CellRangeAddress SAL_CALL getVisibleRange() override;
  86
  87                             // XCellRangeReferrer
  88     virtual css::uno::Reference< css::table::XCellRange > SAL_CALL
  89                             getReferredCells() override;
  90
  91                             // XFormLayerAccess
  92     virtual css::uno::Reference< css::form::runtime::XFormController > SAL_CALL
  93                             getFormController( const css::uno::Reference< css::form::XForm >& Form ) override;
  94     virtual sal_Bool SAL_CALL
  95                             isFormDesignMode(  ) override;
  96     virtual void SAL_CALL   setFormDesignMode( sal_Bool DesignMode ) override;
  97
  98                             // XControlAccess
  99     virtual css::uno::Reference< css::awt::XControl > SAL_CALL
 100                             getControl( const css::uno::Reference< css::awt::XControlModel >& xModel ) override;
 101
 102                             // XServiceInfo
 103     virtual OUString SAL_CALL getImplementationName() override;
 104     virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
 105     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 106
 107                             // XTypeProvider
 108     virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() override;
 109     virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() override;
 110 };
 111
 112 //  ScViewPaneObj for direct use (including OWeakObject)
 113
 114 class ScViewPaneObj final : public ScViewPaneBase, public cppu::OWeakObject
 115 {
 116 public:
 117                             ScViewPaneObj(ScTabViewShell* pViewSh, sal_uInt16 nP);
 118     virtual                 ~ScViewPaneObj() override;
 119
 120     virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) override;
 121     virtual void SAL_CALL   acquire() noexcept override;
 122     virtual void SAL_CALL   release() noexcept override;
 123 };
 124
 125 //  OWeakObject is base of SfxBaseController -> use ScViewPaneBase
 126
 127 class ScTabViewObj final : public ScViewPaneBase,
 128                      public SfxBaseController,
 129                      public css::sheet::XSpreadsheetView,
 130                      public css::sheet::XEnhancedMouseClickBroadcaster,
 131                      public css::sheet::XActivationBroadcaster,
 132                      public css::container::XEnumerationAccess,
 133                      public css::container::XIndexAccess,
 134                      public css::view::XSelectionSupplier,
 135                      public css::beans::XPropertySet,
 136                      public css::sheet::XViewSplitable,
 137                      public css::sheet::XViewFreezable,
 138                      public css::sheet::XRangeSelection,
 139                      public css::lang::XUnoTunnel,
 140                      public css::datatransfer::XTransferableSupplier,
 141                      public css::sheet::XSelectedSheetsSupplier
 142 {
 143 private:
 144     SfxItemPropertySet                      aPropSet;
 145     std::vector<css::uno::Reference<css::view::XSelectionChangeListener> >
 146                                             aSelectionChgListeners;
 147     std::vector<css::uno::Reference<css::sheet::XRangeSelectionListener> >
 148                                             aRangeSelListeners;
 149     std::vector<css::uno::Reference<css::sheet::XRangeSelectionChangeListener> >
 150                                             aRangeChgListeners;
 151     std::vector<css::uno::Reference<css::beans::XPropertyChangeListener> >
 152                                             aPropertyChgListeners;
 153     std::vector<css::uno::Reference<css::awt::XEnhancedMouseClickHandler> >
 154                                             aMouseClickHandlers;
 155     std::vector<css::uno::Reference<css::sheet::XActivationEventListener> >
 156                                             aActivationListeners;
 157     SCTAB                                   nPreviousTab;
 158     bool                                    bDrawSelModeSet;
 159     bool                                    bFilteredRangeSelection;
 160
 161     rtl::Reference<ScViewPaneObj> GetObjectByIndex_Impl(sal_uInt16 nIndex) const;
 162     sal_Int16                   GetZoom() const;
 163     void                    SetZoom(sal_Int16 Zoom);
 164     sal_Int16                   GetZoomType() const;
 165     void                    SetZoomType(sal_Int16 ZoomType);
 166
 167     css::uno::Reference< css::uno::XInterface > GetClickedObject(const Point& rPoint) const;
 168     void                    EndMouseListening();
 169     void                    EndActivationListening();
 170     bool                    mbLeftMousePressed;
 171 public:
 172                             ScTabViewObj(ScTabViewShell* pViewSh);
 173                             ScTabViewObj() = delete;
 174     virtual                 ~ScTabViewObj() override;
 175
 176     virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) override;
 177     virtual void SAL_CALL   acquire() noexcept override;
 178     virtual void SAL_CALL   release() noexcept override;
 179
 180     void                    SelectionChanged();
 181     void                    VisAreaChanged();
 182     // bSameTabButMoved = true if the same sheet as before is activated, used after moving/copying/inserting/deleting a sheet
 183     void                    SheetChanged( bool bSameTabButMoved );
 184     bool                    IsMouseListening() const;
 185     /// @throws css::uno::RuntimeException
 186     bool                    MousePressed( const css::awt::MouseEvent& e );
 187     /// @throws css::uno::RuntimeException
 188     bool                    MouseReleased( const css::awt::MouseEvent& e );
 189
 190     void                    RangeSelDone( const OUString& rText );
 191     void                    RangeSelAborted( const OUString& rText );
 192     void                    RangeSelChanged( const OUString& rText );
 193
 194                             // XSelectionSupplier
 195     virtual sal_Bool SAL_CALL select( const css::uno::Any& aSelection ) override;
 196     virtual css::uno::Any SAL_CALL getSelection() override;
 197     virtual void SAL_CALL   addSelectionChangeListener( const css::uno::Reference< css::view::XSelectionChangeListener >& xListener ) override;
 198     virtual void SAL_CALL   removeSelectionChangeListener( const css::uno::Reference< css::view::XSelectionChangeListener >& xListener ) override;
 199
 200     //! XPrintable?
 201
 202                             // XPropertySet
 203     virtual css::uno::Reference< css::beans::XPropertySetInfo >
 204                             SAL_CALL getPropertySetInfo() override;
 205     virtual void SAL_CALL   setPropertyValue( const OUString& aPropertyName,
 206                                     const css::uno::Any& aValue ) override;
 207     virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
 208     virtual void SAL_CALL   addPropertyChangeListener( const OUString& aPropertyName,
 209                                     const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener ) override;
 210     virtual void SAL_CALL   removePropertyChangeListener( const OUString& aPropertyName,
 211                                     const css::uno::Reference< css::beans::XPropertyChangeListener >& aListener ) override;
 212     virtual void SAL_CALL   addVetoableChangeListener( const OUString& PropertyName,
 213                                     const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
 214     virtual void SAL_CALL   removeVetoableChangeListener( const OUString& PropertyName,
 215                                     const css::uno::Reference<
 216                                         css::beans::XVetoableChangeListener >& aListener ) override;
 217
 218                             // XEnumerationAccess
 219     virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL
 220                             createEnumeration() override;
 221
 222                             // XIndexAccess
 223     virtual sal_Int32 SAL_CALL getCount() override;
 224     virtual css::uno::Any SAL_CALL getByIndex( sal_Int32 Index ) override;
 225
 226                             // XElementAccess
 227     virtual css::uno::Type SAL_CALL getElementType() override;
 228     virtual sal_Bool SAL_CALL hasElements() override;
 229
 230                             // XSpreadsheetView
 231     virtual css::uno::Reference< css::sheet::XSpreadsheet > SAL_CALL
 232                             getActiveSheet() override;
 233     virtual void SAL_CALL   setActiveSheet( const css::uno::Reference< css::sheet::XSpreadsheet >& xActiveSheet ) override;
 234
 235                             //XEnhancedMouseClickBroadcaster
 236
 237     virtual void SAL_CALL addEnhancedMouseClickHandler( const css::uno::Reference<
 238                                 css::awt::XEnhancedMouseClickHandler >& aListener ) override;
 239     virtual void SAL_CALL removeEnhancedMouseClickHandler( const css::uno::Reference< css::awt::XEnhancedMouseClickHandler >& aListener ) override;
 240
 241                             //XActivationBroadcaster
 242
 243     virtual void SAL_CALL addActivationEventListener( const css::uno::Reference< css::sheet::XActivationEventListener >& aListener ) override;
 244     virtual void SAL_CALL removeActivationEventListener( const css::uno::Reference< css::sheet::XActivationEventListener >& aListener ) override;
 245
 246                             // XViewSplitable
 247     virtual sal_Bool SAL_CALL getIsWindowSplit() override;
 248     virtual sal_Int32 SAL_CALL getSplitHorizontal() override;
 249     virtual sal_Int32 SAL_CALL getSplitVertical() override;
 250     virtual sal_Int32 SAL_CALL getSplitColumn() override;
 251     virtual sal_Int32 SAL_CALL getSplitRow() override;
 252     virtual void SAL_CALL   splitAtPosition( sal_Int32 nPixelX, sal_Int32 nPixelY ) override;
 253
 254                             // XViewFreezable
 255     virtual sal_Bool SAL_CALL hasFrozenPanes() override;
 256     virtual void SAL_CALL   freezeAtPosition( sal_Int32 nColumns, sal_Int32 nRows ) override;
 257
 258                             // XRangeSelection
 259     virtual void SAL_CALL   startRangeSelection( const css::uno::Sequence< css::beans::PropertyValue >& aArguments ) override;
 260     virtual void SAL_CALL   abortRangeSelection() override;
 261     virtual void SAL_CALL   addRangeSelectionListener( const css::uno::Reference< css::sheet::XRangeSelectionListener >& aListener ) override;
 262     virtual void SAL_CALL   removeRangeSelectionListener( const css::uno::Reference< css::sheet::XRangeSelectionListener >& aListener ) override;
 263     virtual void SAL_CALL   addRangeSelectionChangeListener( const css::uno::Reference< css::sheet::XRangeSelectionChangeListener >& aListener ) override;
 264     virtual void SAL_CALL   removeRangeSelectionChangeListener( const css::uno::Reference< css::sheet::XRangeSelectionChangeListener >& aListener ) override;
 265
 266                             // XServiceInfo
 267     virtual OUString SAL_CALL getImplementationName() override;
 268     virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
 269     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 270
 271                             // XUnoTunnel
 272     UNO3_GETIMPLEMENTATION_DECL(ScTabViewObj)
 273
 274                             // XTypeProvider
 275     virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() override;
 276     virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() override;
 277
 278     // XTransferableSupplier
 279     virtual css::uno::Reference< css::datatransfer::XTransferable > SAL_CALL getTransferable() override;
 280     virtual void SAL_CALL insertTransferable( const css::uno::Reference< css::datatransfer::XTransferable >& xTrans ) override;
 281
 282     // XSelectedSheetsSupplier
 283     virtual css::uno::Sequence<sal_Int32> SAL_CALL getSelectedSheets() override;
 284 };
 285
 286 class ScPreviewObj final : public SfxBaseController,
 287                      public SfxListener,
 288                      public css::sheet::XSelectedSheetsSupplier
 289 {
 290     ScPreviewShell* mpViewShell;
 291 public:
 292     ScPreviewObj(ScPreviewShell* pViewSh);
 293     virtual ~ScPreviewObj() override;
 294
 295     virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType) override;
 296
 297     virtual void SAL_CALL acquire() noexcept override;
 298     virtual void SAL_CALL release() noexcept override;
 299
 300     virtual void Notify(SfxBroadcaster&, const SfxHint& rHint) override;
 301
 302     // XSelectedSheetsSupplier
 303     virtual css::uno::Sequence<sal_Int32> SAL_CALL getSelectedSheets() override;
 304 };
 305
 306 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */