include/sfx2/viewsh.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 #ifndef INCLUDED_SFX2_VIEWSH_HXX
  20 #define INCLUDED_SFX2_VIEWSH_HXX
  21
  22 #include <sal/config.h>
  23 #include <memory>
  24 #include <sfx2/dllapi.h>
  25 #include <sal/types.h>
  26 #include <com/sun/star/embed/XEmbeddedObject.hpp>
  27 #include <com/sun/star/frame/XController.hpp>
  28 #include <com/sun/star/view/XRenderable.hpp>
  29 #include <com/sun/star/uno/Reference.h>
  30 #include <svl/lstner.hxx>
  31 #include <com/sun/star/ui/XContextMenuInterceptor.hpp>
  32 #include <com/sun/star/datatransfer/clipboard/XClipboardListener.hpp>
  33 #include <com/sun/star/datatransfer/clipboard/XClipboardNotifier.hpp>
  34 #include <cppuhelper/interfacecontainer.hxx>
  35 #include <sfx2/shell.hxx>
  36 #include <tools/gen.hxx>
  37 #include <tools/errcode.hxx>
  38 #include <vcl/jobset.hxx>
  39 #include <o3tl/typed_flags_set.hxx>
  40 #include <vcl/vclptr.hxx>
  41 #include <sfx2/tabdlg.hxx>
  42 #include <LibreOfficeKit/LibreOfficeKitTypes.h>
  43 #include <functional>
  44
  45 class SfxBaseController;
  46 class Size;
  47 class Fraction;
  48 namespace vcl { class Window; }
  49 class KeyEvent;
  50 class WorkWindow;
  51 class SvBorder;
  52 class SdrView;
  53 class SfxFrame;
  54 class SfxMedium;
  55 class SfxModule;
  56 class SfxViewFrame;
  57 class SfxItemPool;
  58 class SfxFrameSetDescriptor;
  59 class Printer;
  60 class SfxPrinter;
  61 class SfxProgress;
  62 class SfxFrameItem;
  63 class Dialog;
  64 class Menu;
  65 class NotifyEvent;
  66 class SfxInPlaceClient;
  67 namespace vcl { class PrinterController; }
  68
  69
  70 enum class SfxPrinterChangeFlags
  71 {
  72     NONE             = 0,
  73     PRINTER          = 1,  // without JOB SETUP => Temporary
  74     JOBSETUP         = 2,
  75     OPTIONS          = 4,
  76     CHG_ORIENTATION  = 8,
  77     CHG_SIZE         = 16
  78 };
  79 namespace o3tl
  80 {
  81     template<> struct typed_flags<SfxPrinterChangeFlags> : is_typed_flags<SfxPrinterChangeFlags, 31> {};
  82 }
  83 #define SFX_PRINTER_ALL             (SfxPrinterChangeFlags::PRINTER | SfxPrinterChangeFlags::JOBSETUP | SfxPrinterChangeFlags::OPTIONS | SfxPrinterChangeFlags::CHG_ORIENTATION | SfxPrinterChangeFlags::CHG_SIZE)
  84
  85 #define SFX_PRINTERROR_BUSY          1
  86
  87 // "Verified" using www.apple.com and Netscape 3.01
  88 #define DEFAULT_MARGIN_WIDTH 8
  89 #define DEFAULT_MARGIN_HEIGHT 12
  90
  91
  92 //  @[SfxViewShell-Flags]
  93
  94 enum class SfxViewShellFlags
  95 {
  96     NONE              = 0x0000,
  97     HAS_PRINTOPTIONS  = 0x0010, /* Options-Button and Options-Dialog in PrintDialog */
  98     CAN_PRINT         = 0x0020, /* Printing enabled without having to create a Printer */
  99     NO_SHOW           = 0x0040, /* Window of the ViewShell shall not be showed automatically */
 100     NO_NEWWINDOW      = 0x0100, /* Allow N View */
 101 };
 102 namespace o3tl
 103 {
 104     template<> struct typed_flags<SfxViewShellFlags> : is_typed_flags<SfxViewShellFlags, 0x0170> {};
 105 }
 106
 107 /*  [Description]
 108
 109     The SfxViewShell flags control the behavior of SfxViewShell for the
 110     duration of its lifetime. They are defined in the constructor of
 111     <SfxViewShell>.
 112 */
 113
 114
 115 #define SFX_DECL_VIEWFACTORY(Class) \
 116 private: \
 117     static SfxViewFactory *pFactory; \
 118 public: \
 119     static SfxViewShell  *CreateInstance(SfxViewFrame *pFrame, SfxViewShell *pOldView); \
 120     static void           RegisterFactory( sal_uInt16 nPrio = USHRT_MAX ); \
 121     static SfxViewFactory*Factory() { return pFactory; } \
 122     static void           InitFactory()
 123
 124 #define SFX_IMPL_NAMED_VIEWFACTORY(Class, AsciiViewName) \
 125     SfxViewFactory* Class::pFactory; \
 126     SfxViewShell* Class::CreateInstance(SfxViewFrame *pFrame, SfxViewShell *pOldView) \
 127     { return new Class(pFrame, pOldView); } \
 128     void Class::RegisterFactory( sal_uInt16 nPrio ) \
 129     { \
 130         pFactory = new SfxViewFactory(&CreateInstance,nPrio,AsciiViewName);\
 131         InitFactory(); \
 132     } \
 133     void Class::InitFactory()
 134
 135 #define SFX_VIEW_REGISTRATION(DocClass) \
 136             DocClass::Factory().RegisterViewFactory( *Factory() )
 137
 138 template<class T> bool checkSfxViewShell(const SfxViewShell* pShell)
 139 {
 140     return dynamic_cast<const T*>(pShell) != nullptr;
 141 }
 142
 143 class SFX2_DLLPUBLIC SfxViewShell: public SfxShell, public SfxListener
 144 {
 145 #ifdef INCLUDED_SFX2_VIEWSH_HXX
 146 friend class SfxViewFrame;
 147 friend class SfxBaseController;
 148 friend class SfxPrinterController;
 149 #endif
 150
 151     struct SfxViewShell_Impl*   pImp;
 152     SfxViewFrame*               pFrame;
 153     SfxShell*                   pSubShell;
 154     VclPtr<vcl::Window>         pWindow;
 155     bool                        bNoNewWindow;
 156     bool                        mbPrinterSettingsModified;
 157
 158 protected:
 159     virtual void                Activate(bool IsMDIActivate) override;
 160     virtual void                Deactivate(bool IsMDIActivate) override;
 161
 162     virtual void                InnerResizePixel( const Point &rOfs, const Size &rSize );
 163     virtual void                OuterResizePixel( const Point &rOfs, const Size &rSize );
 164     virtual void                SetZoomFactor( const Fraction &rZoomX, const Fraction &rZoomY );
 165
 166     virtual void                Move();
 167
 168     virtual void                Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) override;
 169
 170 public:
 171     // Iteration
 172     static SfxViewShell*        GetFirst( bool bOnlyVisible = true, const std::function<bool ( const SfxViewShell* )>& isViewShell = nullptr );
 173     static SfxViewShell*        GetNext( const SfxViewShell& rPrev,
 174                                          bool bOnlyVisible = true,
 175                                          const std::function<bool ( const SfxViewShell* )>& isViewShell = nullptr );
 176     static SfxViewShell*        Current();
 177
 178     static SfxViewShell*        Get( const css::uno::Reference< css::frame::XController>& i_rController );
 179
 180     // Initialize Constructors/Destructors
 181                                 SFX_DECL_INTERFACE(SFX_INTERFACE_SFXVIEWSH)
 182
 183 private:
 184     /// SfxInterface initializer.
 185     static void InitInterface_Impl();
 186
 187 public:
 188
 189                                 SfxViewShell( SfxViewFrame *pFrame, SfxViewShellFlags nFlags = SfxViewShellFlags::NONE );
 190     virtual                     ~SfxViewShell();
 191
 192     SfxInPlaceClient*           GetIPClient() const;
 193     SfxInPlaceClient*           GetUIActiveClient() const;
 194     SfxInPlaceClient*           FindIPClient( const css::uno::Reference < css::embed::XEmbeddedObject >&  xObj, vcl::Window *pObjParentWin ) const;
 195
 196     virtual ErrCode             DoVerb(long nVerb);
 197
 198     void                        OutplaceActivated( bool bActive, SfxInPlaceClient* pClient );
 199     virtual void                UIActivating( SfxInPlaceClient* pClient );
 200     virtual void                UIDeactivated( SfxInPlaceClient* pClient );
 201
 202     void                        JumpToMark( const OUString& rMark );
 203     void                        VisAreaChanged(const Rectangle& rRect);
 204
 205     // Misc
 206
 207     /**
 208      * Initialize is called after the frame has been loaded and the controller
 209      * has been set.  By the time this is called the document has been fully
 210      * imported.
 211      */
 212     virtual bool                PrepareClose( bool bUI = true );
 213     virtual OUString            GetSelectionText( bool bCompleteWords = false );
 214     virtual bool                HasSelection( bool bText = true ) const;
 215     virtual SdrView*            GetDrawView() const;
 216
 217     SfxShell*                   GetSubShell() const { return pSubShell; }
 218     void                        AddSubShell( SfxShell& rShell );
 219     void                        RemoveSubShell( SfxShell *pShell=nullptr );
 220     SfxShell*                   GetSubShell( sal_uInt16 );
 221
 222     virtual       SfxShell*     GetFormShell()       { return nullptr; };
 223     virtual const SfxShell*     GetFormShell() const { return nullptr; };
 224
 225     // Focus, KeyInput, Cursor
 226     virtual void                ShowCursor( bool bOn = true );
 227     virtual bool                KeyInput( const KeyEvent &rKeyEvent );
 228     bool                        Escape();
 229
 230     // Viewing Interface
 231     vcl::Window*                GetWindow() const { return pWindow; }
 232     void                        SetWindow( vcl::Window *pViewPort );
 233     virtual void                AdjustPosSizePixel( const Point &rOfs, const Size &rSize );
 234     const SvBorder&             GetBorderPixel() const;
 235     void                        SetBorderPixel( const SvBorder &rBorder );
 236     void                        InvalidateBorder();
 237     inline SfxViewFrame*        GetViewFrame() const;
 238
 239     // Printing Interface
 240     virtual SfxPrinter*         GetPrinter( bool bCreate = false );
 241     virtual sal_uInt16          SetPrinter( SfxPrinter *pNewPrinter, SfxPrinterChangeFlags nDiffFlags = SFX_PRINTER_ALL );
 242     virtual bool                HasPrintOptionsPage() const;
 243     virtual VclPtr<SfxTabPage>  CreatePrintOptionsPage( vcl::Window *pParent, const SfxItemSet &rOptions );
 244     static JobSetup             GetJobSetup();
 245     Printer*                    GetActivePrinter() const;
 246
 247     // Working set
 248     virtual void                WriteUserData( OUString&, bool bBrowse = false );
 249     virtual void                ReadUserData( const OUString&, bool bBrowse = false );
 250     virtual void                WriteUserDataSequence ( css::uno::Sequence < css::beans::PropertyValue >& );
 251     virtual void                ReadUserDataSequence ( const css::uno::Sequence < css::beans::PropertyValue >& );
 252     virtual void                QueryObjAreaPixel( Rectangle& rRect ) const;
 253
 254     virtual SfxObjectShell*     GetObjectShell() override;
 255
 256     /** retrieves the document which shall be considered the "current document" when the frame is active
 257
 258         The default implementation simply returns the XModel of the associated SfxObjectShell. You will rarely
 259         need to overwrite this behavior.
 260     */
 261     virtual css::uno::Reference< css::frame::XModel >
 262                                 GetCurrentDocument() const;
 263
 264     /** forwards the current document, as returned by ->GetCurrentDocument, to SfxObjectShell::SetWorkingDocument
 265     */
 266     void                        SetCurrentDocument() const;
 267
 268     /** get an XRenderable instance that can render this document
 269     */
 270     virtual css::uno::Reference< css::view::XRenderable > GetRenderable();
 271
 272
 273     virtual void                MarginChanged();
 274     const Size&                 GetMargin() const;
 275     void                        SetMargin( const Size& );
 276     void                        DisconnectAllClients();
 277     bool                        NewWindowAllowed() const            { return !bNoNewWindow; }
 278     void                        SetNewWindowAllowed( bool bSet )    { bNoNewWindow = !bSet; }
 279
 280     void                        SetController( SfxBaseController* pController );
 281     css::uno::Reference< css::frame::XController >
 282                                 GetController();
 283
 284     bool                        TryContextMenuInterception( Menu& rIn, const OUString& rMenuIdentifier, Menu*& rpOut, css::ui::ContextMenuExecuteEvent aEvent );
 285     bool                        TryContextMenuInterception( Menu& rMenu, const OUString& rMenuIdentifier, css::ui::ContextMenuExecuteEvent aEvent );
 286
 287     void                        ExecPrint( const css::uno::Sequence < css::beans::PropertyValue >&, bool, bool );
 288     // Like ExecPrint(), but only sets up for printing. Use Printer::ExecutePrintJob() and Printer::FinishPrintJob() afterwards.
 289     void                        StartPrint( const css::uno::Sequence < css::beans::PropertyValue >&, bool, bool );
 290     const std::shared_ptr< vcl::PrinterController >& GetPrinterController() const;
 291
 292     void                        AddRemoveClipboardListener( const css::uno::Reference < css::datatransfer::clipboard::XClipboardListener>&, bool );
 293     css::uno::Reference< css::datatransfer::clipboard::XClipboardNotifier > GetClipboardNotifier();
 294
 295     SAL_DLLPRIVATE SfxInPlaceClient* GetUIActiveIPClient_Impl() const;
 296     SAL_DLLPRIVATE void AddContextMenuInterceptor_Impl( const css::uno::Reference < css::ui::XContextMenuInterceptor >& xInterceptor );
 297     SAL_DLLPRIVATE void RemoveContextMenuInterceptor_Impl( const css::uno::Reference < css::ui::XContextMenuInterceptor >& xInterceptor );
 298     SAL_DLLPRIVATE bool GlobalKeyInput_Impl( const KeyEvent &rKeyEvent );
 299
 300     SAL_DLLPRIVATE void NewIPClient_Impl( SfxInPlaceClient *pIPClient );
 301     SAL_DLLPRIVATE void IPClientGone_Impl( SfxInPlaceClient *pIPClient );
 302     SAL_DLLPRIVATE void ResetAllClients_Impl( SfxInPlaceClient *pIP );
 303     SAL_DLLPRIVATE void DiscardClients_Impl();
 304
 305     SAL_DLLPRIVATE void SetPrinter_Impl( VclPtr<SfxPrinter>& pNewPrinter );
 306     SAL_DLLPRIVATE bool IsShowView_Impl() const;
 307
 308     SAL_DLLPRIVATE bool HandleNotifyEvent_Impl( NotifyEvent& rEvent );
 309     SAL_DLLPRIVATE bool HasKeyListeners_Impl();
 310     SAL_DLLPRIVATE bool HasMouseClickListeners_Impl();
 311
 312     SAL_DLLPRIVATE SfxBaseController*   GetBaseController_Impl() const;
 313
 314     // Shell Interface
 315     SAL_DLLPRIVATE void ExecPrint_Impl(SfxRequest &);
 316     SAL_DLLPRIVATE void ExecMisc_Impl(SfxRequest &);
 317     SAL_DLLPRIVATE void GetState_Impl(SfxItemSet&);
 318     SAL_DLLPRIVATE void CheckIPClient_Impl(SfxInPlaceClient*, const Rectangle&);
 319     SAL_DLLPRIVATE void PushSubShells_Impl( bool bPush=true );
 320     SAL_DLLPRIVATE void PopSubShells_Impl() { PushSubShells_Impl( false ); }
 321     SAL_DLLPRIVATE void TakeOwnership_Impl();
 322     SAL_DLLPRIVATE void TakeFrameOwnership_Impl();
 323     SAL_DLLPRIVATE bool ExecKey_Impl(const KeyEvent& aKey);
 324
 325     /// The actual per-view implementation of lok::Document::registerCallback().
 326     void registerLibreOfficeKitViewCallback(LibreOfficeKitCallback pCallback, void* pLibreOfficeKitData);
 327     /// Invokes the registered callback, if there are any.
 328     void libreOfficeKitViewCallback(int nType, const char* pPayload) const;
 329 };
 330
 331
 332 inline SfxViewFrame* SfxViewShell::GetViewFrame() const
 333
 334 /*  [Description]
 335
 336     This method returns a pointer to the <SfxViewFrame> Instance in which
 337     this SfxViewShell is displayed. This is the instance that was passed
 338     on in the constructor. It is guaranteed that the returned pointer
 339     points on the valid SfxViewFrame instance.
 340
 341     [Cross-reference]
 342
 343     <SfxShell::GetFrame()const>
 344 */
 345
 346 {
 347     return pFrame;
 348 }
 349
 350 #endif // INCLUDED_SFX2_VIEWSH_HXX
 351
 352
 353 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */