The Grid Control accessible table objects inherit from this base class. More...

#include <AccessibleGridControlTableBase.hxx>

Inheritance diagram for accessibility::AccessibleGridControlTableBase:

Collaboration diagram for accessibility::AccessibleGridControlTableBase:

Public Member Functions
	AccessibleGridControlTableBase (const css::uno::Reference< css::accessibility::XAccessible > &rxParent, ::vcl::table::IAccessibleTable &rTable, ::vcl::table::AccessibleTableControlObjType eObjType)
	Constructor sets specified name and description. More...

virtual sal_Int64 SAL_CALL	getAccessibleChildCount () override

virtual sal_Int16 SAL_CALL	getAccessibleRole () override

virtual sal_Int32 SAL_CALL	getAccessibleRowCount () override

virtual sal_Int32 SAL_CALL	getAccessibleColumnCount () override

virtual sal_Int32 SAL_CALL	getAccessibleRowExtentAt (sal_Int32 nRow, sal_Int32 nColumn) override

virtual sal_Int32 SAL_CALL	getAccessibleColumnExtentAt (sal_Int32 nRow, sal_Int32 nColumn) override

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

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

virtual sal_Int64 SAL_CALL	getAccessibleIndex (sal_Int32 nRow, sal_Int32 nColumn) override

virtual sal_Int32 SAL_CALL	getAccessibleRow (sal_Int64 nChildIndex) override

virtual sal_Int32 SAL_CALL	getAccessibleColumn (sal_Int64 nChildIndex) override

css::uno::Any SAL_CALL	queryInterface (const css::uno::Type &rType) override
	Queries for a new interface. More...

virtual void SAL_CALL	acquire () noexcept override
	Acquires the object (calls acquire() on base class). More...

virtual void SAL_CALL	release () noexcept override
	Releases the object (calls release() on base class). More...

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

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

Public Member Functions inherited from accessibility::AccessibleGridControlBase
	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

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

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

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

Protected Member Functions
virtual	~AccessibleGridControlTableBase () override=default

sal_Int32	implGetRow (sal_Int64 nChildIndex) const

sal_Int32	implGetColumn (sal_Int64 nChildIndex) const

void	implGetSelectedRows (css::uno::Sequence< sal_Int32 > &rSeq)
	Fills a sequence with sorted indexes of completely selected rows. More...

void	ensureIsValidRow (sal_Int32 nRow)

void	ensureIsValidColumn (sal_Int32 nColumn)

void	ensureIsValidAddress (sal_Int32 nRow, sal_Int32 nColumn)

void	ensureIsValidIndex (sal_Int64 nChildIndex)

Protected Member Functions inherited from accessibility::GridControlAccessibleElement
	GridControlAccessibleElement (const css::uno::Reference< css::accessibility::XAccessible > &rxParent, ::vcl::table::IAccessibleTable &rTable, ::vcl::table::AccessibleTableControlObjType eObjType)
	Constructor sets specified name and description. More...

virtual	~GridControlAccessibleElement () override

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

Protected Member Functions inherited from accessibility::AccessibleGridControlBase
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 Member Functions inherited from cppu::ImplHelper1< class Ifc1 >
	~ImplHelper1 () SAL_NOEXCEPT

Additional Inherited Members
Protected Attributes inherited from accessibility::AccessibleGridControlBase
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

Detailed Description

The Grid Control accessible table objects inherit from this base class.

It implements basic functionality for the XAccessibleTable interface. Grid COntrol table objects are: the data table, the column header bar and the row header bar.

Definition at line 37 of file AccessibleGridControlTableBase.hxx.

Constructor & Destructor Documentation

◆ AccessibleGridControlTableBase()

accessibility::AccessibleGridControlTableBase::AccessibleGridControlTableBase	(	const css::uno::Reference< css::accessibility::XAccessible > &	rxParent,
		::vcl::table::IAccessibleTable &	rTable,
		::vcl::table::AccessibleTableControlObjType	eObjType
	)

Constructor sets specified name and description.

Parameters

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

Definition at line 40 of file AccessibleGridControlTableBase.cxx.

◆ ~AccessibleGridControlTableBase()

virtual accessibility::AccessibleGridControlTableBase::~AccessibleGridControlTableBase ( )

overrideprotectedvirtualdefault

Member Function Documentation

◆ acquire()

void SAL_CALL accessibility::AccessibleGridControlTableBase::acquire ( )

overridevirtualnoexcept

Acquires the object (calls acquire() on base class).

Reimplemented in accessibility::AccessibleGridControlTable.

Definition at line 164 of file AccessibleGridControlTableBase.cxx.

Referenced by accessibility::AccessibleGridControlTable::acquire().

◆ ensureIsValidAddress()

void accessibility::AccessibleGridControlTableBase::ensureIsValidAddress	(	sal_Int32	nRow,
		sal_Int32	nColumn
	)

protected

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

Exceptions

<type>IndexOutOfBoundsException</type> If the specified cell address is invalid.

Definition at line 223 of file AccessibleGridControlTableBase.cxx.

References ensureIsValidColumn(), and ensureIsValidRow().

Referenced by accessibility::AccessibleGridControlTable::getAccessibleCellAt(), getAccessibleColumnExtentAt(), getAccessibleIndex(), getAccessibleRowExtentAt(), and accessibility::AccessibleGridControlTable::isAccessibleSelected().

◆ ensureIsValidColumn()

void accessibility::AccessibleGridControlTableBase::ensureIsValidColumn ( sal_Int32 nColumn )

protected

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

Exceptions

<type>IndexOutOfBoundsException</type> If the specified column index is invalid.

Definition at line 217 of file AccessibleGridControlTableBase.cxx.

References vcl::table::IAccessibleTable::GetColumnCount(), and accessibility::AccessibleGridControlBase::m_aTable.

Referenced by ensureIsValidAddress(), accessibility::AccessibleGridControlHeader::getAccessibleColumnDescription(), and accessibility::AccessibleGridControlTable::getAccessibleColumnDescription().

◆ ensureIsValidIndex()

void accessibility::AccessibleGridControlTableBase::ensureIsValidIndex ( sal_Int64 nChildIndex )

protected

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

Exceptions

<type>IndexOutOfBoundsException</type> If the specified child index is invalid.

Definition at line 230 of file AccessibleGridControlTableBase.cxx.

References vcl::table::IAccessibleTable::GetColumnCount(), vcl::table::IAccessibleTable::GetRowCount(), and accessibility::AccessibleGridControlBase::m_aTable.

Referenced by accessibility::AccessibleGridControlTable::getAccessibleChild(), getAccessibleColumn(), getAccessibleRow(), accessibility::AccessibleGridControlTable::isAccessibleChildSelected(), and accessibility::AccessibleGridControlTable::selectAccessibleChild().

◆ ensureIsValidRow()

void accessibility::AccessibleGridControlTableBase::ensureIsValidRow ( sal_Int32 nRow )

protected

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

Exceptions

<type>IndexOutOfBoundsException</type> If the specified row index is invalid.

Definition at line 211 of file AccessibleGridControlTableBase.cxx.

References vcl::table::IAccessibleTable::GetRowCount(), and accessibility::AccessibleGridControlBase::m_aTable.

Referenced by ensureIsValidAddress(), accessibility::AccessibleGridControlHeader::getAccessibleRowDescription(), accessibility::AccessibleGridControlTable::getAccessibleRowDescription(), and accessibility::AccessibleGridControlTable::isAccessibleRowSelected().

◆ getAccessibleCaption()

Reference< XAccessible > SAL_CALL accessibility::AccessibleGridControlTableBase::getAccessibleCaption ( )

overridevirtual

Returns: The caption cell of the table (not supported).

Definition at line 111 of file AccessibleGridControlTableBase.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive().

◆ getAccessibleChildCount()

sal_Int64 SAL_CALL accessibility::AccessibleGridControlTableBase::getAccessibleChildCount ( )

overridevirtual

Returns: The count of visible children.

Definition at line 50 of file AccessibleGridControlTableBase.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive(), vcl::table::IAccessibleTable::GetColumnCount(), vcl::table::IAccessibleTable::GetRowCount(), accessibility::AccessibleGridControlBase::m_aTable, accessibility::AccessibleGridControlBase::m_eObjType, TCTYPE_COLUMNHEADERBAR, TCTYPE_ROWHEADERBAR, and TCTYPE_TABLE.

Referenced by accessibility::AccessibleGridControlHeader::getAccessibleChild(), and accessibility::AccessibleGridControlTable::getAccessibleChild().

◆ getAccessibleColumn()

sal_Int32 SAL_CALL accessibility::AccessibleGridControlTableBase::getAccessibleColumn ( sal_Int64 nChildIndex )

overridevirtual

Returns: The column index of the specified child cell.

Definition at line 146 of file AccessibleGridControlTableBase.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive(), ensureIsValidIndex(), and implGetColumn().

◆ getAccessibleColumnCount()

sal_Int32 SAL_CALL accessibility::AccessibleGridControlTableBase::getAccessibleColumnCount ( )

overridevirtual

Returns: The number of used columns in the table (0 = empty table).

Definition at line 83 of file AccessibleGridControlTableBase.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive(), vcl::table::IAccessibleTable::GetColumnCount(), and accessibility::AccessibleGridControlBase::m_aTable.

◆ getAccessibleColumnExtentAt()

sal_Int32 SAL_CALL accessibility::AccessibleGridControlTableBase::getAccessibleColumnExtentAt	(	sal_Int32	nRow,
		sal_Int32	nColumn
	)

overridevirtual

Returns: The column extent of the specified cell (always 1).

Definition at line 101 of file AccessibleGridControlTableBase.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive(), and ensureIsValidAddress().

◆ getAccessibleIndex()

sal_Int64 SAL_CALL accessibility::AccessibleGridControlTableBase::getAccessibleIndex	(	sal_Int32	nRow,
		sal_Int32	nColumn
	)

overridevirtual

Returns: The child index of the specified cell.

Definition at line 127 of file AccessibleGridControlTableBase.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive(), ensureIsValidAddress(), vcl::table::IAccessibleTable::GetColumnCount(), and accessibility::AccessibleGridControlBase::m_aTable.

◆ getAccessibleRole()

sal_Int16 SAL_CALL accessibility::AccessibleGridControlTableBase::getAccessibleRole ( )

overridevirtual

Returns: The role of this object (a table).

Reimplemented from accessibility::AccessibleGridControlBase.

Definition at line 65 of file AccessibleGridControlTableBase.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive().

◆ getAccessibleRow()

sal_Int32 SAL_CALL accessibility::AccessibleGridControlTableBase::getAccessibleRow ( sal_Int64 nChildIndex )

overridevirtual

Returns: The row index of the specified child cell.

Definition at line 137 of file AccessibleGridControlTableBase.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive(), ensureIsValidIndex(), and implGetRow().

◆ getAccessibleRowCount()

sal_Int32 SAL_CALL accessibility::AccessibleGridControlTableBase::getAccessibleRowCount ( )

overridevirtual

Returns: The number of used rows in the table (0 = empty table).

Definition at line 75 of file AccessibleGridControlTableBase.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive(), vcl::table::IAccessibleTable::GetRowCount(), and accessibility::AccessibleGridControlBase::m_aTable.

◆ getAccessibleRowExtentAt()

sal_Int32 SAL_CALL accessibility::AccessibleGridControlTableBase::getAccessibleRowExtentAt	(	sal_Int32	nRow,
		sal_Int32	nColumn
	)

overridevirtual

Returns: The row extent of the specified cell (always 1).

Definition at line 91 of file AccessibleGridControlTableBase.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive(), and ensureIsValidAddress().

◆ getAccessibleSummary()

Reference< XAccessible > SAL_CALL accessibility::AccessibleGridControlTableBase::getAccessibleSummary ( )

overridevirtual

Returns: The summary object of the table (not supported).

Definition at line 119 of file AccessibleGridControlTableBase.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive().

◆ getImplementationId()

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

overridevirtual

Returns: a unique implementation ID.

Reimplemented from cppu::ImplHelper1< class Ifc1 >.

Reimplemented in accessibility::AccessibleGridControlHeader.

Definition at line 183 of file AccessibleGridControlTableBase.cxx.

◆ getTypes()

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

overridevirtual

Returns: a sequence of possible types (received from base classes).

Reimplemented from cppu::ImplHelper1< class Ifc1 >.

Definition at line 176 of file AccessibleGridControlTableBase.cxx.

References cppu::ImplHelper1< class Ifc1 >::getTypes().

◆ implGetColumn()

sal_Int32 accessibility::AccessibleGridControlTableBase::implGetColumn ( sal_Int64 nChildIndex ) const

protected

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

Returns: The column index of the specified cell index.

Definition at line 196 of file AccessibleGridControlTableBase.cxx.

References vcl::table::IAccessibleTable::GetColumnCount(), and accessibility::AccessibleGridControlBase::m_aTable.

Referenced by getAccessibleColumn().

◆ implGetRow()

sal_Int32 accessibility::AccessibleGridControlTableBase::implGetRow ( sal_Int64 nChildIndex ) const

protected

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

Returns: The row index of the specified cell index.

Definition at line 190 of file AccessibleGridControlTableBase.cxx.

References vcl::table::IAccessibleTable::GetColumnCount(), and accessibility::AccessibleGridControlBase::m_aTable.

Referenced by getAccessibleRow().

◆ implGetSelectedRows()

void accessibility::AccessibleGridControlTableBase::implGetSelectedRows ( css::uno::Sequence< sal_Int32 > & rSeq )

protected

Fills a sequence with sorted indexes of completely selected rows.

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

Parameters

rSeq	Out-parameter that takes the sorted row index list.

Definition at line 202 of file AccessibleGridControlTableBase.cxx.

References vcl::table::IAccessibleTable::GetSelectedRowCount(), vcl::table::IAccessibleTable::GetSelectedRowIndex(), i, and accessibility::AccessibleGridControlBase::m_aTable.

Referenced by accessibility::AccessibleGridControlTable::getSelectedAccessibleRows().

◆ queryInterface()

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

overridevirtual

Queries for a new interface.

Reimplemented from cppu::ImplHelper1< class Ifc1 >.

Definition at line 157 of file AccessibleGridControlTableBase.cxx.

References Any, and cppu::ImplHelper1< class Ifc1 >::queryInterface().

Referenced by accessibility::AccessibleGridControlTable::queryInterface().

◆ release()

void SAL_CALL accessibility::AccessibleGridControlTableBase::release ( )

overridevirtualnoexcept

Releases the object (calls release() on base class).

Reimplemented in accessibility::AccessibleGridControlTable.

Definition at line 169 of file AccessibleGridControlTableBase.cxx.

Referenced by accessibility::AccessibleGridControlTable::release().

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AccessibleGridControlTableBase()

◆ ~AccessibleGridControlTableBase()

Member Function Documentation

◆ acquire()

◆ ensureIsValidAddress()

◆ ensureIsValidColumn()

◆ ensureIsValidIndex()

◆ ensureIsValidRow()

◆ getAccessibleCaption()

◆ getAccessibleChildCount()

◆ getAccessibleColumn()

◆ getAccessibleColumnCount()

◆ getAccessibleColumnExtentAt()

◆ getAccessibleIndex()

◆ getAccessibleRole()

◆ getAccessibleRow()

◆ getAccessibleRowCount()

◆ getAccessibleRowExtentAt()

◆ getAccessibleSummary()

◆ getImplementationId()

◆ getTypes()

◆ implGetColumn()

◆ implGetRow()

◆ implGetSelectedRows()

◆ queryInterface()

◆ release()