Files
libreoffice/sw/source/core/inc/viewimp.hxx
2010-05-11 10:49:42 +02:00

365 lines
12 KiB
C++

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* 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
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _VIEWIMP_HXX
#define _VIEWIMP_HXX
#include <vcl/timer.hxx>
#include <tools/color.hxx>
// OD 25.06.2003 #108784#
#include <svx/svdtypes.hxx>
#include <tools/string.hxx>
#include <swtypes.hxx>
#include <swrect.hxx>
class ViewShell;
class SwFlyFrm;
class SwViewOption;
class SwRegionRects;
class SwFrm;
class SwLayAction;
class SwLayIdle;
class SwDrawView;
class SdrPageView;
class SwPageFrm;
class SwRegionRects;
struct SdrPaintProcRec;
class SwAccessibleMap;
class SdrObject;
class Fraction;
class SwPrtOptions;
class SwPagePreviewLayout;
struct PrevwPage;
#include <vector>
class SwTxtFrm;
class SwViewImp
{
friend class ViewShell;
friend class SwLayAction; //Lay- und IdleAction tragen sich ein und aus.
friend class SwLayIdle;
// OD 12.12.2002 #103492# - for paint of page preview
friend class SwPagePreviewLayout;
ViewShell *pSh; //Falls jemand einen Imp durchreicht und doch
//mal eine ViewShell braucht hier die
//Rueckwaertsverkettung.
SwDrawView *pDrawView; //Unsere DrawView
SdrPageView *pSdrPageView; //Genau eine Seite fuer unsere DrawView
SwPageFrm *pFirstVisPage;//Zeigt immer auf die erste sichtbare Seite.
SwRegionRects *pRegion; //Sammler fuer Paintrects aus der LayAction.
SwLayAction *pLayAct; //Ist gesetzt wenn ein Action-Objekt existiert
//Wird vom SwLayAction-CTor ein- und vom DTor
//ausgetragen.
SwLayIdle *pIdleAct; //Analog zur SwLayAction fuer SwLayIdle.
SwAccessibleMap *pAccMap; // Accessible Wrappers
mutable const SdrObject * pSdrObjCached;
mutable String sSdrObjCachedComment;
BOOL bFirstPageInvalid :1; //Pointer auf erste Seite ungueltig?
//BOOL bResetXorVisibility:1; //StartAction/EndAction
//HMHBOOL bShowHdlPaint :1; //LockPaint/UnlockPaint
BOOL bResetHdlHiddenPaint:1;// -- "" --
BOOL bSmoothUpdate :1; //Meber fuer SmoothScroll
BOOL bStopSmooth :1;
BOOL bStopPrt :1; // Stop Printing
USHORT nRestoreActions ; //Die Anzahl der zu restaurierenden Actions (UNO)
SwRect aSmoothRect;
// OD 12.12.2002 #103492#
SwPagePreviewLayout* mpPgPrevwLayout;
/**
Signal whether to stop printing.
@param _useless just to fit macro
*/
DECL_LINK(SetStopPrt, void * _useless = NULL);
/**
Returns if printer shall be stopped.
@retval TRUE The printer shall be stopped.
@retval FALSE else
*/
BOOL IsStopPrt() { return bStopPrt; }
/**
Resets signal for stopping printing.
*/
void ResetStopPrt() { bStopPrt = FALSE; }
void SetFirstVisPage(); //Neue Ermittlung der ersten sichtbaren Seite
void StartAction(); //Henkel Anzeigen und verstecken.
void EndAction(); //gerufen von ViewShell::ImplXXXAction
void LockPaint(); //dito, gerufen von ViewShell::ImplLockPaint
void UnlockPaint();
private:
SwAccessibleMap *CreateAccessibleMap();
/** invalidate CONTENT_FLOWS_FROM/_TO relation for paragraphs
OD 2005-12-01 #i27138#
implementation for wrapper method
<ViewShell::InvalidateAccessibleParaFlowRelation(..)>
@author OD
@param _pFromTxtFrm
input parameter - paragraph frame, for which the relation CONTENT_FLOWS_FROM
has to be invalidated.
If NULL, no CONTENT_FLOWS_FROM relation has to be invalidated
@param _pToTxtFrm
input parameter - paragraph frame, for which the relation CONTENT_FLOWS_TO
has to be invalidated.
If NULL, no CONTENT_FLOWS_TO relation has to be invalidated
*/
void _InvalidateAccessibleParaFlowRelation( const SwTxtFrm* _pFromTxtFrm,
const SwTxtFrm* _pToTxtFrm );
/** invalidate text selection for paragraphs
OD 2005-12-12 #i27301#
implementation for wrapper method
<ViewShell::InvalidateAccessibleParaTextSelection(..)>
@author OD
*/
void _InvalidateAccessibleParaTextSelection();
/** invalidate attributes for paragraphs and paragraph's characters
OD 2009-01-06 #i88069#
implementation for wrapper method
<ViewShell::InvalidateAccessibleParaAttrs(..)>
@author OD
*/
void _InvalidateAccessibleParaAttrs( const SwTxtFrm& rTxtFrm );
public:
SwViewImp( ViewShell * );
~SwViewImp();
void Init( const SwViewOption * ); //nur fuer ViewShell::Init()
const ViewShell *GetShell() const { return pSh; }
ViewShell *GetShell() { return pSh; }
Color GetRetoucheColor() const;
//Verwaltung zur ersten sichtbaren Seite
inline const SwPageFrm *GetFirstVisPage() const;
inline SwPageFrm *GetFirstVisPage();
void SetFirstVisPageInvalid() { bFirstPageInvalid = TRUE; }
BOOL AddPaintRect( const SwRect &rRect );
SwRegionRects *GetRegion() { return pRegion; }
void DelRegion();
// neues Interface fuer StarView Drawing
inline BOOL HasDrawView() const { return 0 != pDrawView; }
SwDrawView* GetDrawView() { return pDrawView; }
const SwDrawView* GetDrawView() const { return pDrawView; }
SdrPageView*GetPageView() { return pSdrPageView; }
const SdrPageView*GetPageView() const { return pSdrPageView; }
void MakeDrawView();
// OD 29.08.2002 #102450#
// add 3rd parameter <const Color* pPageBackgrdColor> for setting this
// color as the background color at the outliner of the draw view
// for painting layers <hell> and <heaven>
// OD 09.12.2002 #103045# - add 4th parameter for the horizontal text
// direction of the page in order to set the default horizontal text
// direction at the outliner of the draw view for painting layers <hell>
// and <heaven>.
// OD 25.06.2003 #108784# - correct type of 1st parameter
void PaintLayer( const SdrLayerID _nLayerID,
const SwPrtOptions *pPrintData,
const SwRect& _rRect,
const Color* _pPageBackgrdColor = 0,
const bool _bIsPageRightToLeft = false ) const;
//wird als Link an die DrawEngine uebergeben, entscheidet was wie
//gepaintet wird oder nicht.
//#110094#-3
//DECL_LINK( PaintDispatcher, SdrPaintProcRec * );
// Interface Drawing
BOOL IsDragPossible( const Point &rPoint );
void NotifySizeChg( const Size &rNewSz );
//SS Fuer die Lay- bzw. IdleAction und verwandtes
BOOL IsAction() const { return pLayAct != 0; }
BOOL IsIdleAction() const { return pIdleAct != 0; }
SwLayAction &GetLayAction() { return *pLayAct; }
const SwLayAction &GetLayAction() const { return *pLayAct; }
SwLayIdle &GetIdleAction() { return *pIdleAct;}
const SwLayIdle &GetIdleAction() const { return *pIdleAct;}
//Wenn eine Aktion laueft wird diese gebeten zu pruefen ob es
//an der zeit ist den WaitCrsr einzuschalten.
void CheckWaitCrsr();
BOOL IsCalcLayoutProgress() const; //Fragt die LayAction wenn vorhanden.
//TRUE wenn eine LayAction laeuft, dort wird dann auch das Flag fuer
//ExpressionFields gesetzt.
BOOL IsUpdateExpFlds();
void SetRestoreActions(USHORT nSet){nRestoreActions = nSet;}
USHORT GetRestoreActions() const{return nRestoreActions;}
// OD 12.12.2002 #103492#
void InitPagePreviewLayout();
// OD 12.12.2002 #103492#
inline SwPagePreviewLayout* PagePreviewLayout()
{
return mpPgPrevwLayout;
}
// Is this view accessible?
sal_Bool IsAccessible() const { return pAccMap != 0; }
inline SwAccessibleMap& GetAccessibleMap();
// Update (this) accessible view
void UpdateAccessible();
// Remove a frame from the accessible view
void DisposeAccessible( const SwFrm *pFrm, const SdrObject *pObj,
sal_Bool bRecursive );
inline void DisposeAccessibleFrm( const SwFrm *pFrm,
sal_Bool bRecursive=sal_False );
inline void DisposeAccessibleObj( const SdrObject *pObj );
// Move a frame's position in the accessible view
void MoveAccessible( const SwFrm *pFrm, const SdrObject *pObj,
const SwRect& rOldFrm );
inline void MoveAccessibleFrm( const SwFrm *pFrm, const SwRect& rOldFrm );
// Add a frame in the accessible view
inline void AddAccessibleFrm( const SwFrm *pFrm );
inline void AddAccessibleObj( const SdrObject *pObj );
// Invalidate accessible frame's frame's content
void InvalidateAccessibleFrmContent( const SwFrm *pFrm );
// Invalidate accessible frame's cursor position
void InvalidateAccessibleCursorPosition( const SwFrm *pFrm );
// Invalidate editable state for all accessible frames
void InvalidateAccessibleEditableState( sal_Bool bAllShells=sal_True,
const SwFrm *pFrm=0 );
// Invalidate frame's relation set (for chained frames)
void InvalidateAccessibleRelationSet( const SwFlyFrm *pMaster,
const SwFlyFrm *pFollow );
// update data for accessible preview
// OD 15.01.2003 #103492# - change method signature due to new page preview
// functionality
void UpdateAccessiblePreview( const std::vector<PrevwPage*>& _rPrevwPages,
const Fraction& _rScale,
const SwPageFrm* _pSelectedPageFrm,
const Size& _rPrevwWinSize );
void InvalidateAccessiblePreViewSelection( sal_uInt16 nSelPage );
// Fire all accessible events that have been collected so far
void FireAccessibleEvents();
};
inline SwPageFrm *SwViewImp::GetFirstVisPage()
{
if ( bFirstPageInvalid )
SetFirstVisPage();
return pFirstVisPage;
}
inline const SwPageFrm *SwViewImp::GetFirstVisPage() const
{
if ( bFirstPageInvalid )
((SwViewImp*)this)->SetFirstVisPage();
return pFirstVisPage;
}
inline SwAccessibleMap& SwViewImp::GetAccessibleMap()
{
if( !pAccMap )
CreateAccessibleMap();
return *pAccMap;
}
inline void SwViewImp::DisposeAccessibleFrm( const SwFrm *pFrm,
sal_Bool bRecursive )
{
DisposeAccessible( pFrm, 0, bRecursive );
}
inline void SwViewImp::DisposeAccessibleObj( const SdrObject *pObj )
{
DisposeAccessible( 0, pObj, sal_False );
}
inline void SwViewImp::MoveAccessibleFrm( const SwFrm *pFrm,
const SwRect& rOldFrm )
{
MoveAccessible( pFrm, 0, rOldFrm );
}
inline void SwViewImp::AddAccessibleFrm( const SwFrm *pFrm )
{
SwRect aEmptyRect;
MoveAccessible( pFrm, 0, aEmptyRect );
}
inline void SwViewImp::AddAccessibleObj( const SdrObject *pObj )
{
SwRect aEmptyRect;
MoveAccessible( 0, pObj, aEmptyRect );
}
#endif //_VIEWIMP_HXX