/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: ViewShell.hxx,v $
* $Revision: 1.25 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* Despite its name this class is not a descendant of SfxViewShell
but of SfxShell. Its name expresses the fact that it acts like a
view shell. Beeing a stacked shell rather then being an actual view shell
there can be several instances of this class that
This class replaces the former ViewShell class.
*/ class ViewShell : public SfxShell { public: enum ShellType { ST_NONE, ST_DRAW, // The Draw application. ST_IMPRESS, // Main view of the Impress application. ST_NOTES, ST_HANDOUT, ST_OUTLINE, ST_SLIDE_SORTER, ST_PRESENTATION, ST_TASK_PANE }; static const int MAX_HSPLIT_CNT = 1; static const int MAX_VSPLIT_CNT = 1; static const int MIN_SCROLLBAR_SIZE = 50; static const ULONG OUTPUT_DRAWMODE_COLOR = DRAWMODE_DEFAULT; static const ULONG OUTPUT_DRAWMODE_GRAYSCALE = DRAWMODE_GRAYLINE | DRAWMODE_GRAYFILL | DRAWMODE_BLACKTEXT | DRAWMODE_GRAYBITMAP | DRAWMODE_GRAYGRADIENT; static const int OUTPUT_DRAWMODE_BLACKWHITE = DRAWMODE_BLACKLINE | DRAWMODE_BLACKTEXT | DRAWMODE_WHITEFILL | DRAWMODE_GRAYBITMAP | DRAWMODE_WHITEGRADIENT; static const int OUTPUT_DRAWMODE_CONTRAST = DRAWMODE_SETTINGSLINE | DRAWMODE_SETTINGSFILL | DRAWMODE_SETTINGSTEXT | DRAWMODE_SETTINGSGRADIENT; TYPEINFO(); ViewShell ( SfxViewFrame *pFrame, ::Window* pParentWindow, ViewShellBase& rViewShellBase, bool bAllowCenter = true); ViewShell ( SfxViewFrame *pFrame, ::Window* pParentWindow, const ViewShell& rShell); virtual ~ViewShell (void); /** The Init method has to be called from the outside directly after a new object of this class has been created. It can be used for that part of the initialisation that can be run only after the creation of the new object is finished. This includes registration as listener at event broadcasters. Derived classes should call this method at the head of their Init() methods. @param bIsMainViewShell This flag tells the Init() method whether the new ViewShell will be the main view shell. */ virtual void Init (bool bIsMainViewShell); /** The Exit() method has to be called before the destructor so that the view shell is still a valid object and can safely call methods that rely on that. */ virtual void Exit (void); void Cancel(); /** Return the window that is the parent of all controls of this view shell. This may or may not be the window of the frame. */ inline ::Window* GetParentWindow (void) const; inline ::sd::View* GetView (void) const; inline SdrView* GetDrawView (void) const; SD_DLLPUBLIC DrawDocShell* GetDocSh (void) const; SdDrawDocument* GetDoc (void) const; SD_DLLPUBLIC SfxViewFrame* GetViewFrame (void) const; /** The active window is usually the mpContentWindow. When there is a show running then the active window is a ShowWindow. */ ::sd::Window* GetActiveWindow (void) const; /** Set the active window. When the shell is displayed in the center pane then the window of the ViewShellBase is also set to the given window. */ void SetActiveWindow (::sd::Window* pWindow); /** Return the rectangle that encloses all windows of the view. That excludes the controls in the frame like rulers, scroll bars, tab bar, and buttons. @return The rectangle is returned in screen coordinates, i.e. pixel values relative to the upper left corner of the screen?. */ const Rectangle& GetAllWindowRect (void); // Mouse- & Key-Events virtual void Paint (const Rectangle& rRect, ::sd::Window* pWin); virtual BOOL KeyInput(const KeyEvent& rKEvt, ::sd::Window* pWin); virtual void MouseMove(const MouseEvent& rMEvt, ::sd::Window* pWin); virtual void MouseButtonUp(const MouseEvent& rMEvt, ::sd::Window* pWin); virtual void MouseButtonDown(const MouseEvent& rMEvt, ::sd::Window* pWin); virtual void Command(const CommandEvent& rCEvt, ::sd::Window* pWin); virtual BOOL RequestHelp( const HelpEvent& rEvt, ::sd::Window* pWin ); virtual long Notify( NotifyEvent& rNEvt, ::sd::Window* pWin ); BOOL HandleScrollCommand(const CommandEvent& rCEvt, ::sd::Window* pWin); virtual void Draw(OutputDevice &rDev, const Region &rReg); virtual void SetUIUnit(FieldUnit eUnit); virtual void SetDefTabHRuler( UINT16 nDefTab ); BOOL HasRuler (void); void SetRuler(BOOL bRuler); /** Set internal values of all scroll bars that determine thumb size and position. The external values like size and position of the scroll bar controls are not modified. */ virtual void UpdateScrollBars (void); void Scroll(long nX, long nY); void ScrollLines(long nX, long nY); virtual void SetZoom(long nZoom); virtual void SetZoomRect(const Rectangle& rZoomRect); void InitWindows(const Point& rViewOrigin, const Size& rViewSize, const Point& rWinPos, BOOL bUpdate = FALSE); void InvalidateWindows(); void UpdateWindows(); /** This method is still used by the OutlineViewShell to update the model according to the content of the outline view. This in turn updates the previews in the slide sorter. */ virtual void UpdatePreview (SdPage* pPage, BOOL bInit = FALSE); void DrawMarkRect(const Rectangle& rRect) const; void DrawFilledRect( const Rectangle& rRect, const Color& rLColor, const Color& rFColor ) const; void ExecReq( SfxRequest &rReq ); ZoomList* GetZoomList (void); FrameView* GetFrameView (void); /** Setting a frame view triggers ReadFrameViewData() for the new frame. @param pFrameView The new frame view that replaces the old one. */ void SetFrameView (FrameView* pFrameView); virtual void ReadFrameViewData(FrameView* pView); virtual void WriteFrameViewData(); virtual void WriteUserData(String& rString); virtual void ReadUserData(const String& rString); virtual BOOL ActivateObject(SdrOle2Obj* pObj, long nVerb); /** @returns current or selected page or 0. This method will fail in master page mode. @deprecated, please use getCurrentPage(); */ virtual SdPage* GetActualPage() = 0; /** @returns current or selected page or 0. */ virtual SdPage* getCurrentPage() const = 0; FunctionReference GetOldFunction() const { return mxOldFunction; } bool HasOldFunction() const { return mxOldFunction.is(); } FunctionReference GetCurrentFunction() const { return mxCurrentFunction; } bool HasCurrentFunction( USHORT nSID ) { return mxCurrentFunction.is() && (mxCurrentFunction->GetSlotID() == nSID ); } bool HasCurrentFunction() { return mxCurrentFunction.is(); } void SetCurrentFunction(const FunctionReference& xFunction); void SetOldFunction(const FunctionReference& xFunction); void DeactivateCurrentFunction( bool bPermanent = false ); void SetPageSizeAndBorder(PageKind ePageKind, const Size& rNewSize, long nLeft, long nRight, long nUpper, long nLower, BOOL bScaleAll, Orientation eOrient, USHORT nPaperBin, BOOL bBackgroundFullSize ); void SetStartShowWithDialog( BOOL bIn = TRUE ) { mbStartShowWithDialog = bIn; } BOOL IsStartShowWithDialog() const { return mbStartShowWithDialog; } USHORT GetPrintedHandoutPageNum (void) const { return mnPrintedHandoutPageNum; } void SetPrintedHandoutPageNum (USHORT nPageNumber) {mnPrintedHandoutPageNum=nPageNumber; } virtual USHORT PrepareClose( BOOL bUI = TRUE, BOOL bForBrowsing = FALSE ); void GetMenuState(SfxItemSet& rSet); virtual sal_Int8 AcceptDrop( const AcceptDropEvent& rEvt, DropTargetHelper& rTargetHelper, ::sd::Window* pTargetWindow, USHORT nPage, USHORT nLayer ); virtual sal_Int8 ExecuteDrop( const ExecuteDropEvent& rEvt, DropTargetHelper& rTargetHelper, ::sd::Window* pTargetWindow, USHORT nPage, USHORT nLayer ); 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 ); /** this method is called when the visible area of the view from this viewshell is changed */ virtual void VisAreaChanged(const Rectangle& rRect); /** Create an accessible object representing the specified window. Overload this method to provide view mode specific objects. The default implementation returns an empty reference. @param pWindow Make the document displayed in this window accessible. @return This default implementation returns an empty reference. */ virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> CreateAccessibleDocumentView (::sd::Window* pWindow); void SetWinViewPos(const Point& rWinPos, bool bUpdate); Point GetWinViewPos() const; Point GetViewOrigin() const; /** Return the window updater of this view shell. @return In rare circumstances the returned pointer may be This method is implemented by first setting copying the given
values to internal variables and then calling the
When this method is not called before a view shell is taken from a stack then the Deactivate() call from the SFX as a response to RemoveSubShell() comes to late when the view shell is not on the stack anymore.
*/ virtual void Shutdown (void); /** This function is called from the underlying ViewShellBase object to handle a verb execution request. */ virtual ErrCode DoVerb (long nVerb); virtual void UIActivating( SfxInPlaceClient* ); virtual void UIDeactivated( SfxInPlaceClient* ); /** Show controls of the UI or hide them, depending on the given flag. As a result the border is adapted. */ virtual void ShowUIControls (bool bVisible = true); BOOL IsPageFlipMode(void) const; /** Set the given window as new parent window. This is not possible for all views, so the return value tells the caller if the relocation was successfull. */ virtual bool RelocateToParentWindow (::Window* pParentWindow); void AdaptDefaultsForChart( const ::com::sun::star::uno::Reference < ::com::sun::star::embed::XEmbeddedObject > & xEmbObj ); class Implementation; protected: /** must be called in the beginning of each subclass d'tor. disposes and clears both current and old function. */ void DisposeFunctions(); friend class ViewShellBase; /** Window inside the rulers and scroll bars that shows a view of the document. */ ::boost::shared_ptr