This base class provides a base implementation for all shapes. More...

#include <AccessibleShape.hxx>

Inheritance diagram for accessibility::AccessibleShape:

Collaboration diagram for accessibility::AccessibleShape:

Public Member Functions
	AccessibleShape (const AccessibleShapeInfo &rShapeInfo, const AccessibleShapeTreeInfo &rShapeTreeInfo)
	Create a new accessible object that makes the given shape accessible. More...

virtual OUString SAL_CALL	getAccessibleName () override

virtual OUString SAL_CALL	getAccessibleDescription () override

virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL	getAccessibleRelationSet () override

virtual void SAL_CALL	selectAccessibleChild (sal_Int64 nChildIndex) override

virtual sal_Bool SAL_CALL	isAccessibleChildSelected (sal_Int64 nChildIndex) override

virtual void SAL_CALL	clearAccessibleSelection () override

virtual void SAL_CALL	selectAllAccessibleChildren () override

virtual sal_Int64 SAL_CALL	getSelectedAccessibleChildCount () override

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	getSelectedAccessibleChild (sal_Int64 nSelectedChildIndex) override

virtual void SAL_CALL	deselectAccessibleChild (sal_Int64 nSelectedChildIndex) override

virtual css::uno::Any SAL_CALL	getExtendedAttributes () override

virtual sal_Int16 SAL_CALL	getAccessibleRole () override
	Return this object's role. More...

virtual css::uno::Sequence< sal_Int32 > SAL_CALL	getGroupPosition (const css::uno::Any &rAny) override

virtual OUString SAL_CALL	getObjectLink (const css::uno::Any &accoject) override

virtual	~AccessibleShape () override
	The destructor releases its children manager and text engine if still existent. More...

virtual void	Init ()
	Initialize a new shape. More...

virtual bool	SetState (sal_Int64 aState) override
	Set the specified state. More...

virtual bool	ResetState (sal_Int64 aState) override
	Reset the specified state. More...

bool	GetState (sal_Int64 aState)
	Return the state of the specified state. More...

virtual sal_Int64 SAL_CALL	getAccessibleChildCount () override
	Return the number of currently visible children. More...

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	getAccessibleChild (sal_Int64 nIndex) override
	Return the specified child. More...

virtual sal_Int64 SAL_CALL	getAccessibleStateSet () override
	Return the set of current states. More...

virtual sal_Int64 SAL_CALL	getAccessibleIndexInParent () override
	Return this objects index among the parents children. More...

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	getAccessibleAtPoint (const css::awt::Point &aPoint) override
	The implementation below is at the moment straightforward. More...

virtual css::awt::Rectangle SAL_CALL	getBounds () override

virtual css::awt::Point SAL_CALL	getLocation () override

virtual css::awt::Point SAL_CALL	getLocationOnScreen () override

virtual css::awt::Size SAL_CALL	getSize () override

virtual sal_Int32 SAL_CALL	getForeground () override

virtual sal_Int32 SAL_CALL	getBackground () override

virtual void SAL_CALL	addAccessibleEventListener (const css::uno::Reference< css::accessibility::XAccessibleEventListener > &rxListener) override
	This call is forwarded to a) the base class and b) to the accessible edit engine if it is present. More...

virtual void SAL_CALL	removeAccessibleEventListener (const css::uno::Reference< css::accessibility::XAccessibleEventListener > &rxListener) override
	This call is forwarded to a) the base class and b) to the accessible edit engine if it is present. More...

virtual css::uno::Any SAL_CALL	queryInterface (const css::uno::Type &rType) override

virtual void SAL_CALL	acquire () noexcept override

virtual void SAL_CALL	release () noexcept override

virtual OUString SAL_CALL	getImplementationName () override
	Returns an identifier for the implementation of this object. More...

virtual css::uno::Sequence< OUString > SAL_CALL	getSupportedServiceNames () override

virtual css::uno::Sequence< css::uno::Type > SAL_CALL	getTypes () override

virtual void	ViewForwarderChanged () override
	This method is called to indicate a change of the specified view forwarder, specifically, a change in visible area. More...

void	disposing (const css::lang::EventObject &Source)
	Listen for disposing events of the model. More...

virtual void SAL_CALL	notifyShapeEvent (const css::document::EventObject &rEventObject) override

virtual sal_Int32 SAL_CALL	getHyperLinkCount () override

virtual css::uno::Reference< css::accessibility::XAccessibleHyperlink > SAL_CALL	getHyperLink (sal_Int32 nLinkIndex) override

virtual sal_Int32 SAL_CALL	getHyperLinkIndex (sal_Int32 nCharIndex) override

virtual sal_Int32 SAL_CALL	getCaretPosition () override

virtual sal_Bool SAL_CALL	setCaretPosition (sal_Int32 nIndex) override

virtual sal_Unicode SAL_CALL	getCharacter (sal_Int32 nIndex) override

virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL	getCharacterAttributes (sal_Int32 nIndex, const css::uno::Sequence< OUString > &aRequestedAttributes) override

virtual css::awt::Rectangle SAL_CALL	getCharacterBounds (sal_Int32 nIndex) override

virtual sal_Int32 SAL_CALL	getCharacterCount () override

virtual sal_Int32 SAL_CALL	getIndexAtPoint (const css::awt::Point &aPoint) override

virtual OUString SAL_CALL	getSelectedText () override

virtual sal_Int32 SAL_CALL	getSelectionStart () override

virtual sal_Int32 SAL_CALL	getSelectionEnd () override

virtual sal_Bool SAL_CALL	setSelection (sal_Int32 nStartIndex, sal_Int32 nEndIndex) override

virtual OUString SAL_CALL	getText () override

virtual OUString SAL_CALL	getTextRange (sal_Int32 nStartIndex, sal_Int32 nEndIndex) override

virtual css::accessibility::TextSegment SAL_CALL	getTextAtIndex (sal_Int32 nIndex, sal_Int16 aTextType) override

virtual css::accessibility::TextSegment SAL_CALL	getTextBeforeIndex (sal_Int32 nIndex, sal_Int16 aTextType) override

virtual css::accessibility::TextSegment SAL_CALL	getTextBehindIndex (sal_Int32 nIndex, sal_Int16 aTextType) override

virtual sal_Bool SAL_CALL	copyText (sal_Int32 nStartIndex, sal_Int32 nEndIndex) override

virtual sal_Bool SAL_CALL	scrollSubstringTo (sal_Int32 nStartIndex, sal_Int32 nEndIndex, css::accessibility::AccessibleScrollType aScrollType) override

const css::uno::Reference< css::drawing::XShape > &	GetXShape () const

void	setIndexInParent (sal_Int32 _nIndex)
	set the index _nIndex at the accessible shape More...

Public Member Functions inherited from accessibility::AccessibleContextBase
	AccessibleContextBase (css::uno::Reference< css::accessibility::XAccessible > xParent, const sal_Int16 aRole)

virtual	~AccessibleContextBase () override

void	CommitChange (sal_Int16 aEventId, const css::uno::Any &rNewValue, const css::uno::Any &rOldValue, sal_Int32 nValueIndex)

void	SetAccessibleDescription (const OUString &rsDescription, StringOrigin eDescriptionOrigin)

void	SetAccessibleName (const OUString &rsName, StringOrigin eNameOrigin)

virtual bool	SetState (sal_Int64 aState)

virtual bool	ResetState (sal_Int64 aState)

bool	GetState (sal_Int64 aState)

void	SetRelationSet (const css::uno::Reference< css::accessibility::XAccessibleRelationSet > &rxRelationSet)

virtual css::uno::Reference< css::accessibility::XAccessibleContext > SAL_CALL	getAccessibleContext () override

virtual sal_Int64 SAL_CALL	getAccessibleChildCount () override

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	getAccessibleChild (sal_Int64 nIndex) override

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	getAccessibleParent () override

virtual sal_Int64 SAL_CALL	getAccessibleIndexInParent () override

virtual sal_Int16 SAL_CALL	getAccessibleRole () override

virtual OUString SAL_CALL	getAccessibleDescription () override

virtual OUString SAL_CALL	getAccessibleName () override

virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL	getAccessibleRelationSet () override

virtual sal_Int64 SAL_CALL	getAccessibleStateSet () override

virtual css::lang::Locale SAL_CALL	getLocale () override

virtual void SAL_CALL	addAccessibleEventListener (const css::uno::Reference< css::accessibility::XAccessibleEventListener > &xListener) override

virtual void SAL_CALL	removeAccessibleEventListener (const css::uno::Reference< css::accessibility::XAccessibleEventListener > &xListener) override

virtual OUString SAL_CALL	getImplementationName () override

virtual sal_Bool SAL_CALL	supportsService (const OUString &sServiceName) override

virtual css::uno::Sequence< OUString > SAL_CALL	getSupportedServiceNames () override

virtual css::uno::Sequence< sal_Int8 > SAL_CALL	getImplementationId () override

bool	IsDisposed () const

Public Member Functions inherited from accessibility::AccessibleComponentBase
	AccessibleComponentBase ()

virtual	~AccessibleComponentBase ()

virtual sal_Bool SAL_CALL	containsPoint (const css::awt::Point &aPoint) override

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	getAccessibleAtPoint (const css::awt::Point &aPoint) override

virtual css::awt::Rectangle SAL_CALL	getBounds () override

virtual css::awt::Point SAL_CALL	getLocation () override

virtual css::awt::Point SAL_CALL	getLocationOnScreen () override

virtual css::awt::Size SAL_CALL	getSize () override

virtual void SAL_CALL	grabFocus () override

virtual sal_Int32 SAL_CALL	getForeground () override

virtual sal_Int32 SAL_CALL	getBackground () override

virtual css::uno::Reference< css::awt::XFont > SAL_CALL	getFont () override

virtual OUString SAL_CALL	getTitledBorderText () override

virtual OUString SAL_CALL	getToolTipText () override

virtual css::uno::Sequence< css::uno::Type > SAL_CALL	getTypes ()

virtual void	ViewForwarderChanged ()=0
	This method is called to indicate a change of the specified view forwarder, specifically, a change in visible area. More...

Protected Member Functions
virtual void SAL_CALL	disposing () override
	This method is called from the component helper base class while disposing. More...

virtual OUString	CreateAccessibleBaseName ()
	Create a base name string that contains the accessible name. More...

virtual OUString	CreateAccessibleName () override
	Create a unique name string that contains the accessible name. More...

OUString	GetFullAccessibleName (AccessibleShape *shape)

virtual OUString	GetStyle () const

void	UpdateStates ()
	Update the <const>OPAQUE</const> and <const>SELECTED</const> state. More...

Protected Member Functions inherited from accessibility::AccessibleContextBase
virtual void SAL_CALL	disposing () override

virtual OUString	CreateAccessibleName ()

void	FireEvent (const css::accessibility::AccessibleEventObject &aEvent)

void	ThrowIfDisposed ()

void	SetAccessibleRole (sal_Int16 _nRole)

Protected Member Functions inherited from accessibility::IAccessibleViewForwarderListener
	~IAccessibleViewForwarderListener ()

Protected Attributes
std::unique_ptr< ChildrenManager >	mpChildrenManager
	Children manager. May be empty if there are no children. More...

css::uno::Reference< css::drawing::XShape >	mxShape
	Reference to the actual shape. More...

AccessibleShapeTreeInfo	maShapeTreeInfo
	Bundle of information passed to all shapes in a document tree. More...

sal_Int32	m_nIndexInParent
	the index in parent. More...

std::unique_ptr< AccessibleTextHelper >	mpText
	The accessible text engine. More...

IAccessibleParent *	mpParent
	This object can be used to modify the child list of our parent. More...

SdrObject *	m_pShape
	This object can be removed when we have an extra interface to ask if the shape is selected. More...

Protected Attributes inherited from accessibility::AccessibleContextBase
sal_Int64	mnStateSet

css::uno::Reference< css::accessibility::XAccessibleRelationSet >	mxRelationSet

Private Member Functions
	AccessibleShape (const AccessibleShape &)=delete

AccessibleShape &	operator= (const AccessibleShape &)=delete

void	UpdateNameAndDescription ()
	Call this method when the title, name, or description of the mxShape member (may) have been changed. More...

Private Attributes
OUString	aAccName

Additional Inherited Members
Public Types inherited from accessibility::AccessibleContextBase
enum	StringOrigin

Public Attributes inherited from accessibility::AccessibleContextBase
	ManuallySet

	FromShape

	AutomaticallyCreated

	NotSet

Detailed Description

This base class provides a base implementation for all shapes.

For more detailed documentation about the methods refer to the descriptions of the implemented interfaces. These are, among others, XAccessible, <type>XAccessibleContext</type>, XAccessibleComponent and XAccessibleExtendedComponent.

The children of a shape can stem from two sources which, in case of SVX and SD shapes, are mutually exclusive. This implementation, however, handles both simultaneously to cope with future extensions or shapes from other projects.

If this shape is a group shape, i.e. a SvxShapeGroup or a <type>Svx3DSceneObject</type>, it can have nested shapes.
If this shape is a descendant from SvxShapeText then the text paragraphs are its children.

Accessible shapes do not listen for disposing() calls of the UNO shapes they make accessible. This is the task of their owner, usually a container, who can then call dispose() at the accessible object.

Definition at line 94 of file AccessibleShape.hxx.

Constructor & Destructor Documentation

◆ AccessibleShape() [1/2]

accessibility::AccessibleShape::AccessibleShape	(	const AccessibleShapeInfo &	rShapeInfo,
		const AccessibleShapeTreeInfo &	rShapeTreeInfo
	)

Create a new accessible object that makes the given shape accessible.

Parameters

rShapeInfo	This object contains all information specific to the new accessible shape. That are e.g. the shape to be made accessible and the accessible object that will become the parent of the new object.
rShapeTreeInfo	Bundle of information passed to this shape and all of its descendants.

Attention: \n: Always call the <member>init</member> method after creating a new accessible shape. This is one way to overcome the potential problem of registering the new object with e.g. event broadcasters. That would delete the new object if a broadcaster would not keep a strong reference to the new object.

Definition at line 96 of file AccessibleShape.cxx.

References SdrObject::getSdrObjectFromXShape(), m_pShape, mpParent, mxParent, mxShape, mxShape, SHAPE, and UpdateNameAndDescription().

◆ ~AccessibleShape()

accessibility::AccessibleShape::~AccessibleShape ( )

overridevirtual

The destructor releases its children manager and text engine if still existent.

These are responsible to send appropriate events.

Definition at line 109 of file AccessibleShape.cxx.

References mpChildrenManager, mpText, and SAL_INFO.

◆ AccessibleShape() [2/2]

accessibility::AccessibleShape::AccessibleShape ( const AccessibleShape & )

privatedelete

Member Function Documentation

◆ acquire()

void SAL_CALL accessibility::AccessibleShape::acquire ( )

overridevirtualnoexcept

Reimplemented in accessibility::AccessibleGraphicShape, and accessibility::AccessibleOLEShape.

Definition at line 723 of file AccessibleShape.cxx.

Referenced by accessibility::AccessibleGraphicShape::acquire(), and accessibility::AccessibleOLEShape::acquire().

◆ addAccessibleEventListener()

void SAL_CALL accessibility::AccessibleShape::addAccessibleEventListener ( const css::uno::Reference< css::accessibility::XAccessibleEventListener > & rxListener )

overridevirtual

This call is forwarded to a) the base class and b) to the accessible edit engine if it is present.

Parameters

rxListener This listener is informed about accessibility events.

Reimplemented from accessibility::AccessibleContextBase.

Definition at line 676 of file AccessibleShape.cxx.

References accessibility::AccessibleContextBase::addAccessibleEventListener(), and mpText.

◆ clearAccessibleSelection()

void SAL_CALL accessibility::AccessibleShape::clearAccessibleSelection ( )

overridevirtual

Definition at line 775 of file AccessibleShape.cxx.

◆ copyText()

sal_Bool SAL_CALL accessibility::AccessibleShape::copyText	(	sal_Int32	nStartIndex,
		sal_Int32	nEndIndex
	)

overridevirtual

Definition at line 1289 of file AccessibleShape.cxx.

◆ CreateAccessibleBaseName()

OUString accessibility::AccessibleShape::CreateAccessibleBaseName ( )

protectedvirtual

Create a base name string that contains the accessible name.

Exceptions

css::uno::RuntimeException

Reimplemented in accessibility::AccessibleControlShape, accessibility::AccessibleGraphicShape, and accessibility::AccessibleOLEShape.

Definition at line 943 of file AccessibleShape.cxx.

References accessibility::ShapeTypeHandler::CreateAccessibleBaseName(), and mxShape.

Referenced by GetFullAccessibleName().

◆ CreateAccessibleName()

OUString accessibility::AccessibleShape::CreateAccessibleName ( )

overrideprotectedvirtual

Create a unique name string that contains the accessible name.

The name consists of the base name and the index.

Reimplemented from accessibility::AccessibleContextBase.

Reimplemented in accessibility::AccessibleControlShape.

Definition at line 949 of file AccessibleShape.cxx.

References GetFullAccessibleName().

Referenced by accessibility::AccessibleControlShape::CreateAccessibleName(), and getAccessibleName().

◆ deselectAccessibleChild()

void SAL_CALL accessibility::AccessibleShape::deselectAccessibleChild ( sal_Int64 nSelectedChildIndex )

overridevirtual

Definition at line 811 of file AccessibleShape.cxx.

◆ disposing() [1/2]

void accessibility::AccessibleShape::disposing ( )

overrideprotectedvirtual

This method is called from the component helper base class while disposing.

Reimplemented from accessibility::AccessibleContextBase.

Reimplemented in accessibility::AccessibleControlShape.

Definition at line 990 of file AccessibleShape.cxx.

References accessibility::AccessibleShapeTreeInfo::dispose(), accessibility::AccessibleShapeTreeInfo::GetModelBroadcaster(), m_aMutex, maShapeTreeInfo, accessibility::AccessibleContextBase::mnStateSet, mpChildrenManager, mpText, and mxShape.

Referenced by accessibility::AccessibleTableShape::disposing().

◆ disposing() [2/2]

void accessibility::AccessibleShape::disposing ( const css::lang::EventObject & Source )

Listen for disposing events of the model.

The accessible shape remains functional when this happens.

References UNO3_GETIMPLEMENTATION_DECL.

◆ getAccessibleAtPoint()

uno::Reference< XAccessible > SAL_CALL accessibility::AccessibleShape::getAccessibleAtPoint ( const css::awt::Point & aPoint )

overridevirtual

The implementation below is at the moment straightforward.

It iterates over all children (and thereby instances all children which have not been already instantiated) until a child covering the specified point is found. This leaves room for improvement. For instance, first iterate only over the already instantiated children and only if no match is found instantiate the remaining ones.

Reimplemented from accessibility::AccessibleComponentBase.

Definition at line 435 of file AccessibleShape.cxx.

References getAccessibleChild(), getAccessibleChildCount(), i, and m_aMutex.

◆ getAccessibleChild()

uno::Reference< XAccessible > SAL_CALL accessibility::AccessibleShape::getAccessibleChild ( sal_Int64 nIndex )

overridevirtual

Return the specified child.

Forward the request to the shape.

Parameters

nIndex Index of the requested child.

Returns: Reference of the requested child which is the accessible object of a visible shape.

Exceptions

IndexOutOfBoundsException Throws an exception if the index is not valid.

Return the requested shape or throw an exception for a wrong index.

Reimplemented from accessibility::AccessibleContextBase.

Reimplemented in accessibility::AccessibleControlShape.

Definition at line 325 of file AccessibleShape.cxx.

References mpChildrenManager, mpText, nIndex, and accessibility::AccessibleContextBase::ThrowIfDisposed().

Referenced by getAccessibleAtPoint(), accessibility::AccessibleControlShape::getAccessibleChild(), getSelectedAccessibleChild(), and isAccessibleChildSelected().

◆ getAccessibleChildCount()

sal_Int64 SAL_CALL accessibility::AccessibleShape::getAccessibleChildCount ( )

overridevirtual

Return the number of currently visible children.

The children of this shape come from two sources: The children from group or scene shapes and the paragraphs of text.

Reimplemented from accessibility::AccessibleContextBase.

Reimplemented in accessibility::AccessibleControlShape.

Definition at line 301 of file AccessibleShape.cxx.

References accessibility::AccessibleContextBase::IsDisposed(), mpChildrenManager, and mpText.

Referenced by getAccessibleAtPoint(), accessibility::AccessibleControlShape::getAccessibleChildCount(), getSelectedAccessibleChild(), and getSelectedAccessibleChildCount().

◆ getAccessibleDescription()

OUString SAL_CALL accessibility::AccessibleShape::getAccessibleDescription ( )

overridevirtual

Reimplemented from accessibility::AccessibleContextBase.

Definition at line 287 of file AccessibleShape.cxx.

References SdrObject::GetDescription(), m_pShape, and accessibility::AccessibleContextBase::ThrowIfDisposed().

Referenced by accessibility::AccessibleGraphicShape::getAccessibleImageDescription().

◆ getAccessibleIndexInParent()

sal_Int64 SAL_CALL accessibility::AccessibleShape::getAccessibleIndexInParent ( )

overridevirtual

Return this objects index among the parents children.

Reimplemented from accessibility::AccessibleContextBase.

Definition at line 1025 of file AccessibleShape.cxx.

References accessibility::AccessibleContextBase::getAccessibleIndexInParent(), m_nIndexInParent, nIndex, and accessibility::AccessibleContextBase::ThrowIfDisposed().

◆ getAccessibleName()

OUString SAL_CALL accessibility::AccessibleShape::getAccessibleName ( )

overridevirtual

Reimplemented from accessibility::AccessibleContextBase.

Definition at line 278 of file AccessibleShape.cxx.

References CreateAccessibleName(), SdrObject::GetTitle(), m_pShape, and accessibility::AccessibleContextBase::ThrowIfDisposed().

◆ getAccessibleRelationSet()

uno::Reference< XAccessibleRelationSet > SAL_CALL accessibility::AccessibleShape::getAccessibleRelationSet ( )

overridevirtual

Reimplemented from accessibility::AccessibleContextBase.

Reimplemented in accessibility::AccessibleControlShape.

Definition at line 354 of file AccessibleShape.cxx.

References accessibility::IAccessibleParent::GetAccessibleCaption(), m_aMutex, mpParent, and mxShape.

◆ getAccessibleRole()

sal_Int16 SAL_CALL accessibility::AccessibleShape::getAccessibleRole ( )

overridevirtual

Return this object's role.

Reimplemented from accessibility::AccessibleContextBase.

Definition at line 1069 of file AccessibleShape.cxx.

References accessibility::DRAWING_GRAPHIC_OBJECT, accessibility::DRAWING_OLE, accessibility::AccessibleContextBase::getAccessibleRole(), accessibility::ShapeTypeHandler::Instance(), and mxShape.

Referenced by accessibility::AccessibleControlShape::CreateAccessibleName(), accessibility::AccessibleControlShape::getAccessibleRelationSet(), getExtendedAttributes(), and accessibility::ChildrenManagerImpl::UpdateSelection().

◆ getAccessibleStateSet()

sal_Int64 SAL_CALL accessibility::AccessibleShape::getAccessibleStateSet ( )

overridevirtual

Return the set of current states.

Return a copy of the state set.

Possible states are: ENABLED SHOWING VISIBLE

Reimplemented from accessibility::AccessibleContextBase.

Definition at line 379 of file AccessibleShape.cxx.

References accessibility::AccessibleContextBase::getAccessibleStateSet(), accessibility::AccessibleContextBase::IsDisposed(), m_aMutex, accessibility::AccessibleContextBase::mnStateSet, and mpText.

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

◆ getBackground()

sal_Int32 SAL_CALL accessibility::AccessibleShape::getBackground ( )

overridevirtual

Reimplemented from accessibility::AccessibleComponentBase.

Definition at line 639 of file AccessibleShape.cxx.

References mxShape, Color::SetAlpha(), and accessibility::AccessibleContextBase::ThrowIfDisposed().

◆ getBounds()

awt::Rectangle SAL_CALL accessibility::AccessibleShape::getBounds ( )

overridevirtual

◆ getCaretPosition()

sal_Int32 SAL_CALL accessibility::AccessibleShape::getCaretPosition ( )

overridevirtual

Definition at line 1254 of file AccessibleShape.cxx.

◆ getCharacter()

sal_Unicode SAL_CALL accessibility::AccessibleShape::getCharacter ( sal_Int32 nIndex )

overridevirtual

Definition at line 1256 of file AccessibleShape.cxx.

◆ getCharacterAttributes()

css::uno::Sequence< css::beans::PropertyValue > SAL_CALL accessibility::AccessibleShape::getCharacterAttributes	(	sal_Int32	nIndex,
		const css::uno::Sequence< OUString > &	aRequestedAttributes
	)

overridevirtual

Definition at line 1257 of file AccessibleShape.cxx.

◆ getCharacterBounds()

css::awt::Rectangle SAL_CALL accessibility::AccessibleShape::getCharacterBounds ( sal_Int32 nIndex )

overridevirtual

Definition at line 1262 of file AccessibleShape.cxx.

◆ getCharacterCount()

sal_Int32 SAL_CALL accessibility::AccessibleShape::getCharacterCount ( )

overridevirtual

Definition at line 1266 of file AccessibleShape.cxx.

◆ getExtendedAttributes()

uno::Any SAL_CALL accessibility::AccessibleShape::getExtendedAttributes ( )

overridevirtual

Reimplemented in accessibility::AccessibleOLEShape.

Definition at line 817 of file AccessibleShape.cxx.

References getAccessibleRole(), GetStyle(), and m_pShape.

◆ getForeground()

sal_Int32 SAL_CALL accessibility::AccessibleShape::getForeground ( )

overridevirtual

Reimplemented from accessibility::AccessibleComponentBase.

Definition at line 616 of file AccessibleShape.cxx.

References mxShape, and accessibility::AccessibleContextBase::ThrowIfDisposed().

◆ GetFullAccessibleName()

OUString accessibility::AccessibleShape::GetFullAccessibleName ( AccessibleShape * shape )

protected

Exceptions

css::uno::RuntimeException

Definition at line 954 of file AccessibleShape.cxx.

References aAccName, accessibility::AccessibleContextBase::CommitChange(), CreateAccessibleBaseName(), SdrObject::GetName(), m_pShape, and sName.

Referenced by CreateAccessibleName().

◆ getGroupPosition()

uno::Sequence< sal_Int32 > SAL_CALL accessibility::AccessibleShape::getGroupPosition ( const css::uno::Any & rAny )

overridevirtual

Definition at line 1109 of file AccessibleShape.cxx.

References accessibility::AccessibleContextBase::getAccessibleContext(), accessibility::AccessibleContextBase::getAccessibleParent(), SdrObjList::GetObj(), SdrObjList::GetObjCount(), SdrObject::getParentSdrObjectFromSdrObject(), SdrObject::getSdrObjectFromXShape(), SdrObject::GetSubList(), GetXShapeForSdrObject(), i, mxShape, and nPos.

◆ getHyperLink()

uno::Reference< XAccessibleHyperlink > SAL_CALL accessibility::AccessibleShape::getHyperLink ( sal_Int32 nLinkIndex )

overridevirtual

Definition at line 1235 of file AccessibleShape.cxx.

◆ getHyperLinkCount()

sal_Int32 SAL_CALL accessibility::AccessibleShape::getHyperLinkCount ( )

overridevirtual

Definition at line 1220 of file AccessibleShape.cxx.

◆ getHyperLinkIndex()

sal_Int32 SAL_CALL accessibility::AccessibleShape::getHyperLinkIndex ( sal_Int32 nCharIndex )

overridevirtual

Definition at line 1249 of file AccessibleShape.cxx.

◆ getImplementationName()

OUString SAL_CALL accessibility::AccessibleShape::getImplementationName ( )

overridevirtual

Returns an identifier for the implementation of this object.

Reimplemented from accessibility::AccessibleContextBase.

Reimplemented in accessibility::AccessibleControlShape, accessibility::AccessibleGraphicShape, and accessibility::AccessibleOLEShape.

Definition at line 833 of file AccessibleShape.cxx.

◆ getIndexAtPoint()

sal_Int32 SAL_CALL accessibility::AccessibleShape::getIndexAtPoint ( const css::awt::Point & aPoint )

overridevirtual

Definition at line 1267 of file AccessibleShape.cxx.

◆ getLocation()

awt::Point SAL_CALL accessibility::AccessibleShape::getLocation ( )

overridevirtual

Reimplemented from accessibility::AccessibleComponentBase.

Definition at line 578 of file AccessibleShape.cxx.

References getBounds(), and accessibility::AccessibleContextBase::ThrowIfDisposed().

Referenced by getLocationOnScreen().

◆ getLocationOnScreen()

awt::Point SAL_CALL accessibility::AccessibleShape::getLocationOnScreen ( )

overridevirtual

Reimplemented from accessibility::AccessibleComponentBase.

Definition at line 586 of file AccessibleShape.cxx.

References accessibility::AccessibleContextBase::getAccessibleParent(), getLocation(), SAL_WARN, and accessibility::AccessibleContextBase::ThrowIfDisposed().

◆ getObjectLink()

OUString accessibility::AccessibleShape::getObjectLink ( const css::uno::Any & accoject )

overridevirtual

Definition at line 1199 of file AccessibleShape.cxx.

References accessibility::AccessibleContextBase::getAccessibleContext(), accessibility::AccessibleShapeTreeInfo::GetDocumentWindow(), SdrObject::getSdrObjectFromXShape(), maShapeTreeInfo, and mxShape.

◆ getSelectedAccessibleChild()

Reference< XAccessible > SAL_CALL accessibility::AccessibleShape::getSelectedAccessibleChild ( sal_Int64 nSelectedChildIndex )

overridevirtual

Definition at line 796 of file AccessibleShape.cxx.

References getAccessibleChild(), getAccessibleChildCount(), getSelectedAccessibleChildCount(), and isAccessibleChildSelected().

◆ getSelectedAccessibleChildCount()

sal_Int64 SAL_CALL accessibility::AccessibleShape::getSelectedAccessibleChildCount ( )

overridevirtual

Definition at line 785 of file AccessibleShape.cxx.

References getAccessibleChildCount(), i, isAccessibleChildSelected(), and nCount.

Referenced by getSelectedAccessibleChild().

◆ getSelectedText()

OUString SAL_CALL accessibility::AccessibleShape::getSelectedText ( )

overridevirtual

Definition at line 1268 of file AccessibleShape.cxx.

◆ getSelectionEnd()

sal_Int32 SAL_CALL accessibility::AccessibleShape::getSelectionEnd ( )

overridevirtual

Definition at line 1270 of file AccessibleShape.cxx.

◆ getSelectionStart()

sal_Int32 SAL_CALL accessibility::AccessibleShape::getSelectionStart ( )

overridevirtual

Definition at line 1269 of file AccessibleShape.cxx.

◆ getSize()

awt::Size SAL_CALL accessibility::AccessibleShape::getSize ( )

overridevirtual

Reimplemented from accessibility::AccessibleComponentBase.

Definition at line 608 of file AccessibleShape.cxx.

References getBounds(), and accessibility::AccessibleContextBase::ThrowIfDisposed().

Referenced by accessibility::AccessibleGraphicShape::getAccessibleImageHeight(), and accessibility::AccessibleGraphicShape::getAccessibleImageWidth().

◆ GetState()

bool accessibility::AccessibleShape::GetState ( sal_Int64 aState )

Return the state of the specified state.

Take the <const>FOCUSED</const> state from the accessible edit engine.

Parameters

aState The state for which to return its value.

Returns: A value of <TRUE> indicates that the state is set. A <FALSE> value indicates an unset state or the inability to access the entity that manages the state set.

Definition at line 265 of file AccessibleShape.cxx.

References accessibility::AccessibleContextBase::GetState(), and mpText.

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

◆ GetStyle()

OUString accessibility::AccessibleShape::GetStyle ( ) const

protectedvirtual

Definition at line 222 of file AccessibleShape.cxx.

References accessibility::ShapeTypeHandler::CreateAccessibleBaseName(), and mxShape.

Referenced by getExtendedAttributes().

◆ getSupportedServiceNames()

uno::Sequence< OUString > SAL_CALL accessibility::AccessibleShape::getSupportedServiceNames ( )

overridevirtual

Reimplemented from accessibility::AccessibleContextBase.

Reimplemented in accessibility::AccessibleGraphicShape, and accessibility::AccessibleOLEShape.

Definition at line 840 of file AccessibleShape.cxx.

References comphelper::concatSequences(), accessibility::AccessibleContextBase::getSupportedServiceNames(), and accessibility::AccessibleContextBase::ThrowIfDisposed().

Referenced by accessibility::AccessibleGraphicShape::getSupportedServiceNames(), and accessibility::AccessibleOLEShape::getSupportedServiceNames().

◆ getText()

OUString SAL_CALL accessibility::AccessibleShape::getText ( )

overridevirtual

Definition at line 1272 of file AccessibleShape.cxx.

◆ getTextAtIndex()

css::accessibility::TextSegment SAL_CALL accessibility::AccessibleShape::getTextAtIndex	(	sal_Int32	nIndex,
		sal_Int16	aTextType
	)

overridevirtual

Definition at line 1274 of file AccessibleShape.cxx.

◆ getTextBeforeIndex()

css::accessibility::TextSegment SAL_CALL accessibility::AccessibleShape::getTextBeforeIndex	(	sal_Int32	nIndex,
		sal_Int16	aTextType
	)

overridevirtual

Definition at line 1279 of file AccessibleShape.cxx.

◆ getTextBehindIndex()

css::accessibility::TextSegment SAL_CALL accessibility::AccessibleShape::getTextBehindIndex	(	sal_Int32	nIndex,
		sal_Int16	aTextType
	)

overridevirtual

Definition at line 1284 of file AccessibleShape.cxx.

◆ getTextRange()

OUString SAL_CALL accessibility::AccessibleShape::getTextRange	(	sal_Int32	nStartIndex,
		sal_Int32	nEndIndex
	)

overridevirtual

Definition at line 1273 of file AccessibleShape.cxx.

◆ getTypes()

uno::Sequence< uno::Type > SAL_CALL accessibility::AccessibleShape::getTypes ( )

overridevirtual

Reimplemented from accessibility::AccessibleComponentBase.

Reimplemented in accessibility::AccessibleGraphicShape, and accessibility::AccessibleOLEShape.

Definition at line 849 of file AccessibleShape.cxx.

References comphelper::concatSequences(), cppu::UnoType< typename T >::get(), accessibility::AccessibleComponentBase::getTypes(), and accessibility::AccessibleContextBase::ThrowIfDisposed().

Referenced by accessibility::AccessibleGraphicShape::getTypes(), and accessibility::AccessibleOLEShape::getTypes().

◆ GetXShape()

const css::uno::Reference< css::drawing::XShape > & accessibility::AccessibleShape::GetXShape ( ) const

inline

Definition at line 357 of file AccessibleShape.hxx.

References mxShape.

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

◆ Init()

void accessibility::AccessibleShape::Init ( void )

virtual

Initialize a new shape.

See the documentation of the constructor for the reason of this method's existence.

Reimplemented in accessibility::AccessibleControlShape.

Definition at line 120 of file AccessibleShape.cxx.

References SdrTextObj::CanCreateEditOutlinerParaObject(), DynCastSdrTextObj(), accessibility::AccessibleShapeTreeInfo::GetModelBroadcaster(), vcl::Window::GetOutDev(), SdrObject::GetOutlinerParaObject(), SdrObject::getSdrObjectFromXShape(), accessibility::AccessibleShapeTreeInfo::GetSdrView(), accessibility::AccessibleShapeTreeInfo::GetWindow(), vcl::Window::HasFocus(), maShapeTreeInfo, mpChildrenManager, mpText, mxShape, and UpdateStates().

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

◆ isAccessibleChildSelected()

sal_Bool SAL_CALL accessibility::AccessibleShape::isAccessibleChildSelected ( sal_Int64 nChildIndex )

overridevirtual

Definition at line 743 of file AccessibleShape.cxx.

References getAccessibleChild().

Referenced by getSelectedAccessibleChild(), and getSelectedAccessibleChildCount().

◆ notifyShapeEvent()

void SAL_CALL accessibility::AccessibleShape::notifyShapeEvent ( const css::document::EventObject & rEventObject )

overridevirtual

Definition at line 898 of file AccessibleShape.cxx.

References accessibility::AccessibleContextBase::CommitChange(), mpText, and UpdateNameAndDescription().

◆ operator=()

AccessibleShape & accessibility::AccessibleShape::operator= ( const AccessibleShape & )

privatedelete

◆ queryInterface()

css::uno::Any SAL_CALL accessibility::AccessibleShape::queryInterface ( const css::uno::Type & rType )

overridevirtual

Reimplemented in accessibility::AccessibleGraphicShape, and accessibility::AccessibleOLEShape.

Definition at line 704 of file AccessibleShape.cxx.

Referenced by accessibility::AccessibleGraphicShape::queryInterface(), and accessibility::AccessibleOLEShape::queryInterface().

◆ release()

void SAL_CALL accessibility::AccessibleShape::release ( )

overridevirtualnoexcept

Reimplemented in accessibility::AccessibleGraphicShape, and accessibility::AccessibleOLEShape.

Definition at line 731 of file AccessibleShape.cxx.

Referenced by accessibility::AccessibleGraphicShape::release(), and accessibility::AccessibleOLEShape::release().

◆ removeAccessibleEventListener()

void SAL_CALL accessibility::AccessibleShape::removeAccessibleEventListener ( const css::uno::Reference< css::accessibility::XAccessibleEventListener > & rxListener )

overridevirtual

This call is forwarded to a) the base class and b) to the accessible edit engine if it is present.

Parameters

rxListener This listener will not be informed about accessibility events anymore.

Reimplemented from accessibility::AccessibleContextBase.

Definition at line 694 of file AccessibleShape.cxx.

References mpText, and accessibility::AccessibleContextBase::removeAccessibleEventListener().

◆ ResetState()

bool accessibility::AccessibleShape::ResetState ( sal_Int64 aState )

overridevirtual

Reset the specified state.

If the state is <const>FOCUSED</const> then, additionally to the inherited functionality, the focus listeners registered with the XAccessibleComponent interface are called (if that state really changes).

Parameters

aState The state to turn off.

Returns: The returned flag indicates whether the specified state has been changed (<TRUE>), i.e. it has formerly been set.

Reimplemented from accessibility::AccessibleContextBase.

Definition at line 246 of file AccessibleShape.cxx.

References mpText, and accessibility::AccessibleContextBase::ResetState().

Referenced by accessibility::AccessibleControlShape::notifyEvent(), accessibility::ChildrenManagerImpl::RemoveFocus(), accessibility::ChildrenManagerImpl::RemoveNonVisibleChildren(), accessibility::AccessibleTableShape::ResetState(), and accessibility::ChildrenManagerImpl::UpdateSelection().

◆ scrollSubstringTo()

sal_Bool SAL_CALL accessibility::AccessibleShape::scrollSubstringTo	(	sal_Int32	nStartIndex,
		sal_Int32	nEndIndex,
		css::accessibility::AccessibleScrollType	aScrollType
	)

overridevirtual

Definition at line 1290 of file AccessibleShape.cxx.

◆ selectAccessibleChild()

void SAL_CALL accessibility::AccessibleShape::selectAccessibleChild ( sal_Int64 nChildIndex )

overridevirtual

Definition at line 738 of file AccessibleShape.cxx.

◆ selectAllAccessibleChildren()

void SAL_CALL accessibility::AccessibleShape::selectAllAccessibleChildren ( )

overridevirtual

Definition at line 780 of file AccessibleShape.cxx.

◆ setCaretPosition()

sal_Bool SAL_CALL accessibility::AccessibleShape::setCaretPosition ( sal_Int32 nIndex )

overridevirtual

Definition at line 1255 of file AccessibleShape.cxx.

◆ setIndexInParent()

void accessibility::AccessibleShape::setIndexInParent ( sal_Int32 _nIndex )

inline

set the index _nIndex at the accessible shape

Parameters

_nIndex The new index in parent.

Definition at line 363 of file AccessibleShape.hxx.

Referenced by accessibility::ChildDescriptor::setIndexAtAccessibleShape().

◆ setSelection()

sal_Bool SAL_CALL accessibility::AccessibleShape::setSelection	(	sal_Int32	nStartIndex,
		sal_Int32	nEndIndex
	)

overridevirtual

Definition at line 1271 of file AccessibleShape.cxx.

◆ SetState()

bool accessibility::AccessibleShape::SetState ( sal_Int64 aState )

overridevirtual

Set the specified state.

If the state is <const>FOCUSED</const> then, additionally to the inherited functionality, the focus listeners registered with the XAccessibleComponent interface are called (if that state really changes).

Parameters

aState The state to turn on.

Returns: The returned flag indicates whether the specified state has been changed (<TRUE>), i.e. it has formerly not been set.

Reimplemented from accessibility::AccessibleContextBase.

Reimplemented in accessibility::AccessibleControlShape.

Definition at line 227 of file AccessibleShape.cxx.

References mpText, and accessibility::AccessibleContextBase::SetState().

Referenced by accessibility::ChildDescriptor::ChildDescriptor(), accessibility::AccessibleControlShape::notifyEvent(), accessibility::AccessibleControlShape::SetState(), accessibility::AccessibleTableShape::SetState(), and accessibility::ChildrenManagerImpl::UpdateSelection().

◆ UpdateNameAndDescription()

void accessibility::AccessibleShape::UpdateNameAndDescription ( )

private

Call this method when the title, name, or description of the mxShape member (may) have been changed.

This method adapts the name and description members of the AccessibleContextBase base class.

Definition at line 1037 of file AccessibleShape.cxx.

References accessibility::AccessibleContextBase::FromShape, mxShape, accessibility::AccessibleContextBase::SetAccessibleDescription(), and accessibility::AccessibleContextBase::SetAccessibleName().

Referenced by AccessibleShape(), and notifyShapeEvent().

◆ UpdateStates()

void accessibility::AccessibleShape::UpdateStates ( )

protected

Update the <const>OPAQUE</const> and <const>SELECTED</const> state.

Definition at line 176 of file AccessibleShape.cxx.

References accessibility::DRAWING_PAGE, accessibility::DRAWING_RECTANGLE, accessibility::DRAWING_TEXT, accessibility::AccessibleShapeTreeInfo::GetSdrView(), accessibility::ShapeTypeHandler::Instance(), SdrMarkView::IsObjMarked(), m_pShape, maShapeTreeInfo, accessibility::AccessibleContextBase::mnStateSet, and mxShape.

Referenced by Init().

◆ ViewForwarderChanged()

void accessibility::AccessibleShape::ViewForwarderChanged ( )

overridevirtual

This method is called to indicate a change of the specified view forwarder, specifically, a change in visible area.

Implements accessibility::IAccessibleViewForwarderListener.

Definition at line 924 of file AccessibleShape.cxx.

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

Member Data Documentation

◆ aAccName

OUString accessibility::AccessibleShape::aAccName

private

Definition at line 423 of file AccessibleShape.hxx.

Referenced by GetFullAccessibleName().

◆ m_nIndexInParent

sal_Int32 accessibility::AccessibleShape::m_nIndexInParent

protected

the index in parent.

Definition at line 379 of file AccessibleShape.hxx.

Referenced by getAccessibleIndexInParent().

◆ m_pShape

SdrObject* accessibility::AccessibleShape::m_pShape

protected

This object can be removed when we have an extra interface to ask if the shape is selected.

Definition at line 391 of file AccessibleShape.hxx.

Referenced by AccessibleShape(), getAccessibleDescription(), accessibility::AccessibleGraphicShape::getAccessibleImageDescription(), getAccessibleName(), accessibility::AccessibleOLEShape::getExtendedAttributes(), getExtendedAttributes(), GetFullAccessibleName(), and UpdateStates().

◆ maShapeTreeInfo

AccessibleShapeTreeInfo accessibility::AccessibleShape::maShapeTreeInfo

protected

Bundle of information passed to all shapes in a document tree.

Definition at line 375 of file AccessibleShape.hxx.

Referenced by disposing(), accessibility::AccessibleControlShape::elementInserted(), getBounds(), getObjectLink(), Init(), accessibility::AccessibleControlShape::Init(), accessibility::AccessibleControlShape::modeChanged(), and UpdateStates().

◆ mpChildrenManager

std::unique_ptr<ChildrenManager> accessibility::AccessibleShape::mpChildrenManager

protected

Children manager. May be empty if there are no children.

Definition at line 367 of file AccessibleShape.hxx.

Referenced by disposing(), getAccessibleChild(), getAccessibleChildCount(), Init(), and ~AccessibleShape().

◆ mpParent

IAccessibleParent* accessibility::AccessibleShape::mpParent

protected

This object can be used to modify the child list of our parent.

Definition at line 387 of file AccessibleShape.hxx.

Referenced by accessibility::AccessibleControlShape::elementInserted(), getAccessibleRelationSet(), accessibility::AccessibleControlShape::GetLabeledByControlShape(), and accessibility::AccessibleControlShape::modeChanged().

◆ mpText

std::unique_ptr<AccessibleTextHelper> accessibility::AccessibleShape::mpText

protected

The accessible text engine.

May be NULL if it can not be created.

Definition at line 383 of file AccessibleShape.hxx.

Referenced by addAccessibleEventListener(), disposing(), getAccessibleChild(), getAccessibleChildCount(), getAccessibleStateSet(), GetState(), Init(), notifyShapeEvent(), removeAccessibleEventListener(), ResetState(), SetState(), and ~AccessibleShape().

◆ mxShape

css::uno::Reference< css::drawing::XShape> accessibility::AccessibleShape::mxShape

protected

Reference to the actual shape.

Definition at line 371 of file AccessibleShape.hxx.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AccessibleShape() [1/2]

◆ ~AccessibleShape()

◆ AccessibleShape() [2/2]

Member Function Documentation

◆ acquire()

◆ addAccessibleEventListener()

◆ clearAccessibleSelection()

◆ copyText()

◆ CreateAccessibleBaseName()

◆ CreateAccessibleName()

◆ deselectAccessibleChild()

◆ disposing() [1/2]

◆ disposing() [2/2]

◆ getAccessibleAtPoint()

◆ getAccessibleChild()

◆ getAccessibleChildCount()

◆ getAccessibleDescription()

◆ getAccessibleIndexInParent()

◆ getAccessibleName()

◆ getAccessibleRelationSet()

◆ getAccessibleRole()

◆ getAccessibleStateSet()

◆ getBackground()

◆ getBounds()

◆ getCaretPosition()

◆ getCharacter()

◆ getCharacterAttributes()

◆ getCharacterBounds()

◆ getCharacterCount()

◆ getExtendedAttributes()

◆ getForeground()

◆ GetFullAccessibleName()

◆ getGroupPosition()

◆ getHyperLink()

◆ getHyperLinkCount()

◆ getHyperLinkIndex()

◆ getImplementationName()

◆ getIndexAtPoint()

◆ getLocation()

◆ getLocationOnScreen()

◆ getObjectLink()

◆ getSelectedAccessibleChild()

◆ getSelectedAccessibleChildCount()

◆ getSelectedText()

◆ getSelectionEnd()

◆ getSelectionStart()

◆ getSize()

◆ GetState()

◆ GetStyle()

◆ getSupportedServiceNames()

◆ getText()

◆ getTextAtIndex()

◆ getTextBeforeIndex()

◆ getTextBehindIndex()

◆ getTextRange()

◆ getTypes()

◆ GetXShape()

◆ Init()

◆ isAccessibleChildSelected()

◆ notifyShapeEvent()

◆ operator=()

◆ queryInterface()

◆ release()

◆ removeAccessibleEventListener()

◆ ResetState()

◆ scrollSubstringTo()

◆ selectAccessibleChild()

◆ selectAllAccessibleChildren()

◆ setCaretPosition()

◆ setIndexInParent()

◆ setSelection()

◆ SetState()