sw/inc/accmap.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: accmap.hxx,v $
  10  * $Revision: 1.29 $
  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 _ACCMAP_HXX
  31 #define _ACCMAP_HXX
  32
  33 #include <cppuhelper/weakref.hxx>
  34 #include <com/sun/star/accessibility/XAccessible.hpp>
  35 #include <vos/ref.hxx>
  36 #include <vos/mutex.hxx>
  37 #include <svx/IAccessibleViewForwarder.hxx>
  38 #include <svx/IAccessibleParent.hxx>
  39 #include "viewsh.hxx"
  40 #include <tools/debug.hxx>
  41 #include <tools/fract.hxx>
  42
  43 #include <vector>
  44
  45 class Rectangle;
  46 class SwFrm;
  47 class SwPageFrm;
  48 class SwAccessibleContext;
  49 class SwAccessibleContextMap_Impl;
  50 class SwAccessibleEventList_Impl;
  51 class SwAccessibleEventMap_Impl;
  52 class SwShapeList_Impl;
  53 class SdrObject;
  54 namespace accessibility { class AccessibleShape; }
  55 class SwAccessibleShapeMap_Impl;
  56 struct SwAccessibleEvent_Impl;
  57 // --> OD 2005-12-13 #i27301#
  58 class SwAccessibleSelectedParas_Impl;
  59 // <--
  60 class SwRect;
  61 class MapMode;
  62 class SwAccPreviewData;
  63 // OD 14.01.2003 #103492#
  64 #ifndef _PREVWPAGE_HXX
  65 #include <prevwpage.hxx>
  66 #endif
  67
  68 // helper class that stores preview data
  69 class SwAccPreviewData
  70 {
  71     typedef std::vector<Rectangle> Rectangles;
  72     Rectangles maPreviewRects;
  73     Rectangles maLogicRects;
  74
  75     SwRect maVisArea;
  76     Fraction maScale;
  77
  78     const SwPageFrm *mpSelPage;
  79
  80     /** adjust logic page retangle to its visible part
  81
  82         OD 17.01.2003 #103492#
  83
  84         @author OD
  85
  86         @param _iorLogicPgSwRect
  87         input/output parameter - reference to the logic page rectangle, which
  88         has to be adjusted.
  89
  90         @param _rPrevwPgSwRect
  91         input parameter - constant reference to the corresponding preview page
  92         rectangle; needed to determine the visible part of the logic page rectangle.
  93
  94         @param _rPrevwWinSize
  95         input paramter - constant reference to the preview window size in TWIP;
  96         needed to determine the visible part of the logic page rectangle
  97     */
  98     void AdjustLogicPgRectToVisibleArea( SwRect&         _iorLogicPgSwRect,
  99                                          const SwRect&   _rPrevwPgSwRect,
 100                                          const Size&     _rPrevwWinSize );
 101
 102 public:
 103     SwAccPreviewData();
 104     ~SwAccPreviewData();
 105
 106     // OD 14.01.2003 #103492# - complete re-factoring of method due to new
 107     // page/print preview functionality.
 108     void Update( const std::vector<PrevwPage*>& _rPrevwPages,
 109                  const Fraction&  _rScale,
 110                  const SwPageFrm* _pSelectedPageFrm,
 111                  const Size&      _rPrevwWinSize );
 112
 113     // OD 14.01.2003 #103492# - complete re-factoring of method due to new
 114     // page/print preview functionality.
 115     void InvalidateSelection( const SwPageFrm* _pSelectedPageFrm );
 116
 117     const SwRect& GetVisArea() const;
 118
 119     MapMode GetMapModeForPreview( ) const;
 120
 121     /** Adjust the MapMode so that the preview page appears at the
 122      * proper position. rPoint identifies the page for which the
 123      * MapMode should be adjusted. If bFromPreview is true, rPoint is
 124      * a preview coordinate; else it's a document coordinate. */
 125     // OD 17.01.2003 #103492# - delete unused 3rd parameter.
 126     void AdjustMapMode( MapMode& rMapMode,
 127                         const Point& rPoint ) const;
 128
 129     inline const SwPageFrm *GetSelPage() const { return mpSelPage; }
 130
 131     void DisposePage(const SwPageFrm *pPageFrm );
 132 };
 133
 134 // real states for events
 135 #define ACC_STATE_EDITABLE 0x01
 136 #define ACC_STATE_OPAQUE 0x02
 137
 138 // pseudo states for events
 139 // --> OD 2005-12-12 #i27301# - pseudo state for event TEXT_SELECTION_CHANGED
 140 #define ACC_STATE_TEXT_SELECTION_CHANGED 0x0100
 141 // <--
 142 #define ACC_STATE_CARET 0x80
 143 #define ACC_STATE_RELATION_FROM 0x40
 144 #define ACC_STATE_RELATION_TO 0x20
 145
 146 #define ACC_STATE_RELATION_MASK 0x60
 147
 148 #define ACC_STATE_MASK 0x1F
 149
 150 // --> OD 2005-12-12 #i27301# - introduce type definition of states
 151 typedef sal_uInt16 tAccessibleStates;
 152 // <--
 153
 154 class SwAccessibleMap : public accessibility::IAccessibleViewForwarder,
 155                                                 public accessibility::IAccessibleParent
 156 {
 157         ::vos::OMutex maMutex;
 158         ::vos::OMutex maEventMutex;
 159         SwAccessibleContextMap_Impl *mpFrmMap;
 160         SwAccessibleShapeMap_Impl *mpShapeMap;
 161         SwShapeList_Impl *mpShapes;
 162         SwAccessibleEventList_Impl *mpEvents;
 163         SwAccessibleEventMap_Impl *mpEventMap;
 164     // --> OD 2005-12-13 #i27301# - data structure to keep information about
 165     // accessible paragraph, which have a selection.
 166     SwAccessibleSelectedParas_Impl* mpSelectedParas;
 167     // <--
 168     ViewShell *mpVSh;
 169     /// for page preview: store preview data, VisArea, and mapping of
 170     /// preview-to-display coordinates
 171     SwAccPreviewData* mpPreview;
 172
 173         ::com::sun::star::uno::WeakReference < ::com::sun::star::accessibility::XAccessible > mxCursorContext;
 174
 175         sal_Int32 mnPara;
 176         sal_Int32 mnFootnote;
 177         sal_Int32 mnEndnote;
 178
 179
 180         sal_Bool mbShapeSelected;
 181
 182         void FireEvent( const SwAccessibleEvent_Impl& rEvent );
 183
 184         void AppendEvent( const SwAccessibleEvent_Impl& rEvent );
 185
 186         void InvalidateCursorPosition(
 187                 const ::com::sun::star::uno::Reference<
 188                         ::com::sun::star::accessibility::XAccessible>& rAcc );
 189         void DoInvalidateShapeSelection();
 190         void DoInvalidateShapeFocus();
 191         void InvalidateShapeSelection();
 192
 193     void _InvalidateRelationSet( const SwFrm* pFrm, sal_Bool bFrom );
 194
 195         ::com::sun::star::uno::Reference<
 196                 ::com::sun::star::accessibility::XAccessible>
 197             _GetDocumentView( sal_Bool bPagePreview );
 198
 199     /** method to build up a new data structure of the accessible pararaphs,
 200         which have a selection
 201
 202         OD 2005-12-13 #i27301#
 203         Important note: method has to used inside a mutual exclusive section
 204
 205         @author OD
 206     */
 207     SwAccessibleSelectedParas_Impl* _BuildSelectedParas();
 208
 209 public:
 210
 211         SwAccessibleMap( ViewShell *pSh );
 212         ~SwAccessibleMap();
 213
 214         ::com::sun::star::uno::Reference<
 215                 ::com::sun::star::accessibility::XAccessible> GetDocumentView();
 216
 217     // OD 15.01.2003 #103492# - complete re-factoring of method due to new
 218     // page/print preview functionality.
 219     ::com::sun::star::uno::Reference<
 220         ::com::sun::star::accessibility::XAccessible> GetDocumentPreview(
 221                             const std::vector<PrevwPage*>& _rPrevwPages,
 222                             const Fraction&  _rScale,
 223                             const SwPageFrm* _pSelectedPageFrm,
 224                             const Size&      _rPrevwWinSize );
 225
 226         ::vos::ORef < SwAccessibleContext > GetContextImpl(
 227                                                                                                 const SwFrm *pFrm,
 228                                                                                                 sal_Bool bCreate = sal_True );
 229         ::com::sun::star::uno::Reference<
 230                 ::com::sun::star::accessibility::XAccessible> GetContext(
 231                                                                                                 const SwFrm *pFrm,
 232                                                                                                 sal_Bool bCreate = sal_True );
 233
 234         ::vos::ORef < ::accessibility::AccessibleShape > GetContextImpl(
 235                                                                                 const SdrObject *pObj,
 236                                                                                 SwAccessibleContext *pParentImpl,
 237                                                                                 sal_Bool bCreate = sal_True );
 238         ::com::sun::star::uno::Reference<
 239                 ::com::sun::star::accessibility::XAccessible> GetContext(
 240                                                                                 const SdrObject *pObj,
 241                                                                                 SwAccessibleContext *pParentImpl,
 242                                                                                 sal_Bool bCreate = sal_True );
 243
 244     inline ViewShell* GetShell() const
 245     {
 246         return mpVSh;
 247     }
 248
 249     inline const SwRect& GetVisArea() const
 250     {
 251         DBG_ASSERT( !GetShell()->IsPreView() || (mpPreview != NULL),
 252                     "preview without preview data?" );
 253         return GetShell()->IsPreView()
 254                ? mpPreview->GetVisArea()
 255                : GetShell()->VisArea();
 256     }
 257
 258     /** get size of a dedicated preview page
 259
 260         OD 15.01.2003 #103492#
 261         complete re-factoring of previous method due to new page/print preview
 262         functionality.
 263
 264         @author OD
 265
 266         @param _nPrevwPageNum
 267         input parameter - physical page number of page visible in the page preview
 268
 269         @return an object of class <Size>
 270     */
 271     Size GetPreViewPageSize( sal_uInt16 _nPrevwPageNum ) const;
 272
 273         void RemoveContext( const SwFrm *pFrm );
 274         void RemoveContext( const SdrObject *pObj );
 275
 276         // Dispose frame and its children if bRecursive is set
 277         void Dispose( const SwFrm *pFrm, const SdrObject *pObj,
 278                                   sal_Bool bRecursive=sal_False );
 279
 280         void InvalidatePosOrSize( const SwFrm *pFrm, const SdrObject *pObj,
 281                                                           const SwRect& rOldFrm );
 282
 283         void InvalidateContent( const SwFrm *pFrm );
 284
 285         void InvalidateCursorPosition( const SwFrm *pFrm );
 286         void InvalidateFocus();
 287
 288         void SetCursorContext(
 289                 const ::vos::ORef < SwAccessibleContext >& rCursorContext );
 290
 291         // Invalidate state of whole tree. If an action is open, this call
 292         // is processed when the last action ends.
 293     // --> OD 2005-12-12 #i27301# - use new type definition for <_nStates>
 294     void InvalidateStates( tAccessibleStates _nStates,
 295                            const SwFrm* _pFrm = 0 );
 296
 297     void InvalidateRelationSet( const SwFrm* pMaster, const SwFrm* pFollow );
 298
 299     /** invalidation CONTENT_FLOWS_FROM/_TO relation of a paragraph
 300
 301         OD 2005-12-01 #i27138#
 302
 303         @author OD
 304
 305         @param _rTxtFrm
 306         input parameter - reference to paragraph, whose CONTENT_FLOWS_FROM/_TO
 307         has to be invalidated.
 308
 309         @param _bFrom
 310         input parameter - boolean indicating, if relation CONTENT_FLOWS_FROM
 311         (value <true>) or CONTENT_FLOWS_TO (value <false>) has to be invalidated.
 312     */
 313     void InvalidateParaFlowRelation( const SwTxtFrm& _rTxtFrm,
 314                                      const bool _bFrom );
 315
 316     /** invalidation of text selection of a paragraph
 317
 318         OD 2005-12-12 #i27301#
 319
 320         @author OD
 321     */
 322     void InvalidateParaTextSelection( const SwTxtFrm& _rTxtFrm );
 323
 324     /** invalidation of text selection of all paragraphs
 325
 326         OD 2005-12-13 #i27301#
 327
 328         @author OD
 329     */
 330     void InvalidateTextSelectionOfAllParas();
 331
 332     // update preview data (and fire events if necessary)
 333     // OD 15.01.2003 #103492# - complete re-factoring of method due to new
 334     // page/print preview functionality.
 335     void UpdatePreview( const std::vector<PrevwPage*>& _rPrevwPages,
 336                         const Fraction&  _rScale,
 337                         const SwPageFrm* _pSelectedPageFrm,
 338                         const Size&      _rPrevwWinSize );
 339
 340     void InvalidatePreViewSelection( sal_uInt16 nSelPage );
 341         sal_Bool IsPageSelected( const SwPageFrm *pPageFrm ) const;
 342
 343         void FireEvents();
 344
 345
 346         // IAccessibleViewForwarder
 347
 348         virtual sal_Bool IsValid() const;
 349     virtual Rectangle GetVisibleArea() const;
 350     virtual Point LogicToPixel (const Point& rPoint) const;
 351     virtual Size LogicToPixel (const Size& rSize) const;
 352     virtual Point PixelToLogic (const Point& rPoint) const;
 353     virtual Size PixelToLogic (const Size& rSize) const;
 354
 355         // IAccessibleParent
 356     virtual sal_Bool ReplaceChild (
 357         ::accessibility::AccessibleShape* pCurrentChild,
 358                 const ::com::sun::star::uno::Reference< ::com::sun::star::drawing::XShape >& _rxShape,
 359                 const long _nIndex,
 360                 const ::accessibility::AccessibleShapeTreeInfo& _rShapeTreeInfo
 361         )       throw (::com::sun::star::uno::RuntimeException);
 362
 363     // additional Core/Pixel conversions for internal use; also works
 364     // for preview
 365     Point PixelToCore (const Point& rPoint) const;
 366     Rectangle CoreToPixel (const Rectangle& rRect) const;
 367
 368 private:
 369     /** get mapping mode for LogicToPixel and PixelToLogic conversions
 370
 371         OD 15.01.2003 #103492#
 372         Replacement method <PreviewAdjust(..)> by new method <GetMapMode>.
 373         Method returns mapping mode of current output device and adjusts it,
 374         if the shell is in page/print preview.
 375         Necessary, because <PreviewAdjust(..)> changes mapping mode at current
 376         output device for mapping logic document positions to page preview window
 377         positions and vice versa and doesn't take care to recover its changes.
 378
 379         @author OD
 380
 381         @param _rPoint
 382         input parameter - constant reference to point to determine the mapping
 383         mode adjustments for page/print preview.
 384
 385         @param _orMapMode
 386         output parameter - reference to the mapping mode, which is determined
 387         by the method
 388     */
 389     void GetMapMode( const Point& _rPoint,
 390                      MapMode&     _orMapMode ) const;
 391 };
 392 #endif