The GridControl accessible objects inherit from this base class. More...

#include <AccessibleGridControlBase.hxx>

Inheritance diagram for accessibility::AccessibleGridControlBase:

Collaboration diagram for accessibility::AccessibleGridControlBase:

Public Member Functions
	AccessibleGridControlBase (css::uno::Reference< css::accessibility::XAccessible > xParent, ::vcl::table::IAccessibleTable &rTable, ::vcl::table::AccessibleTableControlObjType eObjType)
	Constructor. More...

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

virtual sal_Int64 SAL_CALL	getAccessibleIndexInParent () 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 sal_Int16 SAL_CALL	getAccessibleRole () override

virtual sal_Bool SAL_CALL	containsPoint (const css::awt::Point &rPoint) 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 sal_Int32 SAL_CALL	getForeground () override

virtual sal_Int32 SAL_CALL	getBackground () override

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

virtual void SAL_CALL	addAccessibleEventListener (const css::uno::Reference< css::accessibility::XAccessibleEventListener > &rxListener) override
	Adds a new event listener. More...

virtual void SAL_CALL	removeAccessibleEventListener (const css::uno::Reference< css::accessibility::XAccessibleEventListener > &rxListener) override
	Removes an event listener. More...

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

virtual sal_Bool SAL_CALL	supportsService (const OUString &rServiceName) override

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

inline ::vcl::table::AccessibleTableControlObjType	getType () const

virtual void	commitEvent (sal_Int16 nEventId, const css::uno::Any &rNewValue, const css::uno::Any &rOldValue)
	Commits an event to all listeners. More...

bool	isAlive () const

Protected Member Functions
virtual	~AccessibleGridControlBase () override

virtual void SAL_CALL	disposing () override
	Commits DeFunc event to listeners and cleans up members. More...

bool	implIsShowing ()
	Determines whether the Grid control is really showing inside of its parent accessible window. More...

virtual tools::Rectangle	implGetBoundingBox ()=0
	Derived classes return the bounding box relative to the parent window. More...

virtual tools::Rectangle	implGetBoundingBoxOnScreen ()=0
	‍** Derived classes return the bounding box in screen coordinates. More...

virtual sal_Int64	implCreateStateSet ()
	Creates a bitset of states of the current object. More...

void	ensureIsAlive () const

tools::Rectangle	getBoundingBox ()
	Locks all mutex's and calculates the bounding box relative to the parent window. More...

tools::Rectangle	getBoundingBoxOnScreen ()
	‍** Locks all mutex's and calculates the bounding box in screen More...

::comphelper::AccessibleEventNotifier::TClientId	getClientId () const

void	setClientId (::comphelper::AccessibleEventNotifier::TClientId _aNewClientId)

Protected Attributes
css::uno::Reference< css::accessibility::XAccessible >	m_xParent
	The parent accessible object. More...

::vcl::table::IAccessibleTable &	m_aTable
	The SVT Table control. More...

::vcl::table::AccessibleTableControlObjType	m_eObjType
	The type of this object (for names, descriptions, state sets, ...). More...

Protected Attributes inherited from cppu::BaseMutex
mutable::osl::Mutex	m_aMutex

Private Attributes
::comphelper::AccessibleEventNotifier::TClientId	m_aClientId

Detailed Description

The GridControl accessible objects inherit from this base class.

It implements basic functionality for various Accessibility interfaces and the event broadcaster and contains the osl::Mutex.

Definition at line 54 of file AccessibleGridControlBase.hxx.

Constructor & Destructor Documentation

◆ AccessibleGridControlBase()

accessibility::AccessibleGridControlBase::AccessibleGridControlBase	(	css::uno::Reference< css::accessibility::XAccessible >	xParent,
		::vcl::table::IAccessibleTable &	rTable,
		::vcl::table::AccessibleTableControlObjType	eObjType
	)

Constructor.

Parameters

rxParent	XAccessible interface of the parent object.
rTable	The Table control.
eObjType	Type of accessible table control.

Definition at line 50 of file AccessibleGridControlBase.cxx.

References m_aMutex.

◆ ~AccessibleGridControlBase()

accessibility::AccessibleGridControlBase::~AccessibleGridControlBase ( )

overrideprotectedvirtual

Definition at line 62 of file AccessibleGridControlBase.cxx.

References dispose(), isAlive(), and m_refCount.

Member Function Documentation

◆ addAccessibleEventListener()

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

overridevirtual

Adds a new event listener.

Definition at line 211 of file AccessibleGridControlBase.cxx.

References comphelper::AccessibleEventNotifier::addEventListener(), getClientId(), comphelper::AccessibleEventNotifier::registerClient(), and setClientId().

◆ commitEvent()

void accessibility::AccessibleGridControlBase::commitEvent	(	sal_Int16	nEventId,
		const css::uno::Any &	rNewValue,
		const css::uno::Any &	rOldValue
	)

virtual

Commits an event to all listeners.

Reimplemented in accessibility::AccessibleGridControlTable.

Definition at line 336 of file AccessibleGridControlBase.cxx.

References comphelper::AccessibleEventNotifier::addEvent(), aEvent, and getClientId().

Referenced by accessibility::AccessibleGridControl::commitCellEvent(), accessibility::AccessibleGridControlAccess::commitEvent(), and accessibility::AccessibleGridControlTable::commitEvent().

◆ containsPoint()

sal_Bool SAL_CALL accessibility::AccessibleGridControlBase::containsPoint ( const css::awt::Point & rPoint )

overridevirtual

Returns: TRUE, if the point lies within the bounding box of this object.

Definition at line 184 of file AccessibleGridControlBase.cxx.

References tools::Rectangle::Contains(), getBoundingBox(), and VCLPoint().

◆ disposing()

void SAL_CALL accessibility::AccessibleGridControlBase::disposing ( )

overrideprotectedvirtual

Commits DeFunc event to listeners and cleans up members.

Reimplemented in accessibility::AccessibleGridControl, and accessibility::AccessibleGridControl.

Definition at line 72 of file AccessibleGridControlBase.cxx.

References getClientId(), m_xParent, nId, comphelper::AccessibleEventNotifier::revokeClientNotifyDisposing(), and setClientId().

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

◆ ensureIsAlive()

void accessibility::AccessibleGridControlBase::ensureIsAlive ( ) const

protected

Exceptions

<type>DisposedException</type> If the object is not alive.

Definition at line 306 of file AccessibleGridControlBase.cxx.

References isAlive().

◆ getAccessibleAtPoint()

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

overridevirtual

Returns: The accessible child rendered under the given point.

Reimplemented in accessibility::AccessibleGridControl, accessibility::AccessibleGridControlHeader, and accessibility::AccessibleGridControlTable.

Definition at line 381 of file AccessibleGridControlBase.cxx.

◆ getAccessibleDescription()

OUString SAL_CALL accessibility::AccessibleGridControlBase::getAccessibleDescription ( )

overridevirtual

Returns: The description of this object.

Definition at line 132 of file AccessibleGridControlBase.cxx.

References ensureIsAlive(), vcl::table::IAccessibleTable::GetAccessibleObjectDescription(), m_aTable, and m_eObjType.

◆ getAccessibleIndexInParent()

sal_Int64 SAL_CALL accessibility::AccessibleGridControlBase::getAccessibleIndexInParent ( )

overridevirtual

Returns: The index of this object among the parent's children.

Reimplemented in accessibility::AccessibleGridControlHeader, accessibility::AccessibleGridControlHeaderCell, accessibility::AccessibleGridControlTable, and accessibility::AccessibleGridControlTableCell.

Definition at line 97 of file AccessibleGridControlBase.cxx.

References ensureIsAlive(), and m_xParent.

◆ getAccessibleName()

OUString SAL_CALL accessibility::AccessibleGridControlBase::getAccessibleName ( )

overridevirtual

Returns: The name of this object.

Reimplemented in accessibility::AccessibleGridControlCell.

Definition at line 140 of file AccessibleGridControlBase.cxx.

References ensureIsAlive(), vcl::table::IAccessibleTable::GetAccessibleObjectName(), m_aTable, and m_eObjType.

◆ getAccessibleParent()

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

overridevirtual

Returns: A reference to the parent accessible object.

Definition at line 89 of file AccessibleGridControlBase.cxx.

References ensureIsAlive(), and m_xParent.

◆ getAccessibleRelationSet()

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

overridevirtual

Returns: The relation set (the GridControl does not have one).

Definition at line 149 of file AccessibleGridControlBase.cxx.

References ensureIsAlive().

◆ getAccessibleRole()

sal_Int16 SAL_CALL accessibility::AccessibleGridControlBase::getAccessibleRole ( )

overridevirtual

Returns: The role of this object. Panel, ROWHEADER, COLUMNHEADER, TABLE, TABLE_CELL are supported.

Reimplemented in accessibility::AccessibleGridControl, and accessibility::AccessibleGridControlTableBase.

Definition at line 354 of file AccessibleGridControlBase.cxx.

References ensureIsAlive(), m_eObjType, TCTYPE_COLUMNHEADERBAR, TCTYPE_COLUMNHEADERCELL, TCTYPE_GRIDCONTROL, TCTYPE_ROWHEADERBAR, TCTYPE_ROWHEADERCELL, TCTYPE_TABLE, and TCTYPE_TABLECELL.

◆ getAccessibleStateSet()

sal_Int64 SAL_CALL accessibility::AccessibleGridControlBase::getAccessibleStateSet ( )

overridevirtual

Returns: The set of current states.

Definition at line 159 of file AccessibleGridControlBase.cxx.

References implCreateStateSet().

◆ getBackground()

sal_Int32 SAL_CALL accessibility::AccessibleGridControlBase::getBackground ( )

overridevirtual

Definition at line 411 of file AccessibleGridControlBase.cxx.

References ensureIsAlive(), vcl::Window::GetBackground(), Wallpaper::GetColor(), vcl::Window::GetControlBackground(), vcl::table::IAccessibleTable::GetWindowInstance(), vcl::Window::IsControlBackground(), and m_aTable.

◆ getBoundingBox()

tools::Rectangle accessibility::AccessibleGridControlBase::getBoundingBox ( )

protected

Locks all mutex's and calculates the bounding box relative to the parent window.

Returns: The bounding box (VCL rect.) relative to the parent object.

Exceptions

css::lang::DisposedException

Definition at line 312 of file AccessibleGridControlBase.cxx.

References tools::Rectangle::Bottom(), ensureIsAlive(), implGetBoundingBox(), tools::Rectangle::Left(), tools::Rectangle::Right(), SAL_WARN, and tools::Rectangle::Top().

Referenced by containsPoint(), getBounds(), getLocation(), and getSize().

◆ getBoundingBoxOnScreen()

tools::Rectangle accessibility::AccessibleGridControlBase::getBoundingBoxOnScreen ( )

protected

‍** Locks all mutex's and calculates the bounding box in screen

Exceptions

css::lang::DisposedException

Definition at line 324 of file AccessibleGridControlBase.cxx.

References tools::Rectangle::Bottom(), ensureIsAlive(), implGetBoundingBoxOnScreen(), tools::Rectangle::Left(), tools::Rectangle::Right(), SAL_WARN, and tools::Rectangle::Top().

Referenced by getLocationOnScreen().

◆ getBounds()

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

overridevirtual

Returns: The bounding box of this object.

Definition at line 189 of file AccessibleGridControlBase.cxx.

References AWTRectangle(), and getBoundingBox().

◆ getClientId()

::comphelper::AccessibleEventNotifier::TClientId accessibility::AccessibleGridControlBase::getClientId ( ) const

inlineprotected

Definition at line 234 of file AccessibleGridControlBase.hxx.

References m_aClientId.

Referenced by addAccessibleEventListener(), commitEvent(), disposing(), and removeAccessibleEventListener().

◆ getForeground()

sal_Int32 SAL_CALL accessibility::AccessibleGridControlBase::getForeground ( )

overridevirtual

Definition at line 386 of file AccessibleGridControlBase.cxx.

References ensureIsAlive(), vcl::Font::GetColor(), vcl::Window::GetControlFont(), vcl::Window::GetControlForeground(), vcl::Window::GetFont(), vcl::table::IAccessibleTable::GetWindowInstance(), vcl::Window::IsControlFont(), vcl::Window::IsControlForeground(), and m_aTable.

◆ getImplementationId()

Sequence< sal_Int8 > SAL_CALL accessibility::AccessibleGridControlBase::getImplementationId ( )

overridevirtual

Returns: a unique implementation ID.

Reimplemented in accessibility::AccessibleGridControlHeader, and accessibility::AccessibleGridControlTableBase.

Definition at line 248 of file AccessibleGridControlBase.cxx.

◆ getLocale()

lang::Locale SAL_CALL accessibility::AccessibleGridControlBase::getLocale ( )

overridevirtual

Returns: The parent's locale.

Definition at line 167 of file AccessibleGridControlBase.cxx.

References ensureIsAlive(), and m_xParent.

◆ getLocation()

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

overridevirtual

Returns: The upper left corner of the bounding box relative to the parent.

Definition at line 194 of file AccessibleGridControlBase.cxx.

References AWTPoint(), getBoundingBox(), and TopLeft.

◆ getLocationOnScreen()

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

overridevirtual

Returns: The upper left corner of the bounding box in screen coordinates.

Definition at line 199 of file AccessibleGridControlBase.cxx.

References AWTPoint(), getBoundingBoxOnScreen(), and TopLeft.

◆ getSize()

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

overridevirtual

Returns: The size of the bounding box.

Definition at line 204 of file AccessibleGridControlBase.cxx.

References AWTSize(), and getBoundingBox().

◆ getSupportedServiceNames()

Sequence< OUString > SAL_CALL accessibility::AccessibleGridControlBase::getSupportedServiceNames ( )

overridevirtual

Returns: a list of all supported services.

Definition at line 261 of file AccessibleGridControlBase.cxx.

◆ getType()

vcl::table::AccessibleTableControlObjType accessibility::AccessibleGridControlBase::getType ( ) const

inline

Returns: The GridControl object type.

Definition at line 297 of file AccessibleGridControlBase.hxx.

References m_eObjType.

Referenced by implCreateStateSet(), accessibility::AccessibleGridControlHeader::isColumnBar(), and accessibility::AccessibleGridControlHeader::isRowBar().

◆ implCreateStateSet()

sal_Int64 accessibility::AccessibleGridControlBase::implCreateStateSet ( )

protectedvirtual

Creates a bitset of states of the current object.

This method calls FillStateSet at the GridControl which fills it with more states depending on the object type. Derived classes may overwrite this method and add more states.

Attention: \n This method requires locked mutex's.

Reimplemented in accessibility::AccessibleGridControlHeaderCell, and accessibility::AccessibleGridControlTableCell.

Definition at line 281 of file AccessibleGridControlBase.cxx.

References vcl::table::IAccessibleTable::FillAccessibleStateSet(), getType(), implIsShowing(), isAlive(), and m_aTable.

Referenced by getAccessibleStateSet().

◆ implGetBoundingBox()

virtual tools::Rectangle accessibility::AccessibleGridControlBase::implGetBoundingBox ( )

protectedpure virtual

Derived classes return the bounding box relative to the parent window.

Attention: \n This method requires locked mutex's and a living object.

Returns: The bounding box (VCL rect.) relative to the parent window.

Implemented in accessibility::AccessibleGridControl, accessibility::AccessibleGridControlHeader, accessibility::AccessibleGridControlHeaderCell, accessibility::AccessibleGridControlTable, and accessibility::AccessibleGridControlTableCell.

Referenced by getBoundingBox(), and implIsShowing().

◆ implGetBoundingBoxOnScreen()

virtual tools::Rectangle accessibility::AccessibleGridControlBase::implGetBoundingBoxOnScreen ( )

protectedpure virtual

‍** Derived classes return the bounding box in screen coordinates.

Implemented in accessibility::AccessibleGridControl, accessibility::AccessibleGridControlHeader, accessibility::AccessibleGridControlHeaderCell, accessibility::AccessibleGridControlTable, and accessibility::AccessibleGridControlTableCell.

Referenced by getBoundingBoxOnScreen().

◆ implIsShowing()

bool accessibility::AccessibleGridControlBase::implIsShowing ( )

protected

Determines whether the Grid control is really showing inside of its parent accessible window.

Derived classes may implement different behaviour.

Attention: \n This method requires locked mutex's and a living object.

Returns: TRUE, if the object is really showing.

Definition at line 267 of file AccessibleGridControlBase.cxx.

References implGetBoundingBox(), m_xParent, tools::Rectangle::Overlaps(), and VCLRectangle().

Referenced by implCreateStateSet(), accessibility::AccessibleGridControlHeaderCell::implCreateStateSet(), and accessibility::AccessibleGridControlTableCell::implCreateStateSet().

◆ isAlive()

bool accessibility::AccessibleGridControlBase::isAlive ( ) const

Returns: TRUE, if the object is not disposed or disposing.

Definition at line 300 of file AccessibleGridControlBase.cxx.

References cppu::BaseMutex::m_aMutex.

Referenced by ensureIsAlive(), accessibility::AccessibleGridControl::getAccessibleChild(), implCreateStateSet(), accessibility::AccessibleGridControlHeaderCell::implCreateStateSet(), accessibility::AccessibleGridControlTableCell::implCreateStateSet(), and ~AccessibleGridControlBase().

◆ removeAccessibleEventListener()

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

overridevirtual

Removes an event listener.

Definition at line 225 of file AccessibleGridControlBase.cxx.

References getClientId(), nId, comphelper::AccessibleEventNotifier::removeEventListener(), comphelper::AccessibleEventNotifier::revokeClient(), and setClientId().

◆ setClientId()

void accessibility::AccessibleGridControlBase::setClientId ( ::comphelper::AccessibleEventNotifier::TClientId _aNewClientId )

inlineprotected

Definition at line 235 of file AccessibleGridControlBase.hxx.

References m_aClientId.

Referenced by addAccessibleEventListener(), disposing(), and removeAccessibleEventListener().

◆ supportsService()

sal_Bool SAL_CALL accessibility::AccessibleGridControlBase::supportsService ( const OUString & rServiceName )

overridevirtual

Returns: Whether the specified service is supported by this class.

Definition at line 255 of file AccessibleGridControlBase.cxx.

References cppu::supportsService().

Member Data Documentation

◆ m_aClientId

::comphelper::AccessibleEventNotifier::TClientId accessibility::AccessibleGridControlBase::m_aClientId

private

Definition at line 248 of file AccessibleGridControlBase.hxx.

Referenced by getClientId(), and setClientId().

◆ m_aTable

::vcl::table::IAccessibleTable& accessibility::AccessibleGridControlBase::m_aTable

protected

The SVT Table control.

Definition at line 243 of file AccessibleGridControlBase.hxx.

◆ m_eObjType

::vcl::table::AccessibleTableControlObjType accessibility::AccessibleGridControlBase::m_eObjType

protected

The type of this object (for names, descriptions, state sets, ...).

Definition at line 245 of file AccessibleGridControlBase.hxx.

Referenced by accessibility::AccessibleGridControlHeader::getAccessibleChild(), accessibility::AccessibleGridControlTableBase::getAccessibleChildCount(), getAccessibleDescription(), accessibility::AccessibleGridControlHeader::getAccessibleIndexInParent(), getAccessibleName(), accessibility::AccessibleGridControlCell::getAccessibleName(), getAccessibleRole(), getType(), accessibility::AccessibleGridControlHeaderCell::implGetBoundingBox(), accessibility::AccessibleGridControlHeaderCell::implGetBoundingBoxOnScreen(), and accessibility::AccessibleGridControlHeader::implGetChild().

◆ m_xParent

css::uno::Reference< css::accessibility::XAccessible > accessibility::AccessibleGridControlBase::m_xParent

protected

The parent accessible object.

Definition at line 241 of file AccessibleGridControlBase.hxx.

Referenced by disposing(), getAccessibleIndexInParent(), getAccessibleParent(), getLocale(), accessibility::AccessibleGridControlTable::implGetHeaderBar(), and implIsShowing().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AccessibleGridControlBase()

◆ ~AccessibleGridControlBase()

Member Function Documentation

◆ addAccessibleEventListener()

◆ commitEvent()

◆ containsPoint()

◆ disposing()

◆ ensureIsAlive()

◆ getAccessibleAtPoint()

◆ getAccessibleDescription()

◆ getAccessibleIndexInParent()

◆ getAccessibleName()

◆ getAccessibleParent()

◆ getAccessibleRelationSet()

◆ getAccessibleRole()

◆ getAccessibleStateSet()

◆ getBackground()

◆ getBoundingBox()

◆ getBoundingBoxOnScreen()

◆ getBounds()

◆ getClientId()

◆ getForeground()

◆ getImplementationId()

◆ getLocale()

◆ getLocation()

◆ getLocationOnScreen()

◆ getSize()

◆ getSupportedServiceNames()

◆ getType()

◆ implCreateStateSet()

◆ implGetBoundingBox()

◆ implGetBoundingBoxOnScreen()

◆ implIsShowing()

◆ isAlive()

◆ removeAccessibleEventListener()

◆ setClientId()

◆ supportsService()

Member Data Documentation

◆ m_aClientId

◆ m_aTable

◆ m_eObjType

◆ m_xParent