This class bundles all information that is passed down the tree of accessible shapes so that each shape has access to that info. More...

#include <AccessibleShapeTreeInfo.hxx>

Collaboration diagram for accessibility::AccessibleShapeTreeInfo:

[legend]

Public Member Functions
	AccessibleShapeTreeInfo ()
	Use this constructor to create an empty object that is filled later with more meaningful data. More...

	AccessibleShapeTreeInfo (const AccessibleShapeTreeInfo &rInfo)
	Create a copy of the given shape info. More...

	~AccessibleShapeTreeInfo ()

AccessibleShapeTreeInfo &	operator= (const AccessibleShapeTreeInfo &rInfo)

void	dispose ()

void	SetDocumentWindow (const css::uno::Reference< css::accessibility::XAccessibleComponent > &rxViewWindow)
	Deprecated. More...

const css::uno::Reference< css::accessibility::XAccessibleComponent > &	GetDocumentWindow () const
	Deprecated. More...

void	SetModelBroadcaster (const css::uno::Reference< css::document::XShapeEventBroadcaster > &rxModelBroadcaster)
	Set a new broadcaster that sends events indicating shape changes. More...

const css::uno::Reference< css::document::XShapeEventBroadcaster > &	GetModelBroadcaster () const
	Return the current model broadcaster. More...

void	SetSdrView (SdrView *pView)
	Set the view that will be used to construct SvxTextEditSources which in turn are used to create accessible edit engines. More...

SdrView *	GetSdrView () const
	Return the current SdrView. More...

void	SetController (const css::uno::Reference< css::frame::XController > &rxController)
	Set a new controller. More...

const css::uno::Reference< css::frame::XController > &	GetController () const
	Return the currently set controller. More...

void	SetWindow (vcl::Window *pWindow)
	Set the window that is used to construct SvxTextEditSources which in turn is used to create accessible edit engines. More...

vcl::Window *	GetWindow () const
	Return the current Window. More...

void	SetViewForwarder (const IAccessibleViewForwarder *pViewForwarder)
	The view forwarder allows the transformation between internal and pixel coordinates and can be asked for the visible area. More...

const IAccessibleViewForwarder *	GetViewForwarder () const
	Return the current view forwarder. More...

Private Attributes
css::uno::Reference< css::accessibility::XAccessibleComponent >	mxDocumentWindow
	Deprecated. More...

css::uno::Reference< css::document::XShapeEventBroadcaster >	mxModelBroadcaster
	this broadcaster sends events indicating shape changes. More...

SdrView *	mpView
	This view is necessary to construct an SvxTextEditSource which in turn is used to create an accessible edit engine. More...

css::uno::Reference< css::frame::XController >	mxController
	The controller is used e.g. More...

VclPtr< vcl::Window >	mpWindow
	This window is necessary to construct an SvxTextEditSource which in turn is used to create an accessible edit engine. More...

const IAccessibleViewForwarder *	mpViewForwarder
	The view forwarder allows the transformation between internal and pixel coordinates and can be asked for the visible area. More...

Detailed Description

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:

The model broadcaster is used for getting notified about shape changes. Using this broadcaster makes in unnecessary to register at each shape separately.
The view forwarder is responsible for transformation between coordinate systems and for providing the visible area both with respect to a specific window.
The SdrView is used for creating accessible edit engines.
The Window is used for creating accessible edit engines.

Definition at line 55 of file AccessibleShapeTreeInfo.hxx.

Constructor & Destructor Documentation

◆ AccessibleShapeTreeInfo() [1/2]

accessibility::AccessibleShapeTreeInfo::AccessibleShapeTreeInfo ( )

Use this constructor to create an empty object that is filled later with more meaningful data.

Definition at line 31 of file AccessibleShapeTreeInfo.cxx.

References mpView, and mpWindow.

◆ AccessibleShapeTreeInfo() [2/2]

accessibility::AccessibleShapeTreeInfo::AccessibleShapeTreeInfo ( const AccessibleShapeTreeInfo & rInfo )

Create a copy of the given shape info.

Parameters

rInfo The shape tree info object to copy.

Definition at line 40 of file AccessibleShapeTreeInfo.cxx.

References mpView, and mpWindow.

◆ ~AccessibleShapeTreeInfo()

accessibility::AccessibleShapeTreeInfo::~AccessibleShapeTreeInfo ( )

Definition at line 75 of file AccessibleShapeTreeInfo.cxx.

References mpWindow, and VclPtr< class reference_type >::reset().

Member Function Documentation

◆ dispose()

void accessibility::AccessibleShapeTreeInfo::dispose ( void )

Definition at line 51 of file AccessibleShapeTreeInfo.cxx.

References mpView, mpViewForwarder, mpWindow, mxController, mxDocumentWindow, mxModelBroadcaster, and VclPtr< class reference_type >::reset().

Referenced by accessibility::AccessibleShape::disposing(), and accessibility::AccessibleCell::disposing().

◆ GetController()

const css::uno::Reference< css::frame::XController > & accessibility::AccessibleShapeTreeInfo::GetController ( ) const

inline

Return the currently set controller.

Returns: The reference to the currently set controller may be empty.

Definition at line 133 of file AccessibleShapeTreeInfo.hxx.

◆ GetDocumentWindow()

const css::uno::Reference< css::accessibility::XAccessibleComponent > & accessibility::AccessibleShapeTreeInfo::GetDocumentWindow ( ) const

inline

Deprecated.

Don't use this method.

Definition at line 84 of file AccessibleShapeTreeInfo.hxx.

Referenced by accessibility::AccessibleShape::getObjectLink().

◆ GetModelBroadcaster()

const css::uno::Reference< css::document::XShapeEventBroadcaster > & accessibility::AccessibleShapeTreeInfo::GetModelBroadcaster ( ) const

inline

Return the current model broadcaster.

Returns: The returned reference may be empty if the broadcaster has not been set or has been set to an empty reference.

Definition at line 102 of file AccessibleShapeTreeInfo.hxx.

Referenced by accessibility::AccessibleShape::disposing(), accessibility::AccessibleShape::Init(), and accessibility::ChildrenManagerImpl::SetInfo().

◆ GetSdrView()

SdrView * accessibility::AccessibleShapeTreeInfo::GetSdrView ( ) const

inline

Return the current SdrView.

Returns: The returned value may be NULL.

Definition at line 116 of file AccessibleShapeTreeInfo.hxx.

References mpView.

Referenced by accessibility::AccessibleShape::Init(), accessibility::AccessibleCell::Init(), accessibility::AccessibleControlShape::Init(), and accessibility::AccessibleShape::UpdateStates().

◆ GetViewForwarder()

const IAccessibleViewForwarder * accessibility::AccessibleShapeTreeInfo::GetViewForwarder ( ) const

inline

Return the current view forwarder.

Returns: The returned pointer may be NULL.

Definition at line 160 of file AccessibleShapeTreeInfo.hxx.

Referenced by accessibility::AccessibleShape::getBounds(), and accessibility::AccessibleCell::getBounds().

◆ GetWindow()

vcl::Window * accessibility::AccessibleShapeTreeInfo::GetWindow ( ) const

inline

Return the current Window.

Returns: The returned value may be NULL.

Definition at line 144 of file AccessibleShapeTreeInfo.hxx.

References VclPtr< class reference_type >::get(), and mpWindow.

Referenced by accessibility::AccessibleShape::Init(), accessibility::AccessibleCell::Init(), and accessibility::AccessibleControlShape::Init().

◆ operator=()

AccessibleShapeTreeInfo & accessibility::AccessibleShapeTreeInfo::operator= ( const AccessibleShapeTreeInfo & rInfo )

Definition at line 61 of file AccessibleShapeTreeInfo.cxx.

References mpView, mpViewForwarder, mpWindow, mxController, mxDocumentWindow, and mxModelBroadcaster.

◆ SetController()

void accessibility::AccessibleShapeTreeInfo::SetController ( const css::uno::Reference< css::frame::XController > & rxController )

Set a new controller.

This will usually but not necessarily correspond to the SdrView.

Parameters

rxController The new controller that replaces the current one. An empty reference may be passed to unset the controller.

Definition at line 102 of file AccessibleShapeTreeInfo.cxx.

References mxController.

◆ SetDocumentWindow()

void accessibility::AccessibleShapeTreeInfo::SetDocumentWindow ( const css::uno::Reference< css::accessibility::XAccessibleComponent > & rxViewWindow )

Deprecated.

Don't use this method.

Definition at line 84 of file AccessibleShapeTreeInfo.cxx.

References mxDocumentWindow.

◆ SetModelBroadcaster()

void accessibility::AccessibleShapeTreeInfo::SetModelBroadcaster ( const css::uno::Reference< css::document::XShapeEventBroadcaster > & rxModelBroadcaster )

Set a new broadcaster that sends events indicating shape changes.

The broadcaster usually is or belongs to a document model.

Parameters

rxModelBroadcaster The new broadcaster. It replaces the current one. An empty reference may be passed to unset the broadcaster

Definition at line 91 of file AccessibleShapeTreeInfo.cxx.

References mxModelBroadcaster.