include/svx/AccessibleShapeTreeInfo.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef _SVX_ACCESSIBILITY_ACCESSIBLE_SHAPE_TREE_INFO_HXX
  21 #define _SVX_ACCESSIBILITY_ACCESSIBLE_SHAPE_TREE_INFO_HXX
  22
  23 #include <com/sun/star/accessibility/XAccessibleComponent.hpp>
  24 #include <com/sun/star/beans/XPropertySet.hpp>
  25 #include <com/sun/star/document/XEventBroadcaster.hpp>
  26 #include <com/sun/star/frame/XController.hpp>
  27 #include <svx/IAccessibleViewForwarder.hxx>
  28 #include "svx/svxdllapi.h"
  29
  30 class SdrView;
  31 class Window;
  32
  33 namespace accessibility {
  34
  35 /** This class bundles all information that is passed down the tree of
  36     accessible shapes so that each shape has access to that info.
  37
  38     There are basically four members that can be set and queried:
  39     <ul>
  40     <li>The model broadcaster is used for getting notified about shape
  41     changes.  Using this broadcaster makes in unnecessary to register at
  42     each shape separately.</li>
  43     <li>The view forwarder is responsible for transformation between
  44     coordinate systems and for providing the visible area both with respect
  45     to a specific window.</li>
  46     <li>The SdrView is used for creating accessible edit engines.</li>
  47     <li>The Window is used for creating accessible edit engines.</li>
  48     </ul>
  49 */
  50 class SVX_DLLPUBLIC AccessibleShapeTreeInfo
  51 {
  52 public:
  53     /** Use this constructor to create an empty object that is filled later
  54         with more meaningfull data.
  55     */
  56     AccessibleShapeTreeInfo (void);
  57
  58     /** Create a copy of the given shape info.
  59         @param rInfo
  60             The shape tree info object to copy.
  61     */
  62     AccessibleShapeTreeInfo (const AccessibleShapeTreeInfo& rInfo);
  63
  64     ~AccessibleShapeTreeInfo (void);
  65
  66     AccessibleShapeTreeInfo& operator= (const AccessibleShapeTreeInfo& rInfo);
  67
  68     /** Deprecated.  Don't use this method.
  69     */
  70     void SetDocumentWindow (const ::com::sun::star::uno::Reference<
  71         ::com::sun::star::accessibility::XAccessibleComponent>& rxViewWindow);
  72
  73     /** Deprecated.   Use the correctly named SetModelBroadcaster method
  74         instead.
  75     */
  76     void SetControllerBroadcaster (const ::com::sun::star::uno::Reference<
  77         ::com::sun::star::document::XEventBroadcaster>& rxControllerBroadcaster);
  78     /** Deprecated.   Use the correctly named GetModelBroadcaster method
  79         instead.
  80     */
  81     ::com::sun::star::uno::Reference<
  82         ::com::sun::star::document::XEventBroadcaster>
  83         GetControllerBroadcaster (void) const;
  84
  85     /** Set a new broadcaster that sends events indicating shape changes.
  86         The broadcaster usually is or belongs to a document model.
  87         @param rxModelBroadcaster
  88             The new broadcaster.  It replaces the current one.  An empty
  89             reference may be passed to unset the broadcaster
  90     */
  91     void SetModelBroadcaster (const ::com::sun::star::uno::Reference<
  92         ::com::sun::star::document::XEventBroadcaster>& rxModelBroadcaster);
  93
  94     /** Return the current model broadcaster.
  95         @return
  96             The returned reference may be empty if the broadcaster has not
  97             been set or has been set to an empty reference.
  98     */
  99     ::com::sun::star::uno::Reference<
 100         ::com::sun::star::document::XEventBroadcaster>
 101         GetModelBroadcaster (void) const;
 102
 103     /** Set the view that will be used to construct SvxTextEditSources which
 104         in turn are used to create accessible edit engines.
 105         @param pView
 106             The new SdrView that replaces the current one.  A NULL pointer
 107             may be passed to unset the view.
 108     */
 109     void SetSdrView (SdrView* pView);
 110
 111     /** Return the current SdrView.
 112         @return
 113             The returned value may be NULL.
 114     */
 115     SdrView* GetSdrView (void) const;
 116
 117     /** Set a new controller.  This will usually but not necessarily
 118         correspond to the SdrView.
 119         @param rxController
 120             The new controller that replaces the current one.  An empty
 121             reference may be passed to unset the controller.
 122     */
 123     void SetController (const ::com::sun::star::uno::Reference<
 124         ::com::sun::star::frame::XController>& rxController);
 125
 126     /** Return the currently set controller.
 127         @return
 128             The reference to the currently set controller may be empty.
 129     */
 130     ::com::sun::star::uno::Reference<
 131         ::com::sun::star::frame::XController>
 132         GetController (void) const;
 133
 134     /** Set the window that is used to construct SvxTextEditSources which in
 135         turn is used to create accessible edit engines.
 136     */
 137     void SetWindow (Window* pWindow);
 138
 139     /** Return the current Window.
 140         @return
 141             The returned value may be NULL.
 142     */
 143     Window* GetWindow (void) const;
 144
 145     /** The view forwarder allows the transformation between internal
 146         and pixel coordinates and can be asked for the visible area.
 147         @param pViewForwarder
 148             This view forwarder replaces the current one.
 149     */
 150     void SetViewForwarder (const IAccessibleViewForwarder* pViewForwarder);
 151
 152     /** Return the current view forwarder.
 153         @return
 154             The returned pointer may be NULL.
 155     */
 156     const IAccessibleViewForwarder* GetViewForwarder (void) const;
 157
 158 private:
 159     /** Deprecated.
 160     */
 161     ::com::sun::star::uno::Reference<
 162         ::com::sun::star::accessibility::XAccessibleComponent> mxDocumentWindow;
 163
 164     /** this broadcaster sends events indicating shape changes.
 165         The broadcaster usually is or belongs to a document model.
 166
 167         This once was named mxControllerBroadcaster.
 168     */
 169     ::com::sun::star::uno::Reference<
 170         ::com::sun::star::document::XEventBroadcaster> mxModelBroadcaster;
 171
 172     /** This view is necessary to construct an SvxTextEditSource which in
 173         turn is used to create an accessible edit engine.
 174     */
 175     SdrView* mpView;
 176
 177     /** The controller is used e.g. for obtaining the selected shapes.
 178     */
 179     ::com::sun::star::uno::Reference<
 180         ::com::sun::star::frame::XController> mxController;
 181
 182     /** This window is necessary to construct an SvxTextEditSource which in
 183         turn is used to create an accessible edit engine.
 184     */
 185     Window* mpWindow;
 186
 187     /** The view forwarder allows the transformation between internal
 188         and pixel coordinates and can be asked for the visible area.
 189     */
 190     const IAccessibleViewForwarder* mpViewForwarder;
 191 };
 192
 193 } // end of namespace accessibility
 194
 195 #endif
 196
 197 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */