diff options
Diffstat (limited to 'svx/inc/svx/AccessibleShapeTreeInfo.hxx')
| -rw-r--r-- | svx/inc/svx/AccessibleShapeTreeInfo.hxx | 216 |
1 files changed, 216 insertions, 0 deletions
diff --git a/svx/inc/svx/AccessibleShapeTreeInfo.hxx b/svx/inc/svx/AccessibleShapeTreeInfo.hxx new file mode 100644 index 000000000000..f43f0666a437 --- /dev/null +++ b/svx/inc/svx/AccessibleShapeTreeInfo.hxx @@ -0,0 +1,216 @@ +/************************************************************************* + * + * 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 _SVX_ACCESSIBILITY_ACCESSIBLE_SHAPE_TREE_INFO_HXX +#define _SVX_ACCESSIBILITY_ACCESSIBLE_SHAPE_TREE_INFO_HXX + +#include <com/sun/star/accessibility/XAccessibleComponent.hpp> +#include <com/sun/star/beans/XPropertySet.hpp> +#include <com/sun/star/document/XEventBroadcaster.hpp> +#include <com/sun/star/frame/XController.hpp> +#include <svx/IAccessibleViewForwarder.hxx> +#include "svx/svxdllapi.h" + +class SdrView; +class Window; + +namespace accessibility { + +/** This class bundles all information that is passed down the tree of + accessible shapes so that each shape has access to that info. + + There are basically four members that can be set and queried: + <ul> + <li>The model broadcaster is used for getting notified about shape + changes. Using this broadcaster makes in unnecessary to register at + each shape seperately.</li> + <li>The view forwarder is responsible for transformation between + coordinate systems and for providing the visible area both with respect + to a specific window.</li> + <li>The SdrView is used for creating accessible edit engines.</li> + <li>The Window is used for creating accessible edit engines.</li> + </ul> +*/ +class SVX_DLLPUBLIC AccessibleShapeTreeInfo +{ +public: + /** Deprecated. Don't use this constructor any more. + */ + AccessibleShapeTreeInfo ( + const ::com::sun::star::uno::Reference< + ::com::sun::star::accessibility::XAccessibleComponent>& rxDocumentWindow, + const ::com::sun::star::uno::Reference< + ::com::sun::star::document::XEventBroadcaster>& rxBroadcaster); + + /** Use this constructor to create an empty object that is filled later + with more meaningfull data. + */ + AccessibleShapeTreeInfo (void); + + /** Create a copy of the given shape info. + @param rInfo + The shape tree info object to copy. + */ + AccessibleShapeTreeInfo (const AccessibleShapeTreeInfo& rInfo); + + ~AccessibleShapeTreeInfo (void); + + AccessibleShapeTreeInfo& operator= (const AccessibleShapeTreeInfo& rInfo); + + /** Deprecated. Don't use this method. + */ + void SetDocumentWindow (const ::com::sun::star::uno::Reference< + ::com::sun::star::accessibility::XAccessibleComponent>& rxViewWindow); + /** Deprecated. Don't use this method. + */ + ::com::sun::star::uno::Reference< + ::com::sun::star::accessibility::XAccessibleComponent> + GetDocumentWindow (void) const; + + /** Deprecated. Use the correctly named SetModelBroadcaster method + instead. + */ + void SetControllerBroadcaster (const ::com::sun::star::uno::Reference< + ::com::sun::star::document::XEventBroadcaster>& rxControllerBroadcaster); + /** Deprecated. Use the correctly named GetModelBroadcaster method + instead. + */ + ::com::sun::star::uno::Reference< + ::com::sun::star::document::XEventBroadcaster> + GetControllerBroadcaster (void) const; + + /** Set a new broadcaster that sends events indicating shape changes. + The broadcaster usually is or belongs to a document model. + @param rxModelBroadcaster + The new broadcaster. It replaces the current one. An empty + reference may be passed to unset the broadcaster + */ + void SetModelBroadcaster (const ::com::sun::star::uno::Reference< + ::com::sun::star::document::XEventBroadcaster>& rxModelBroadcaster); + + /** Return the current model broadcaster. + @return + The returned reference may be empty if the broadcaster has not + been set or has been set to an empty reference. + */ + ::com::sun::star::uno::Reference< + ::com::sun::star::document::XEventBroadcaster> + GetModelBroadcaster (void) const; + + /** Set the view that will be used to construct SvxTextEditSources which + in turn are used to create accessible edit engines. + @param pView + The new SdrView that replaces the current one. A NULL pointer + may be passed to unset the view. + */ + void SetSdrView (SdrView* pView); + + /** Return the current SdrView. + @return + The returned value may be NULL. + */ + SdrView* GetSdrView (void) const; + + /** Set a new controller. This will usually but not necessarily + correspond to the SdrView. + @param rxController + The new controller that replaces the current one. An empty + reference may be passed to unset the controller. + */ + void SetController (const ::com::sun::star::uno::Reference< + ::com::sun::star::frame::XController>& rxController); + + /** Return the currently set controller. + @return + The reference to the currently set controller may be empty. + */ + ::com::sun::star::uno::Reference< + ::com::sun::star::frame::XController> + GetController (void) const; + + /** Set the window that is used to construct SvxTextEditSources which in + turn is used to create accessible edit engines. + */ + void SetWindow (Window* pWindow); + + /** Return the current Window. + @return + The returned value may be NULL. + */ + Window* GetWindow (void) const; + + /** The view forwarder allows the transformation between internal + and pixel coordinates and can be asked for the visible area. + @param pViewForwarder + This view forwarder replaces the current one. + */ + void SetViewForwarder (const IAccessibleViewForwarder* pViewForwarder); + + /** Return the current view forwarder. + @return + The returned pointer may be NULL. + */ + const IAccessibleViewForwarder* GetViewForwarder (void) const; + +private: + /** Deprecated. + */ + ::com::sun::star::uno::Reference< + ::com::sun::star::accessibility::XAccessibleComponent> mxDocumentWindow; + + /** this broadcaster sends events indicating shape changes. + The broadcaster usually is or belongs to a document model. + + This once was named mxControllerBroadcaster. + */ + ::com::sun::star::uno::Reference< + ::com::sun::star::document::XEventBroadcaster> mxModelBroadcaster; + + /** This view is necessary to construct an SvxTextEditSource which in + turn is used to create an accessible edit engine. + */ + SdrView* mpView; + + /** The controller is used e.g. for obtaining the selected shapes. + */ + ::com::sun::star::uno::Reference< + ::com::sun::star::frame::XController> mxController; + + /** This window is necessary to construct an SvxTextEditSource which in + turn is used to create an accessible edit engine. + */ + Window* mpWindow; + + /** The view forwarder allows the transformation between internal + and pixel coordinates and can be asked for the visible area. + */ + const IAccessibleViewForwarder* mpViewForwarder; +}; + +} // end of namespace accessibility + +#endif |