sw/source/ui/inc/pview.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: pview.hxx,v $
  10  * $Revision: 1.23 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _SWPVIEW_HXX
  31 #define _SWPVIEW_HXX
  32
  33 #include <tools/link.hxx>
  34 #include <vcl/window.hxx>
  35 #include <sfx2/viewfrm.hxx>
  36 #include <sfx2/viewfac.hxx>
  37 #include <sfx2/viewsh.hxx>
  38 #include <svx/zoomitem.hxx>
  39 #include "swdllapi.h"
  40 #include "shellid.hxx"
  41
  42 class SwViewOption;
  43 class SwDocShell;
  44 class SwScrollbar;
  45 class ViewShell;
  46 class SwPagePreView;
  47 class ImageButton;
  48 class Button;
  49 class SwRect;
  50 class DataChangedEvent;
  51 class CommandEvent;
  52 class SvtAccessibilityOptions;
  53 // OD 12.12.2002 #103492#
  54 class SwPagePreviewLayout;
  55
  56 // OD 24.03.2003 #108282# - delete member <mnVirtPage> and its accessor.
  57 class SwPagePreViewWin : public Window
  58 {
  59     ViewShell*          mpViewShell;
  60     USHORT              mnSttPage;
  61     BYTE                mnRow, mnCol;
  62     Size                maPxWinSize;
  63     Fraction            maScale;
  64     SwPagePreView&      mrView;
  65     // OD 02.12.2002 #103492#
  66     bool                mbCalcScaleForPreviewLayout;
  67     Rectangle           maPaintedPreviewDocRect;
  68     // OD 12.12.2002 #103492#
  69     SwPagePreviewLayout* mpPgPrevwLayout;
  70
  71     void SetPagePreview( BYTE nRow, BYTE nCol );
  72
  73     using Window::Scroll;
  74
  75 public:
  76     SwPagePreViewWin( Window* pParent, SwPagePreView& rView );
  77     ~SwPagePreViewWin();
  78
  79     //Ruft ViewShell::Paint
  80     virtual void Paint( const Rectangle& rRect );
  81     virtual void KeyInput( const KeyEvent & );
  82     virtual void Command( const CommandEvent& rCEvt );
  83     virtual void MouseButtonDown(const MouseEvent& rMEvt);
  84     virtual void DataChanged( const DataChangedEvent& );
  85
  86     void SetViewShell( ViewShell* pShell );
  87
  88     ViewShell* GetViewShell() const { return mpViewShell; }
  89
  90     BYTE    GetRow() const      { return mnRow; }
  91     void    SetRow( BYTE n )    { if( n ) mnRow = n; }
  92
  93     BYTE    GetCol() const      { return mnCol; }
  94     void    SetCol( BYTE n )    { if( n ) mnCol = n; }
  95
  96     USHORT  GetSttPage() const      { return mnSttPage; }
  97     void    SetSttPage( USHORT n )  { mnSttPage = n; }
  98
  99     /** get selected page number of document preview
 100
 101         OD 13.12.2002 #103492#
 102
 103         @author OD
 104
 105         @return selected page number
 106     */
 107     sal_uInt16 SelectedPage() const;
 108
 109     /** set selected page number in document preview
 110
 111         OD 13.12.2002 #103492#
 112
 113         @author OD
 114
 115         @param _nSelectedPageNum
 116         input parameter - physical page number of page that will be the selected one.
 117     */
 118     void SetSelectedPage( sal_uInt16 _nSelectedPageNum );
 119
 120     //JP 19.08.98: bei Einspaltigkeit gibt es keine 0. Seite!
 121     USHORT  GetDefSttPage() const   { return 1 == mnCol ? 1 : 0; }
 122
 123     void CalcWish( BYTE nNewRow, BYTE nNewCol );
 124
 125     const Size& GetWinSize() const  { return maPxWinSize; }
 126     void SetWinSize( const Size& rNewSize );
 127
 128     // OD 18.12.2002 #103492# - add <MV_SELPAGE>, <MV_SCROLL>
 129     enum MoveMode{ MV_CALC, MV_PAGE_UP, MV_PAGE_DOWN, MV_DOC_STT, MV_DOC_END,
 130                    MV_SELPAGE, MV_SCROLL, MV_NEWWINSIZE };
 131     int MovePage( int eMoveMode );
 132
 133     // erzeuge den String fuer die StatusLeiste
 134     void GetStatusStr( String& rStr, USHORT nPageCount ) const;
 135
 136     void RepaintCoreRect( const SwRect& rRect );
 137
 138     /** method to adjust preview to a new zoom factor
 139
 140         OD 02.12.2002 #103492#
 141         paint of preview is prepared for a new zoom factor
 142         OD 24.09.2003 #i19975# - zoom type has also been considered.
 143         Thus, add new parameter <_eZoomType>
 144
 145         @author OD
 146     */
 147     void AdjustPreviewToNewZoom( const sal_uInt16 _nZoomFactor,
 148                                  const SvxZoomType _eZoomType );
 149
 150     const Rectangle& GetPaintedPreviewDocRect() const
 151     {
 152         return maPaintedPreviewDocRect;
 153     }
 154
 155     void Scroll(long nXMove, long nYMove, USHORT nFlags = 0);
 156
 157     /** method to enable/disable book preview
 158
 159         OD 2004-03-05 #i18143#
 160
 161         @author OD
 162
 163         @param _bBookPreview
 164         input parameter - boolean indicating, if book preview mode has to
 165         switch on <TRUE> or of <FALSE>
 166
 167         @return boolean indicating, if book preview mode has changed.
 168     */
 169     bool SetBookPreviewMode( const bool _bBookPreview );
 170
 171     virtual ::com::sun::star::uno::Reference<
 172         ::com::sun::star::accessibility::XAccessible>
 173                     CreateAccessible();
 174 };
 175
 176
 177 /*--------------------------------------------------------------------
 178     Beschreibung:   Sicht auf ein Dokument
 179  --------------------------------------------------------------------*/
 180
 181 class SW_DLLPUBLIC SwPagePreView: public SfxViewShell
 182 {
 183     // ViewWindow und Henkel zur Core
 184     // aktuelle Dispatcher-Shell
 185     SwPagePreViewWin        aViewWin;
 186     //viewdata of the previous SwView and the new crsrposition
 187     String                                      sSwViewData,
 188     //and the new cursor position if the user double click in the PagePreView
 189                             sNewCrsrPos;
 190     // to support keyboard the number of the page to go to can be set too
 191     USHORT                  nNewPage;
 192     // Sichtbarer Bereich
 193     String                  sPageStr;
 194     Size                    aDocSz;
 195     Rectangle               aVisArea;
 196
 197     // MDI Bedienelemente
 198     SwScrollbar             *pHScrollbar;
 199     SwScrollbar             *pVScrollbar;
 200     ImageButton             *pPageUpBtn,
 201                             *pPageDownBtn;
 202     // Dummy-Window zum F�llen der rechten unteren Ecke, wenn beide Scrollbars
 203     // aktiv sind
 204     Window                                      *pScrollFill;
 205
 206     USHORT                  mnPageCount;
 207     BOOL                    bNormalPrint;
 208
 209     // OD 09.01.2003 #106334#
 210     // new members to reset design mode at draw view for form shell on switching
 211     // back from writer page preview to normal view.
 212     sal_Bool                mbResetFormDesignMode:1;
 213     sal_Bool                mbFormDesignModeToReset:1;
 214
 215     SW_DLLPRIVATE void            Init(const SwViewOption* = 0);
 216     SW_DLLPRIVATE Point           AlignToPixel(const Point& rPt) const;
 217
 218     SW_DLLPRIVATE int             _CreateScrollbar( BOOL bHori );
 219     SW_DLLPRIVATE DECL_LINK( ScrollHdl, SwScrollbar * );
 220     SW_DLLPRIVATE DECL_LINK( EndScrollHdl, SwScrollbar * );
 221     SW_DLLPRIVATE DECL_LINK( BtnPage, Button * );
 222     SW_DLLPRIVATE int             ChgPage( int eMvMode, int bUpdateScrollbar = TRUE );
 223
 224
 225     SW_DLLPRIVATE virtual USHORT          Print( SfxProgress &rProgress, BOOL bIsAPI,
 226                                    PrintDialog *pPrintDialog = 0 );
 227     SW_DLLPRIVATE virtual SfxPrinter*     GetPrinter( BOOL bCreate = FALSE );
 228     SW_DLLPRIVATE virtual USHORT          SetPrinter( SfxPrinter *pNewPrinter, USHORT nDiffFlags = SFX_PRINTER_ALL, bool bIsAPI=false );
 229     SW_DLLPRIVATE virtual SfxTabPage*     CreatePrintOptionsPage( Window *pParent,
 230                                                 const SfxItemSet &rOptions );
 231     SW_DLLPRIVATE virtual PrintDialog*    CreatePrintDialog( Window *pParent );
 232
 233     SW_DLLPRIVATE void CalcAndSetBorderPixel( SvBorder &rToFill, BOOL bInner );
 234
 235     /** help method to execute SfxRequest FN_PAGE_UP and FN_PAGE_DOWN
 236
 237         OD 04.03.2003 #107369#
 238
 239         @param _bPgUp
 240         input parameter - boolean that indicates, if FN_PAGE_UP or FN_PAGE_DOWN
 241         has to be executed.
 242
 243         @param _pReq
 244         optional input parameter - pointer to the <SfxRequest> instance, if existing.
 245
 246         @author OD
 247     */
 248     SW_DLLPRIVATE void _ExecPgUpAndPgDown( const bool  _bPgUp,
 249                              SfxRequest* _pReq = 0 );
 250
 251 protected:
 252     virtual void    InnerResizePixel( const Point &rOfs, const Size &rSize );
 253     virtual void    OuterResizePixel( const Point &rOfs, const Size &rSize );
 254     virtual Size        GetOptimalSizePixel() const;
 255
 256     void         SetZoom(SvxZoomType eSet, USHORT nFactor);
 257
 258 public:
 259     SFX_DECL_VIEWFACTORY(SwPagePreView);
 260     SFX_DECL_INTERFACE(SW_PAGEPREVIEW)
 261     TYPEINFO();
 262
 263     inline Window*          GetFrameWindow() const { return &(GetViewFrame())->GetWindow(); }
 264     inline ViewShell*       GetViewShell() const { return aViewWin.GetViewShell(); }
 265     inline const Rectangle& GetVisArea() const { return aVisArea; }
 266     inline void             GrabFocusViewWin() { aViewWin.GrabFocus(); }
 267     inline void             RepaintCoreRect( const SwRect& rRect )
 268                                 { aViewWin.RepaintCoreRect( rRect ); }
 269
 270     void            DocSzChgd(const Size& rNewSize);
 271     const Size&     GetDocSz() const { return aDocSz; }
 272
 273     virtual void    SetVisArea( const Rectangle&, BOOL bUpdateScrollbar = TRUE);
 274
 275     inline void     AdjustEditWin();
 276
 277     void            ScrollViewSzChg();
 278     void            ScrollDocSzChg();
 279     void            ShowHScrollbar(sal_Bool bShow);
 280
 281     void            ShowVScrollbar(sal_Bool bShow);
 282
 283     USHORT          GetPageCount() const        { return mnPageCount; }
 284
 285     BOOL                        HandleWheelCommands( const CommandEvent& );
 286
 287     const String&       GetPrevSwViewData() const               { return sSwViewData; }
 288     void                        SetNewCrsrPos( const String& rStr ) { sNewCrsrPos = rStr; }
 289     const String&       GetNewCrsrPos() const                   { return sNewCrsrPos; }
 290
 291     USHORT          GetNewPage() const {return nNewPage;}
 292     void            SetNewPage(USHORT nSet)  {nNewPage = nSet;}
 293
 294         // Handler
 295     void            Execute(SfxRequest&);
 296     void            GetState(SfxItemSet&);
 297     void            StateUndo(SfxItemSet&);
 298
 299     SwDocShell*     GetDocShell();
 300
 301     //apply Accessiblity options
 302     void ApplyAccessiblityOptions(SvtAccessibilityOptions& rAccessibilityOptions);
 303
 304     // OD 09.01.2003 #106334# - inline method to request values of new members
 305     // <mbResetFormDesignMode> and <mbFormDesignModeToReset>
 306     inline sal_Bool ResetFormDesignMode() const
 307     {
 308         return mbResetFormDesignMode;
 309     }
 310
 311     inline sal_Bool FormDesignModeToReset() const
 312     {
 313         return mbFormDesignModeToReset;
 314     }
 315
 316     /** adjust position of vertical scrollbar
 317
 318         OD 19.02.2003 #107369
 319         Currently used, if the complete preview layout rows fit into to the given
 320         window, if a new page is selected and this page is visible.
 321
 322         @author OD
 323
 324         @param _nNewThumbPos
 325         input parameter - new position, which will be assigned to the vertical
 326         scrollbar.
 327     */
 328     void SetVScrollbarThumbPos( const sal_uInt16 _nNewThumbPos );
 329
 330     SwPagePreView( SfxViewFrame* pFrame, SfxViewShell* );
 331     ~SwPagePreView();
 332 };
 333
 334 // ----------------- inline Methoden ----------------------
 335
 336
 337 inline void SwPagePreView::AdjustEditWin()
 338 {
 339     OuterResizePixel( Point(), GetFrameWindow()->GetOutputSizePixel() );
 340 }
 341
 342 #endif