Files
libreoffice/sw/source/uibase/inc/pview.hxx
Noel Grandin 204d147b8a convert SCROLL constants to scoped enum
Change-Id: I5696fa39b2d032735cea7abe039349d4f83cf68d
2015-05-26 08:30:19 +02:00

334 lines
10 KiB
C++

/* -*- 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_SW_SOURCE_UIBASE_INC_PVIEW_HXX
#define INCLUDED_SW_SOURCE_UIBASE_INC_PVIEW_HXX
#include <tools/link.hxx>
#include <tools/fract.hxx>
#include <vcl/window.hxx>
#include <sfx2/viewfrm.hxx>
#include <sfx2/viewfac.hxx>
#include <sfx2/viewsh.hxx>
#include <sfx2/zoomitem.hxx>
#include "swdllapi.h"
#include "shellid.hxx"
class SwViewOption;
class SwDocShell;
class SwScrollbar;
class SwViewShell;
class SwPagePreview;
class ImageButton;
class Button;
class SwRect;
class DataChangedEvent;
class CommandEvent;
class SvtAccessibilityOptions;
class SwPagePreviewLayout;
// Delete member <mnVirtPage> and its accessor
class SwPagePreviewWin : public vcl::Window
{
SwViewShell* mpViewShell;
sal_uInt16 mnSttPage;
sal_uInt8 mnRow;
sal_uInt8 mnCol;
Size maPxWinSize;
Fraction maScale;
SwPagePreview& mrView;
bool mbCalcScaleForPreviewLayout;
Rectangle maPaintedPreviewDocRect;
SwPagePreviewLayout* mpPgPreviewLayout;
void SetPagePreview( sal_uInt8 nRow, sal_uInt8 nCol );
using Window::Scroll;
public:
SwPagePreviewWin( vcl::Window* pParent, SwPagePreview& rView );
virtual ~SwPagePreviewWin();
// calls SwViewShell::Paint
virtual void Paint( vcl::RenderContext& rRenderContext, const Rectangle& rRect ) SAL_OVERRIDE;
virtual void KeyInput( const KeyEvent & ) SAL_OVERRIDE;
virtual void Command( const CommandEvent& rCEvt ) SAL_OVERRIDE;
virtual void MouseButtonDown(const MouseEvent& rMEvt) SAL_OVERRIDE;
virtual void DataChanged( const DataChangedEvent& ) SAL_OVERRIDE;
void SetViewShell( SwViewShell* pShell );
SwViewShell* GetViewShell() const
{
return mpViewShell;
}
sal_uInt8 GetRow() const
{
return mnRow;
}
void SetRow(sal_uInt8 n)
{
if(n)
mnRow = n;
}
sal_uInt8 GetCol() const
{
return mnCol;
}
void SetCol(sal_uInt8 n)
{
if(n)
mnCol = n;
}
sal_uInt16 GetSttPage() const
{
return mnSttPage;
}
void SetSttPage(sal_uInt16 n)
{
mnSttPage = n;
}
/** get selected page number of document preview
@return selected page number
*/
sal_uInt16 SelectedPage() const;
/** set selected page number in document preview
@param _nSelectedPageNum
input parameter - physical page number of page that will be the selected one.
*/
void SetSelectedPage( sal_uInt16 _nSelectedPageNum );
// If we only have one column we do not have a oth page
sal_uInt16 GetDefSttPage() const { return 1 == mnCol ? 1 : 0; }
void CalcWish( sal_uInt8 nNewRow, sal_uInt8 nNewCol );
const Size& GetWinSize() const { return maPxWinSize; }
void SetWinSize( const Size& rNewSize );
// Add <MV_SELPAGE>, <MV_SCROLL>
enum MoveMode{ MV_CALC, MV_PAGE_UP, MV_PAGE_DOWN, MV_DOC_STT, MV_DOC_END,
MV_SELPAGE, MV_SCROLL, MV_NEWWINSIZE };
bool MovePage( int eMoveMode );
// Create the status bar's string
OUString GetStatusStr( sal_uInt16 nPageCount ) const;
void RepaintCoreRect( const SwRect& rRect );
/** Method to adjust preview to a new zoom factor
paint of preview is prepared for a new zoom factor
Zoom type has also been considered.
Thus, add new parameter <_eZoomType>
*/
void AdjustPreviewToNewZoom( const sal_uInt16 _nZoomFactor,
const SvxZoomType _eZoomType );
const Rectangle& GetPaintedPreviewDocRect() const
{
return maPaintedPreviewDocRect;
}
void Scroll(long nXMove, long nYMove, ScrollFlags nFlags = ScrollFlags::NONE) SAL_OVERRIDE;
/** Method to enable/disable book preview
@param _bBookPreview
input parameter - boolean indicating, if book preview mode has to
switch on <true> or of <false>
@return boolean indicating, if book preview mode has changed.
*/
bool SetBookPreviewMode( const bool _bBookPreview );
virtual css::uno::Reference<css::accessibility::XAccessible> CreateAccessible() SAL_OVERRIDE;
};
/**
* View of a document
*/
class SW_DLLPUBLIC SwPagePreview: public SfxViewShell
{
// ViewWindow and handle to core
// current dispatcher shell
VclPtr<SwPagePreviewWin> pViewWin;
//viewdata of the previous SwView and the new crsrposition
OUString sSwViewData;
//and the new cursor position if the user double click in the PagePreview
OUString sNewCrsrPos;
// to support keyboard the number of the page to go to can be set too
sal_uInt16 nNewPage;
// visible range
OUString sPageStr;
Size aDocSz;
Rectangle aVisArea;
// MDI control elements
VclPtr<SwScrollbar> pHScrollbar;
VclPtr<SwScrollbar> pVScrollbar;
bool mbHScrollbarEnabled : 1;
bool mbVScrollbarEnabled : 1;
VclPtr<ImageButton> pPageUpBtn;
VclPtr<ImageButton> pPageDownBtn;
// dummy window for filling the lower right edge when both scrollbars are active
VclPtr<vcl::Window> pScrollFill;
sal_uInt16 mnPageCount;
bool bNormalPrint;
// New members to reset design mode at draw view for form shell on switching
// back from writer page preview to normal view.
bool mbResetFormDesignMode:1;
bool mbFormDesignModeToReset:1;
SAL_DLLPRIVATE void Init(const SwViewOption* = 0);
SAL_DLLPRIVATE Point AlignToPixel(const Point& rPt) const;
SAL_DLLPRIVATE int _CreateScrollbar( bool bHori);
DECL_DLLPRIVATE_LINK(ScrollHdl, SwScrollbar*);
DECL_DLLPRIVATE_LINK(EndScrollHdl, SwScrollbar*);
DECL_DLLPRIVATE_LINK(BtnPage, Button*);
SAL_DLLPRIVATE bool ChgPage( int eMvMode, bool bUpdateScrollbar = true );
SAL_DLLPRIVATE virtual SfxPrinter* GetPrinter( bool bCreate = false ) SAL_OVERRIDE;
SAL_DLLPRIVATE virtual sal_uInt16 SetPrinter( SfxPrinter *pNewPrinter, SfxPrinterChangeFlags nDiffFlags = SFX_PRINTER_ALL, bool bIsAPI=false ) SAL_OVERRIDE;
SAL_DLLPRIVATE virtual bool HasPrintOptionsPage() const SAL_OVERRIDE;
SAL_DLLPRIVATE virtual VclPtr<SfxTabPage> CreatePrintOptionsPage(vcl::Window *pParent, const SfxItemSet &rOptions ) SAL_OVERRIDE;
SAL_DLLPRIVATE void CalcAndSetBorderPixel( SvBorder &rToFill, bool bInner );
/** Helper method to execute SfxRequest FN_PAGE_UP and FN_PAGE_DOWN
@param _bPgUp
input parameter - boolean that indicates, if FN_PAGE_UP or FN_PAGE_DOWN
has to be executed.
@param _pReq
optional input parameter - pointer to the <SfxRequest> instance, if existing.
*/
SAL_DLLPRIVATE void _ExecPgUpAndPgDown( const bool _bPgUp,
SfxRequest* _pReq = 0 );
protected:
virtual void InnerResizePixel( const Point &rOfs, const Size &rSize ) SAL_OVERRIDE;
virtual void OuterResizePixel( const Point &rOfs, const Size &rSize ) SAL_OVERRIDE;
void SetZoom(SvxZoomType eSet, sal_uInt16 nFactor);
public:
SFX_DECL_VIEWFACTORY(SwPagePreview);
SFX_DECL_INTERFACE(SW_PAGEPREVIEW)
TYPEINFO_OVERRIDE();
private:
/// SfxInterface initializer.
static void InitInterface_Impl();
public:
inline vcl::Window& GetFrameWindow() const
{ return GetViewFrame()->GetWindow(); }
inline SwViewShell* GetViewShell() const
{ return pViewWin->GetViewShell(); }
inline const Rectangle& GetVisArea() const
{ return aVisArea; }
inline void GrabFocusViewWin()
{ pViewWin->GrabFocus(); }
inline void RepaintCoreRect( const SwRect& rRect )
{ pViewWin->RepaintCoreRect( rRect ); }
void DocSzChgd(const Size& rNewSize);
const Size& GetDocSz() const
{ return aDocSz; }
void SetVisArea( const Rectangle&, bool bUpdateScrollbar = true);
inline void AdjustEditWin();
void ScrollViewSzChg();
void ScrollDocSzChg();
void ShowHScrollbar(bool bShow);
void ShowVScrollbar(bool bShow);
void EnableHScrollbar(bool bEnable);
void EnableVScrollbar(bool bEnable);
sal_uInt16 GetPageCount() const { return mnPageCount; }
sal_uInt16 GetSelectedPage() const {return pViewWin->SelectedPage();}
bool HandleWheelCommands( const CommandEvent& );
OUString GetPrevSwViewData() const { return sSwViewData; }
void SetNewCrsrPos( const OUString& rStr ) { sNewCrsrPos = rStr; }
const OUString& GetNewCrsrPos() const { return sNewCrsrPos; }
sal_uInt16 GetNewPage() const {return nNewPage;}
void SetNewPage(sal_uInt16 nSet) {nNewPage = nSet;}
// Handler
void Execute(SfxRequest&);
void GetState(SfxItemSet&);
static void StateUndo(SfxItemSet&);
SwDocShell* GetDocShell();
// apply Accessiblity options
void ApplyAccessiblityOptions(SvtAccessibilityOptions& rAccessibilityOptions);
// Inline method to request values of new members
// <mbResetFormDesignMode> and <mbFormDesignModeToReset>
inline bool ResetFormDesignMode() const
{
return mbResetFormDesignMode;
}
inline bool FormDesignModeToReset() const
{
return mbFormDesignModeToReset;
}
/** Adjust position of vertical scrollbar
Currently used, if the complete preview layout rows fit into to the given
window, if a new page is selected and this page is visible.
@param _nNewThumbPos
input parameter - new position, which will be assigned to the vertical
scrollbar.
*/
void SetVScrollbarThumbPos( const sal_uInt16 _nNewThumbPos );
SwPagePreview( SfxViewFrame* pFrame, SfxViewShell* );
virtual ~SwPagePreview();
};
inline void SwPagePreview::AdjustEditWin()
{
OuterResizePixel( Point(), GetFrameWindow().GetOutputSizePixel() );
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */