diff options
Diffstat (limited to 'sw/inc/accmap.hxx')
| -rw-r--r-- | sw/inc/accmap.hxx | 396 |
1 files changed, 396 insertions, 0 deletions
diff --git a/sw/inc/accmap.hxx b/sw/inc/accmap.hxx new file mode 100644 index 000000000000..5ee891e3e1f4 --- /dev/null +++ b/sw/inc/accmap.hxx @@ -0,0 +1,396 @@ +/************************************************************************* + * + * 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 _ACCMAP_HXX +#define _ACCMAP_HXX + +#include <cppuhelper/weakref.hxx> +#include <com/sun/star/accessibility/XAccessible.hpp> +#include <vos/ref.hxx> +#include <vos/mutex.hxx> +#include <svx/IAccessibleViewForwarder.hxx> +#include <svx/IAccessibleParent.hxx> +#include "viewsh.hxx" +#include <tools/debug.hxx> +#include <tools/fract.hxx> + +#include <vector> + +class Rectangle; +class SwFrm; +class SwPageFrm; +class SwAccessibleContext; +class SwAccessibleContextMap_Impl; +class SwAccessibleEventList_Impl; +class SwAccessibleEventMap_Impl; +class SwShapeList_Impl; +class SdrObject; +namespace accessibility { class AccessibleShape; } +class SwAccessibleShapeMap_Impl; +struct SwAccessibleEvent_Impl; +// --> OD 2005-12-13 #i27301# +class SwAccessibleSelectedParas_Impl; +// <-- +class SwRect; +class MapMode; +class SwAccPreviewData; +// OD 14.01.2003 #103492# +#ifndef _PREVWPAGE_HXX +#include <prevwpage.hxx> +#endif + +// helper class that stores preview data +class SwAccPreviewData +{ + typedef std::vector<Rectangle> Rectangles; + Rectangles maPreviewRects; + Rectangles maLogicRects; + + SwRect maVisArea; + Fraction maScale; + + const SwPageFrm *mpSelPage; + + /** adjust logic page retangle to its visible part + + OD 17.01.2003 #103492# + + @author OD + + @param _iorLogicPgSwRect + input/output parameter - reference to the logic page rectangle, which + has to be adjusted. + + @param _rPrevwPgSwRect + input parameter - constant reference to the corresponding preview page + rectangle; needed to determine the visible part of the logic page rectangle. + + @param _rPrevwWinSize + input paramter - constant reference to the preview window size in TWIP; + needed to determine the visible part of the logic page rectangle + */ + void AdjustLogicPgRectToVisibleArea( SwRect& _iorLogicPgSwRect, + const SwRect& _rPrevwPgSwRect, + const Size& _rPrevwWinSize ); + +public: + SwAccPreviewData(); + ~SwAccPreviewData(); + + // OD 14.01.2003 #103492# - complete re-factoring of method due to new + // page/print preview functionality. + void Update( const std::vector<PrevwPage*>& _rPrevwPages, + const Fraction& _rScale, + const SwPageFrm* _pSelectedPageFrm, + const Size& _rPrevwWinSize ); + + // OD 14.01.2003 #103492# - complete re-factoring of method due to new + // page/print preview functionality. + void InvalidateSelection( const SwPageFrm* _pSelectedPageFrm ); + + const SwRect& GetVisArea() const; + + MapMode GetMapModeForPreview( ) const; + + /** Adjust the MapMode so that the preview page appears at the + * proper position. rPoint identifies the page for which the + * MapMode should be adjusted. If bFromPreview is true, rPoint is + * a preview coordinate; else it's a document coordinate. */ + // OD 17.01.2003 #103492# - delete unused 3rd parameter. + void AdjustMapMode( MapMode& rMapMode, + const Point& rPoint ) const; + + inline const SwPageFrm *GetSelPage() const { return mpSelPage; } + + void DisposePage(const SwPageFrm *pPageFrm ); +}; + +// real states for events +#define ACC_STATE_EDITABLE 0x01 +#define ACC_STATE_OPAQUE 0x02 + +// pseudo states for events +// --> OD 2009-01-07 #i88069# - pseudo state for event TEXT_ATTRIBUTE_CHANGED +#define ACC_STATE_TEXT_ATTRIBUTE_CHANGED 0x0200 +// <-- +// --> OD 2005-12-12 #i27301# - pseudo state for event TEXT_SELECTION_CHANGED +#define ACC_STATE_TEXT_SELECTION_CHANGED 0x0100 +// <-- +#define ACC_STATE_CARET 0x80 +#define ACC_STATE_RELATION_FROM 0x40 +#define ACC_STATE_RELATION_TO 0x20 + +#define ACC_STATE_RELATION_MASK 0x60 + +#define ACC_STATE_MASK 0x1F + +// --> OD 2005-12-12 #i27301# - introduce type definition of states +typedef sal_uInt16 tAccessibleStates; +// <-- + +class SwAccessibleMap : public accessibility::IAccessibleViewForwarder, + public accessibility::IAccessibleParent +{ + ::vos::OMutex maMutex; + ::vos::OMutex maEventMutex; + SwAccessibleContextMap_Impl *mpFrmMap; + SwAccessibleShapeMap_Impl *mpShapeMap; + SwShapeList_Impl *mpShapes; + SwAccessibleEventList_Impl *mpEvents; + SwAccessibleEventMap_Impl *mpEventMap; + // --> OD 2005-12-13 #i27301# - data structure to keep information about + // accessible paragraph, which have a selection. + SwAccessibleSelectedParas_Impl* mpSelectedParas; + // <-- + ViewShell *mpVSh; + /// for page preview: store preview data, VisArea, and mapping of + /// preview-to-display coordinates + SwAccPreviewData* mpPreview; + + ::com::sun::star::uno::WeakReference < ::com::sun::star::accessibility::XAccessible > mxCursorContext; + + sal_Int32 mnPara; + sal_Int32 mnFootnote; + sal_Int32 mnEndnote; + + + sal_Bool mbShapeSelected; + + void FireEvent( const SwAccessibleEvent_Impl& rEvent ); + + void AppendEvent( const SwAccessibleEvent_Impl& rEvent ); + + void InvalidateCursorPosition( + const ::com::sun::star::uno::Reference< + ::com::sun::star::accessibility::XAccessible>& rAcc ); + void DoInvalidateShapeSelection(); + void DoInvalidateShapeFocus(); + void InvalidateShapeSelection(); + + void _InvalidateRelationSet( const SwFrm* pFrm, sal_Bool bFrom ); + + ::com::sun::star::uno::Reference< + ::com::sun::star::accessibility::XAccessible> + _GetDocumentView( sal_Bool bPagePreview ); + + /** method to build up a new data structure of the accessible pararaphs, + which have a selection + + OD 2005-12-13 #i27301# + Important note: method has to used inside a mutual exclusive section + + @author OD + */ + SwAccessibleSelectedParas_Impl* _BuildSelectedParas(); + +public: + + SwAccessibleMap( ViewShell *pSh ); + ~SwAccessibleMap(); + + ::com::sun::star::uno::Reference< + ::com::sun::star::accessibility::XAccessible> GetDocumentView(); + + // OD 15.01.2003 #103492# - complete re-factoring of method due to new + // page/print preview functionality. + ::com::sun::star::uno::Reference< + ::com::sun::star::accessibility::XAccessible> GetDocumentPreview( + const std::vector<PrevwPage*>& _rPrevwPages, + const Fraction& _rScale, + const SwPageFrm* _pSelectedPageFrm, + const Size& _rPrevwWinSize ); + + ::vos::ORef < SwAccessibleContext > GetContextImpl( + const SwFrm *pFrm, + sal_Bool bCreate = sal_True ); + ::com::sun::star::uno::Reference< + ::com::sun::star::accessibility::XAccessible> GetContext( + const SwFrm *pFrm, + sal_Bool bCreate = sal_True ); + + ::vos::ORef < ::accessibility::AccessibleShape > GetContextImpl( + const SdrObject *pObj, + SwAccessibleContext *pParentImpl, + sal_Bool bCreate = sal_True ); + ::com::sun::star::uno::Reference< + ::com::sun::star::accessibility::XAccessible> GetContext( + const SdrObject *pObj, + SwAccessibleContext *pParentImpl, + sal_Bool bCreate = sal_True ); + + inline ViewShell* GetShell() const + { + return mpVSh; + } + + inline const SwRect& GetVisArea() const + { + DBG_ASSERT( !GetShell()->IsPreView() || (mpPreview != NULL), + "preview without preview data?" ); + return GetShell()->IsPreView() + ? mpPreview->GetVisArea() + : GetShell()->VisArea(); + } + + /** get size of a dedicated preview page + + OD 15.01.2003 #103492# + complete re-factoring of previous method due to new page/print preview + functionality. + + @author OD + + @param _nPrevwPageNum + input parameter - physical page number of page visible in the page preview + + @return an object of class <Size> + */ + Size GetPreViewPageSize( sal_uInt16 _nPrevwPageNum ) const; + + void RemoveContext( const SwFrm *pFrm ); + void RemoveContext( const SdrObject *pObj ); + + // Dispose frame and its children if bRecursive is set + void Dispose( const SwFrm *pFrm, const SdrObject *pObj, + sal_Bool bRecursive=sal_False ); + + void InvalidatePosOrSize( const SwFrm *pFrm, const SdrObject *pObj, + const SwRect& rOldFrm ); + + void InvalidateContent( const SwFrm *pFrm ); + + // --> OD 2009-01-06 #i88069# + void InvalidateAttr( const SwTxtFrm& rTxtFrm ); + // <-- + + void InvalidateCursorPosition( const SwFrm *pFrm ); + void InvalidateFocus(); + + void SetCursorContext( + const ::vos::ORef < SwAccessibleContext >& rCursorContext ); + + // Invalidate state of whole tree. If an action is open, this call + // is processed when the last action ends. + // --> OD 2005-12-12 #i27301# - use new type definition for <_nStates> + void InvalidateStates( tAccessibleStates _nStates, + const SwFrm* _pFrm = 0 ); + + void InvalidateRelationSet( const SwFrm* pMaster, const SwFrm* pFollow ); + + /** invalidation CONTENT_FLOWS_FROM/_TO relation of a paragraph + + OD 2005-12-01 #i27138# + + @author OD + + @param _rTxtFrm + input parameter - reference to paragraph, whose CONTENT_FLOWS_FROM/_TO + has to be invalidated. + + @param _bFrom + input parameter - boolean indicating, if relation CONTENT_FLOWS_FROM + (value <true>) or CONTENT_FLOWS_TO (value <false>) has to be invalidated. + */ + void InvalidateParaFlowRelation( const SwTxtFrm& _rTxtFrm, + const bool _bFrom ); + + /** invalidation of text selection of a paragraph + + OD 2005-12-12 #i27301# + + @author OD + */ + void InvalidateParaTextSelection( const SwTxtFrm& _rTxtFrm ); + + /** invalidation of text selection of all paragraphs + + OD 2005-12-13 #i27301# + + @author OD + */ + void InvalidateTextSelectionOfAllParas(); + + // update preview data (and fire events if necessary) + // OD 15.01.2003 #103492# - complete re-factoring of method due to new + // page/print preview functionality. + void UpdatePreview( const std::vector<PrevwPage*>& _rPrevwPages, + const Fraction& _rScale, + const SwPageFrm* _pSelectedPageFrm, + const Size& _rPrevwWinSize ); + + void InvalidatePreViewSelection( sal_uInt16 nSelPage ); + sal_Bool IsPageSelected( const SwPageFrm *pPageFrm ) const; + + void FireEvents(); + + + // IAccessibleViewForwarder + + virtual sal_Bool IsValid() const; + virtual Rectangle GetVisibleArea() const; + virtual Point LogicToPixel (const Point& rPoint) const; + virtual Size LogicToPixel (const Size& rSize) const; + virtual Point PixelToLogic (const Point& rPoint) const; + virtual Size PixelToLogic (const Size& rSize) const; + + // IAccessibleParent + virtual sal_Bool ReplaceChild ( + ::accessibility::AccessibleShape* pCurrentChild, + const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape >& _rxShape, + const long _nIndex, + const ::accessibility::AccessibleShapeTreeInfo& _rShapeTreeInfo + ) throw (::com::sun::star::uno::RuntimeException); + + // additional Core/Pixel conversions for internal use; also works + // for preview + Point PixelToCore (const Point& rPoint) const; + Rectangle CoreToPixel (const Rectangle& rRect) const; + +private: + /** get mapping mode for LogicToPixel and PixelToLogic conversions + + OD 15.01.2003 #103492# + Replacement method <PreviewAdjust(..)> by new method <GetMapMode>. + Method returns mapping mode of current output device and adjusts it, + if the shell is in page/print preview. + Necessary, because <PreviewAdjust(..)> changes mapping mode at current + output device for mapping logic document positions to page preview window + positions and vice versa and doesn't take care to recover its changes. + + @author OD + + @param _rPoint + input parameter - constant reference to point to determine the mapping + mode adjustments for page/print preview. + + @param _orMapMode + output parameter - reference to the mapping mode, which is determined + by the method + */ + void GetMapMode( const Point& _rPoint, + MapMode& _orMapMode ) const; +}; +#endif |