LibreOffice Module svx (master)  1
Public Member Functions | Private Attributes | List of all members
accessibility::AccessibleShapeTreeInfo Class Reference

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 ()
 
AccessibleShapeTreeInfooperator= (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...
 
SdrViewGetSdrView () 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 SetDevice (OutputDevice *pWindow)
 Set the window that is used to construct SvxTextEditSources which in turn is used to create accessible edit engines. More...
 
vcl::WindowGetWindow () const
 Return the current Window. More...
 
OutputDeviceGetDevice () const
 
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 IAccessibleViewForwarderGetViewForwarder () 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...
 
SdrViewmpView
 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< OutputDevicempWindow
 This window is necessary to construct an SvxTextEditSource which in turn is used to create an accessible edit engine. More...
 
const IAccessibleViewForwardermpViewForwarder
 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:

Definition at line 54 of file AccessibleShapeTreeInfo.hxx.

Constructor & Destructor Documentation

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.

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

Create a copy of the given shape info.

Parameters
rInfoThe shape tree info object to copy.

Definition at line 40 of file AccessibleShapeTreeInfo.cxx.

References mpView, and mpWindow.

accessibility::AccessibleShapeTreeInfo::~AccessibleShapeTreeInfo ( )

Definition at line 75 of file AccessibleShapeTreeInfo.cxx.

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

Member Function Documentation

void accessibility::AccessibleShapeTreeInfo::dispose ( void  )
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 132 of file AccessibleShapeTreeInfo.hxx.

Referenced by accessibility::ChildrenManagerImpl::impl_dispose(), accessibility::ChildrenManagerImpl::Init(), accessibility::ChildrenManagerImpl::SetInfo(), and accessibility::ChildrenManagerImpl::UpdateSelection().

OutputDevice* accessibility::AccessibleShapeTreeInfo::GetDevice ( ) const
inline

Definition at line 149 of file AccessibleShapeTreeInfo.hxx.

References mpWindow.

Referenced by accessibility::AccessibleControlShape::Init().

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

Deprecated.

Don't use this method.

Definition at line 83 of file AccessibleShapeTreeInfo.hxx.

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

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 101 of file AccessibleShapeTreeInfo.hxx.

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

SdrView* accessibility::AccessibleShapeTreeInfo::GetSdrView ( ) const
inline
const IAccessibleViewForwarder* accessibility::AccessibleShapeTreeInfo::GetViewForwarder ( ) const
inline
vcl::Window* accessibility::AccessibleShapeTreeInfo::GetWindow ( ) const
inline
AccessibleShapeTreeInfo & accessibility::AccessibleShapeTreeInfo::operator= ( const AccessibleShapeTreeInfo rInfo)
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
rxControllerThe new controller that replaces the current one. An empty reference may be passed to unset the controller.

Definition at line 99 of file AccessibleShapeTreeInfo.cxx.

References mxController.

Referenced by accessibility::ChildrenManagerImpl::impl_dispose().

void accessibility::AccessibleShapeTreeInfo::SetDevice ( OutputDevice pWindow)

Set the window that is used to construct SvxTextEditSources which in turn is used to create accessible edit engines.

Definition at line 105 of file AccessibleShapeTreeInfo.cxx.

References mpWindow.

Referenced by SvxGraphCtrlAccessibleContext::SvxGraphCtrlAccessibleContext().

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

Deprecated.

Don't use this method.

Definition at line 81 of file AccessibleShapeTreeInfo.cxx.

References mxDocumentWindow.

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
rxModelBroadcasterThe new broadcaster. It replaces the current one. An empty reference may be passed to unset the broadcaster

Definition at line 88 of file AccessibleShapeTreeInfo.cxx.

References mxModelBroadcaster.

Referenced by accessibility::ChildrenManagerImpl::impl_dispose().

void accessibility::AccessibleShapeTreeInfo::SetSdrView ( SdrView pView)

Set the view that will be used to construct SvxTextEditSources which in turn are used to create accessible edit engines.

Parameters
pViewThe new SdrView that replaces the current one. A NULL pointer may be passed to unset the view.

Definition at line 94 of file AccessibleShapeTreeInfo.cxx.

References mpView.

Referenced by SvxGraphCtrlAccessibleContext::setModelAndView(), and SvxGraphCtrlAccessibleContext::SvxGraphCtrlAccessibleContext().

void accessibility::AccessibleShapeTreeInfo::SetViewForwarder ( const IAccessibleViewForwarder pViewForwarder)

The view forwarder allows the transformation between internal and pixel coordinates and can be asked for the visible area.

Parameters
pViewForwarderThis view forwarder replaces the current one.

Definition at line 110 of file AccessibleShapeTreeInfo.cxx.

References mpViewForwarder.

Referenced by SvxGraphCtrlAccessibleContext::SvxGraphCtrlAccessibleContext().

Member Data Documentation

SdrView* accessibility::AccessibleShapeTreeInfo::mpView
private

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

Definition at line 181 of file AccessibleShapeTreeInfo.hxx.

Referenced by dispose(), operator=(), and SetSdrView().

const IAccessibleViewForwarder* accessibility::AccessibleShapeTreeInfo::mpViewForwarder
private

The view forwarder allows the transformation between internal and pixel coordinates and can be asked for the visible area.

Definition at line 196 of file AccessibleShapeTreeInfo.hxx.

Referenced by dispose(), operator=(), and SetViewForwarder().

VclPtr<OutputDevice> accessibility::AccessibleShapeTreeInfo::mpWindow
private

This window is necessary to construct an SvxTextEditSource which in turn is used to create an accessible edit engine.

Definition at line 191 of file AccessibleShapeTreeInfo.hxx.

Referenced by dispose(), operator=(), SetDevice(), and ~AccessibleShapeTreeInfo().

css::uno::Reference< css::frame::XController> accessibility::AccessibleShapeTreeInfo::mxController
private

The controller is used e.g.

for obtaining the selected shapes.

Definition at line 186 of file AccessibleShapeTreeInfo.hxx.

Referenced by dispose(), operator=(), and SetController().

css::uno::Reference< css::accessibility::XAccessibleComponent> accessibility::AccessibleShapeTreeInfo::mxDocumentWindow
private

Deprecated.

Definition at line 168 of file AccessibleShapeTreeInfo.hxx.

Referenced by dispose(), operator=(), and SetDocumentWindow().

css::uno::Reference< css::document::XShapeEventBroadcaster> accessibility::AccessibleShapeTreeInfo::mxModelBroadcaster
private

this broadcaster sends events indicating shape changes.

The broadcaster usually is or belongs to a document model.

This once was named mxControllerBroadcaster.

Definition at line 176 of file AccessibleShapeTreeInfo.hxx.

Referenced by dispose(), operator=(), and SetModelBroadcaster().


The documentation for this class was generated from the following files: