/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed * with this work for additional information regarding copyright * ownership. The ASF licenses this file to you under the Apache * License, Version 2.0 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . */ #ifndef INCLUDED_SFX2_VIEWSH_HXX #define INCLUDED_SFX2_VIEWSH_HXX #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include class SfxBaseController; class Size; class Fraction; namespace vcl { class Window; } class KeyEvent; class WorkWindow; class SvBorder; class SdrView; class SfxFrame; class SfxMedium; class SfxModule; class SfxViewFrame; class SfxItemPool; class SfxTabPage; class SfxFrameSetDescriptor; class Printer; class SfxPrinter; class SfxProgress; class SfxFrameItem; class Dialog; class Menu; class NotifyEvent; #define SFX_PRINTER_PRINTER 1 // without JOB SETUP => Temporary #define SFX_PRINTER_JOBSETUP 2 #define SFX_PRINTER_OPTIONS 4 #define SFX_PRINTER_CHG_ORIENTATION 8 #define SFX_PRINTER_CHG_SIZE 16 #define SFX_PRINTER_ALL 31 #define SFX_PRINTER_CHG_ORIENTATION_FLAG 3 #define SFX_PRINTER_CHG_SIZE_FLAG 4 #define SFX_PRINTERROR_NONE 0 #define SFX_PRINTERROR_BUSY 1 // "Verified" using www.apple.com and Netscape 3.01 #define DEFAULT_MARGIN_WIDTH 8 #define DEFAULT_MARGIN_HEIGHT 12 // @[SfxViewShell-Flags] #define SFX_VIEW_HAS_PRINTOPTIONS 0x0010 /* Options-Button and Options- Dialog in PrintDialog */ #define SFX_VIEW_CAN_PRINT 0x0020 /* Printing enabled without having to create a Printer */ #define SFX_VIEW_NO_SHOW 0x0040 /* Window of the ViewShell shall not be showed automatically */ #define SFX_VIEW_NO_NEWWINDOW 0x0100 /* Allow N View */ /* [Description] The SfxViewShell flags control the behavior of SfxViewShell for the duration of its lifetime. They are defined in the constructor of . */ #define SFX_DECL_VIEWFACTORY(Class) \ private: \ static SfxViewFactory *pFactory; \ public: \ static SfxViewShell *CreateInstance(SfxViewFrame *pFrame, SfxViewShell *pOldView); \ static void RegisterFactory( sal_uInt16 nPrio = USHRT_MAX ); \ static SfxViewFactory*Factory() { return pFactory; } \ static void InitFactory() #define SFX_IMPL_NAMED_VIEWFACTORY(Class, AsciiViewName) \ SfxViewFactory* Class::pFactory; \ SfxViewShell* Class::CreateInstance(SfxViewFrame *pFrame, SfxViewShell *pOldView) \ { return new Class(pFrame, pOldView); } \ void Class::RegisterFactory( sal_uInt16 nPrio ) \ { \ pFactory = new SfxViewFactory(&CreateInstance,nPrio,AsciiViewName);\ InitFactory(); \ } \ void Class::InitFactory() #define SFX_VIEW_REGISTRATION(DocClass) \ DocClass::Factory().RegisterViewFactory( *Factory() ) class SfxInPlaceClient; typedef ::std::vector< SfxInPlaceClient* > SfxInPlaceClientList; class SFX2_DLLPUBLIC SfxViewShell: public SfxShell, public SfxListener { #ifdef INCLUDED_SFX2_VIEWSH_HXX friend class SfxViewFrame; friend class SfxBaseController; friend class SfxPrinterController; #endif struct SfxViewShell_Impl* pImp; SfxInPlaceClientList* pIPClientList; SfxViewFrame* pFrame; SfxShell* pSubShell; vcl::Window* pWindow; bool bNoNewWindow; protected: virtual void Activate(bool IsMDIActivate) SAL_OVERRIDE; virtual void Deactivate(bool IsMDIActivate) SAL_OVERRIDE; virtual void InnerResizePixel( const Point &rOfs, const Size &rSize ); virtual void OuterResizePixel( const Point &rOfs, const Size &rSize ); virtual void SetZoomFactor( const Fraction &rZoomX, const Fraction &rZoomY ); virtual void Move(); virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) SAL_OVERRIDE; public: // Iteration static SfxViewShell* GetFirst( const TypeId* pType = 0, bool bOnlyVisible = true ); static SfxViewShell* GetNext( const SfxViewShell& rPrev, const TypeId* pType = 0, bool bOnlyVisible = true ); static SfxViewShell* Current(); static SfxViewShell* Get( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController>& i_rController ); // Initialize Constructors/Destructors TYPEINFO_OVERRIDE(); SFX_DECL_INTERFACE(SFX_INTERFACE_SFXVIEWSH) private: /// SfxInterface initializer. static void InitInterface_Impl(); public: SfxViewShell( SfxViewFrame *pFrame, sal_uInt16 nFlags = 0 ); virtual ~SfxViewShell(); SfxInPlaceClient* GetIPClient() const; SfxInPlaceClient* GetUIActiveClient() const; SfxInPlaceClient* FindIPClient( const ::com::sun::star::uno::Reference < ::com::sun::star::embed::XEmbeddedObject >& xObj, vcl::Window *pObjParentWin ) const; virtual ErrCode DoVerb(long nVerb); virtual void OutplaceActivated( bool bActive, SfxInPlaceClient* pClient ); virtual void InplaceActivating( SfxInPlaceClient* pClient ); virtual void InplaceDeactivated( SfxInPlaceClient* pClient ); virtual void UIActivating( SfxInPlaceClient* pClient ); virtual void UIDeactivated( SfxInPlaceClient* pClient ); void JumpToMark( const OUString& rMark ); void VisAreaChanged(const Rectangle& rRect); // Misc /** * Initialize is called after the frame has been loaded and the controller * has been set. By the time this is called the document has been fully * imported. */ virtual void Initialize(); virtual bool PrepareClose( bool bUI = true ); virtual OUString GetSelectionText( bool bCompleteWords = false ); virtual bool HasSelection( bool bText = true ) const; virtual SdrView* GetDrawView() const; SfxShell* GetSubShell() const { return pSubShell; } void AddSubShell( SfxShell& rShell ); void RemoveSubShell( SfxShell *pShell=NULL ); SfxShell* GetSubShell( sal_uInt16 ); virtual SfxShell* GetFormShell() { return 0; }; virtual const SfxShell* GetFormShell() const { return 0; }; // Focus, KeyInput, Cursor void GotFocus() const; inline void LostFocus() const; virtual void ShowCursor( bool bOn = true ); virtual bool KeyInput( const KeyEvent &rKeyEvent ); bool Escape(); // Viewing Interface vcl::Window* GetWindow() const { return pWindow; } void SetWindow( vcl::Window *pViewPort ); virtual void AdjustPosSizePixel( const Point &rOfs, const Size &rSize ); const SvBorder& GetBorderPixel() const; void SetBorderPixel( const SvBorder &rBorder ); void InvalidateBorder(); inline SfxViewFrame* GetViewFrame() const; // Printing Interface virtual SfxPrinter* GetPrinter( bool bCreate = false ); virtual sal_uInt16 SetPrinter( SfxPrinter *pNewPrinter, sal_uInt16 nDiffFlags = SFX_PRINTER_ALL, bool bIsAPI=false ); virtual bool HasPrintOptionsPage() const; virtual SfxTabPage* CreatePrintOptionsPage( vcl::Window *pParent, const SfxItemSet &rOptions ); virtual JobSetup GetJobSetup() const; Printer* GetActivePrinter() const; // Working set virtual void WriteUserData( OUString&, bool bBrowse = false ); virtual void ReadUserData( const OUString&, bool bBrowse = false ); virtual void WriteUserDataSequence ( ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue >&, bool bBrowse = false ); virtual void ReadUserDataSequence ( const ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue >&, bool bBrowse = false ); virtual void QueryObjAreaPixel( Rectangle& rRect ) const; virtual SfxObjectShell* GetObjectShell() SAL_OVERRIDE; /** retrieves the document which shall be considered the "current document" when the frame is active The default implementation simply returns the XModel of the associated SfxObjectShell. You will rarely need to overwrite this behavior. */ virtual ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel > GetCurrentDocument() const; /** forwards the current document, as returned by ->GetCurrentDocument, to SfxObjectShell::SetWorkingDocument */ void SetCurrentDocument() const; /** get an XRenderable instance that can render this document */ virtual com::sun::star::uno::Reference< com::sun::star::view::XRenderable > GetRenderable(); virtual void MarginChanged(); const Size& GetMargin() const; void SetMargin( const Size& ); void DisconnectAllClients(); virtual SfxFrame* GetSmartSelf( SfxFrame* pSelf, SfxMedium& rMedium ); bool NewWindowAllowed() const { return !bNoNewWindow; } void SetNewWindowAllowed( bool bSet ) { bNoNewWindow = !bSet; } void SetController( SfxBaseController* pController ); ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController > GetController(); bool TryContextMenuInterception( Menu& rIn, const OUString& rMenuIdentifier, Menu*& rpOut, ::com::sun::star::ui::ContextMenuExecuteEvent aEvent ); void ExecPrint( const com::sun::star::uno::Sequence < com::sun::star::beans::PropertyValue >&, bool, bool ); void AddRemoveClipboardListener( const com::sun::star::uno::Reference < com::sun::star::datatransfer::clipboard::XClipboardListener>&, bool ); ::com::sun::star::uno::Reference< ::com::sun::star::datatransfer::clipboard::XClipboardNotifier > GetClipboardNotifier(); SAL_DLLPRIVATE SfxInPlaceClient* GetUIActiveIPClient_Impl() const; SAL_DLLPRIVATE void AddContextMenuInterceptor_Impl( const ::com::sun::star::uno::Reference < ::com::sun::star::ui::XContextMenuInterceptor >& xInterceptor ); SAL_DLLPRIVATE void RemoveContextMenuInterceptor_Impl( const ::com::sun::star::uno::Reference < ::com::sun::star::ui::XContextMenuInterceptor >& xInterceptor ); SAL_DLLPRIVATE bool GlobalKeyInput_Impl( const KeyEvent &rKeyEvent ); SAL_DLLPRIVATE void NewIPClient_Impl( SfxInPlaceClient *pIPClient ) { GetIPClientList_Impl(true)->push_back(pIPClient); } SAL_DLLPRIVATE void IPClientGone_Impl( SfxInPlaceClient *pIPClient ); SAL_DLLPRIVATE SfxInPlaceClientList* GetIPClientList_Impl( bool bCreate = true ) const; SAL_DLLPRIVATE void ResetAllClients_Impl( SfxInPlaceClient *pIP ); SAL_DLLPRIVATE void DiscardClients_Impl(); SAL_DLLPRIVATE SfxPrinter* SetPrinter_Impl( SfxPrinter *pNewPrinter ); SAL_DLLPRIVATE bool IsShowView_Impl() const; SAL_DLLPRIVATE bool HandleNotifyEvent_Impl( NotifyEvent& rEvent ); SAL_DLLPRIVATE bool HasKeyListeners_Impl(); SAL_DLLPRIVATE bool HasMouseClickListeners_Impl(); SAL_DLLPRIVATE SfxBaseController* GetBaseController_Impl() const; // Shell Interface SAL_DLLPRIVATE void ExecPrint_Impl(SfxRequest &); SAL_DLLPRIVATE void ExecMisc_Impl(SfxRequest &); SAL_DLLPRIVATE void GetState_Impl(SfxItemSet&); SAL_DLLPRIVATE SfxFrameSetDescriptor* GetFrameSet_Impl() const; SAL_DLLPRIVATE void SetFrameSet_Impl(SfxFrameSetDescriptor*); SAL_DLLPRIVATE void CheckIPClient_Impl( SfxInPlaceClient*, const Rectangle& ); SAL_DLLPRIVATE void PushSubShells_Impl( bool bPush=true ); SAL_DLLPRIVATE void PopSubShells_Impl() { PushSubShells_Impl( false ); } SAL_DLLPRIVATE void TakeOwnership_Impl(); SAL_DLLPRIVATE void TakeFrameOwnership_Impl(); SAL_DLLPRIVATE bool ExecKey_Impl(const KeyEvent& aKey); }; inline void SfxViewShell::LostFocus() const /* [Description] This method has to be called by the application developer, if the edit window has lost the focus. The SFx has for example the ability to turn off the accelerator, so that the cursor keys, the Delete button, etc. work in certain Floating-Windows, even though they are redefined by the Accelerator. [Note] unfortunately does not provide the possibility to define such events 'from the side'. */ { } inline SfxViewFrame* SfxViewShell::GetViewFrame() const /* [Description] This method returns a pointer to the Instance in which this SfxViewShell is displayed. This is the instance that was passed on in the constructor. It is guaranteed that the returned pointer points on the valid SfxViewFrame instance. [Cross-reference] */ { return pFrame; } #endif // INCLUDED_SFX2_VIEWSH_HXX /* vim:set shiftwidth=4 softtabstop=4 expandtab: */