diff options
Diffstat (limited to 'include/sfx2/viewsh.hxx')
| -rw-r--r-- | include/sfx2/viewsh.hxx | 343 |
1 files changed, 343 insertions, 0 deletions
diff --git a/include/sfx2/viewsh.hxx b/include/sfx2/viewsh.hxx new file mode 100644 index 000000000000..ad4c64cd5272 --- /dev/null +++ b/include/sfx2/viewsh.hxx @@ -0,0 +1,343 @@ +/* -*- 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 _SFXVIEWSH_HXX +#define _SFXVIEWSH_HXX + +#include "sal/config.h" +#include "sfx2/dllapi.h" +#include "sal/types.h" +#include <com/sun/star/embed/XEmbeddedObject.hpp> +#include <com/sun/star/frame/XController.hpp> +#include <com/sun/star/view/XRenderable.hpp> +#include <com/sun/star/uno/Reference.h> +#include <svl/lstner.hxx> +#include <com/sun/star/ui/XContextMenuInterceptor.hpp> +#include <com/sun/star/datatransfer/clipboard/XClipboardListener.hpp> +#include <com/sun/star/datatransfer/clipboard/XClipboardNotifier.hpp> +#include <cppuhelper/interfacecontainer.hxx> +#include "shell.hxx" +#include <tools/gen.hxx> +#include <tools/errcode.hxx> +#include <vcl/jobset.hxx> +#include <vector> + +class SfxBaseController; +class Size; +class Fraction; +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 + <SfxViewShell>. +*/ + +//========================================================================= + +#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 _SFXVIEWSH_HXX +friend class SfxViewFrame; +friend class SfxBaseController; +friend class SfxPrinterController; +#endif + + struct SfxViewShell_Impl* pImp; + SfxInPlaceClientList* pIPClientList; + SfxViewFrame* pFrame; + SfxShell* pSubShell; + Window* pWindow; + sal_Bool bNoNewWindow; + +protected: + virtual void Activate(sal_Bool IsMDIActivate); + virtual void Deactivate(sal_Bool IsMDIActivate); + + 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 ); + +public: + // Iteration + static SfxViewShell* GetFirst( const TypeId* pType = 0, sal_Bool bOnlyVisible = sal_True ); + static SfxViewShell* GetNext( const SfxViewShell& rPrev, + const TypeId* pType = 0, sal_Bool bOnlyVisible = sal_True ); + static SfxViewShell* Current(); + + static SfxViewShell* Get( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController>& i_rController ); + + // Initialize Constructors/Destructors + TYPEINFO(); + SFX_DECL_INTERFACE(SFX_INTERFACE_SFXVIEWSH) + + 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, Window *pObjParentWin ) const; + + virtual ErrCode DoVerb(long nVerb); + + virtual void OutplaceActivated( sal_Bool bActive, SfxInPlaceClient* pClient ); + virtual void InplaceActivating( SfxInPlaceClient* pClient ); + virtual void InplaceDeactivated( SfxInPlaceClient* pClient ); + virtual void UIActivating( SfxInPlaceClient* pClient ); + virtual void UIDeactivated( SfxInPlaceClient* pClient ); + + virtual void JumpToMark( const String& rMark ); + void VisAreaChanged(const Rectangle& rRect); + + // Misc + virtual sal_uInt16 PrepareClose( sal_Bool bUI = sal_True, sal_Bool bForBrowsing = sal_False ); + virtual String GetSelectionText( sal_Bool bCompleteWords = sal_False ); + virtual sal_Bool HasSelection( sal_Bool bText = sal_True ) const; + virtual SdrView* GetDrawView() const; + + SfxShell* GetSubShell() const { return pSubShell; } + void AddSubShell( SfxShell& rShell ); + void RemoveSubShell( SfxShell *pShell=NULL ); + SfxShell* GetSubShell( sal_uInt16 ); + + // Focus, KeyInput, Cursor + void GotFocus() const; + inline void LostFocus() const; + virtual void ShowCursor( bool bOn = true ); + virtual bool KeyInput( const KeyEvent &rKeyEvent ); + sal_Bool Escape(); + + // Viewing Interface + Window* GetWindow() const { return pWindow; } + void SetWindow( 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( sal_Bool bCreate = sal_False ); + virtual sal_uInt16 SetPrinter( SfxPrinter *pNewPrinter, sal_uInt16 nDiffFlags = SFX_PRINTER_ALL, bool bIsAPI=sal_False ); + virtual bool HasPrintOptionsPage() const; + virtual SfxTabPage* CreatePrintOptionsPage( Window *pParent, const SfxItemSet &rOptions ); + virtual JobSetup GetJobSetup() const; + Printer* GetActivePrinter() const; + + // Working set + virtual void WriteUserData( String&, sal_Bool bBrowse = sal_False ); + virtual void ReadUserData( const String&, sal_Bool bBrowse = sal_False ); + virtual void WriteUserDataSequence ( ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue >&, sal_Bool bBrowse = sal_False ); + virtual void ReadUserDataSequence ( const ::com::sun::star::uno::Sequence < ::com::sun::star::beans::PropertyValue >&, sal_Bool bBrowse = sal_False ); + virtual void QueryObjAreaPixel( Rectangle& rRect ) const; + + virtual SfxObjectShell* GetObjectShell(); + /** 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 ); + sal_Bool NewWindowAllowed() const { return !bNoNewWindow; } + void SetNewWindowAllowed( sal_Bool bSet ) { bNoNewWindow = !bSet; } + + void SetController( SfxBaseController* pController ); + ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController > + GetController(); + + sal_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 >&, sal_Bool, sal_Bool ); + + void AddRemoveClipboardListener( const com::sun::star::uno::Reference < com::sun::star::datatransfer::clipboard::XClipboardListener>&, sal_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(sal_True)->push_back(pIPClient); } + SAL_DLLPRIVATE void IPClientGone_Impl( SfxInPlaceClient *pIPClient ); + SAL_DLLPRIVATE SfxInPlaceClientList* GetIPClientList_Impl( sal_Bool bCreate = sal_True ) const; + SAL_DLLPRIVATE void ResetAllClients_Impl( SfxInPlaceClient *pIP ); + SAL_DLLPRIVATE void DiscardClients_Impl(); + + SAL_DLLPRIVATE SfxPrinter* SetPrinter_Impl( SfxPrinter *pNewPrinter ); + SAL_DLLPRIVATE sal_Bool IsShowView_Impl() const; + + SAL_DLLPRIVATE long HandleNotifyEvent_Impl( NotifyEvent& rEvent ); + SAL_DLLPRIVATE sal_Bool HasKeyListeners_Impl(); + SAL_DLLPRIVATE sal_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( sal_Bool bPush=sal_True ); + SAL_DLLPRIVATE void PopSubShells_Impl() { PushSubShells_Impl( sal_False ); } + SAL_DLLPRIVATE void TakeOwnership_Impl(); + SAL_DLLPRIVATE void TakeFrameOwnership_Impl(); + SAL_DLLPRIVATE sal_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] + + <StarView> unfortunatly 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 <SfxViewFrame> 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] + + <SfxShell::GetFrame()const> +*/ + +{ + return pFrame; +} + +#endif // #ifndef _SFXVIEWSH_HXX + + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |