This class represents the accessible object of a header bar of a Grid Control (row or column header bar). More...

#include <AccessibleGridControlHeader.hxx>

Inheritance diagram for accessibility::AccessibleGridControlHeader:

Collaboration diagram for accessibility::AccessibleGridControlHeader:

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

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

virtual sal_Int64 SAL_CALL	getAccessibleIndexInParent () override

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

virtual void SAL_CALL	grabFocus () override
	Grabs the focus to (the current cell of) the data table. More...

virtual OUString SAL_CALL	getAccessibleRowDescription (sal_Int32 nRow) override

virtual OUString SAL_CALL	getAccessibleColumnDescription (sal_Int32 nColumn) override

virtual css::uno::Reference< css::accessibility::XAccessibleTable > SAL_CALL	getAccessibleRowHeaders () override

virtual css::uno::Reference< css::accessibility::XAccessibleTable > SAL_CALL	getAccessibleColumnHeaders () override

virtual css::uno::Sequence< sal_Int32 > SAL_CALL	getSelectedAccessibleRows () override

virtual css::uno::Sequence< sal_Int32 > SAL_CALL	getSelectedAccessibleColumns () override

virtual sal_Bool SAL_CALL	isAccessibleRowSelected (sal_Int32 nRow) override

virtual sal_Bool SAL_CALL	isAccessibleColumnSelected (sal_Int32 nColumn) override

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	getAccessibleCellAt (sal_Int32 nRow, sal_Int32 nColumn) override

virtual sal_Bool SAL_CALL	isAccessibleSelected (sal_Int32 nRow, sal_Int32 nColumn) override

virtual OUString SAL_CALL	getImplementationName () override

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

Public Member Functions inherited from 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. 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

Private Member Functions
virtual	~AccessibleGridControlHeader () override=default

css::uno::Reference< css::accessibility::XAccessible >	implGetChild (sal_Int32 nRow, sal_uInt32 nColumnPos)
	Returns the specified row or column. More...

virtual tools::Rectangle	implGetBoundingBox () override

virtual tools::Rectangle	implGetBoundingBoxOnScreen () override

bool	isRowBar () const

bool	isColumnBar () const

Additional Inherited Members
Protected Member Functions inherited from accessibility::AccessibleGridControlTableBase
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

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

This class represents the accessible object of a header bar of a Grid Control (row or column header bar).

This object supports the XAccessibleSelection interface. Selecting a child of this object selects complete rows or columns of the data table.

Definition at line 31 of file AccessibleGridControlHeader.hxx.

Constructor & Destructor Documentation

◆ AccessibleGridControlHeader()

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

Parameters

rxParent	accessible parent control
rTable	accessible table
eObjType	One of the two allowed types TCTYPE_ROWHEADERBAR or TCTYPE_COLUMNHEADERBAR.

Definition at line 41 of file AccessibleGridControlHeader.cxx.

References isColumnBar(), and isRowBar().

◆ ~AccessibleGridControlHeader()

virtual accessibility::AccessibleGridControlHeader::~AccessibleGridControlHeader ( )

overrideprivatevirtualdefault

Member Function Documentation

◆ getAccessibleAtPoint()

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

overridevirtual

Returns: The accessible child rendered under the given point.

Reimplemented from accessibility::AccessibleGridControlBase.

Definition at line 89 of file AccessibleGridControlHeader.cxx.

References vcl::table::IAccessibleTable::ConvertPointToCellAddress(), accessibility::AccessibleGridControlBase::ensureIsAlive(), implGetChild(), accessibility::AccessibleGridControlBase::m_aTable, and VCLPoint().

◆ getAccessibleCellAt()

Reference< XAccessible > SAL_CALL accessibility::AccessibleGridControlHeader::getAccessibleCellAt	(	sal_Int32	nRow,
		sal_Int32	nColumn
	)

overridevirtual

Returns: The XAccessible interface of the cell object at the specified cell position.

Definition at line 163 of file AccessibleGridControlHeader.cxx.

◆ getAccessibleChild()

Reference< XAccessible > SAL_CALL accessibility::AccessibleGridControlHeader::getAccessibleChild ( sal_Int64 nChildIndex )

overridevirtual

Returns: The XAccessible interface of the specified child.

Definition at line 54 of file AccessibleGridControlHeader.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive(), accessibility::AccessibleGridControlTableBase::getAccessibleChildCount(), accessibility::AccessibleGridControlBase::m_aTable, accessibility::AccessibleGridControlBase::m_eObjType, vcl::table::TCTYPE_COLUMNHEADERBAR, vcl::table::TCTYPE_COLUMNHEADERCELL, vcl::table::TCTYPE_ROWHEADERBAR, and vcl::table::TCTYPE_ROWHEADERCELL.

◆ getAccessibleColumnDescription()

OUString SAL_CALL accessibility::AccessibleGridControlHeader::getAccessibleColumnDescription ( sal_Int32 nColumn )

overridevirtual

Returns: The description text of the specified column.

Definition at line 118 of file AccessibleGridControlHeader.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive(), and accessibility::AccessibleGridControlTableBase::ensureIsValidColumn().

◆ getAccessibleColumnHeaders()

Reference< XAccessibleTable > SAL_CALL accessibility::AccessibleGridControlHeader::getAccessibleColumnHeaders ( )

overridevirtual

Returns: The XAccessibleTable interface of the column header bar.

Definition at line 135 of file AccessibleGridControlHeader.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive().

◆ getAccessibleIndexInParent()

sal_Int64 SAL_CALL accessibility::AccessibleGridControlHeader::getAccessibleIndexInParent ( )

overridevirtual

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

Reimplemented from accessibility::AccessibleGridControlBase.

Definition at line 75 of file AccessibleGridControlHeader.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive(), vcl::table::IAccessibleTable::HasColHeader(), accessibility::AccessibleGridControlBase::m_aTable, accessibility::AccessibleGridControlBase::m_eObjType, and vcl::table::TCTYPE_ROWHEADERBAR.

◆ getAccessibleRowDescription()

OUString SAL_CALL accessibility::AccessibleGridControlHeader::getAccessibleRowDescription ( sal_Int32 nRow )

overridevirtual

Returns: The description text of the specified row.

Definition at line 109 of file AccessibleGridControlHeader.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive(), and accessibility::AccessibleGridControlTableBase::ensureIsValidRow().

◆ getAccessibleRowHeaders()

Reference< XAccessibleTable > SAL_CALL accessibility::AccessibleGridControlHeader::getAccessibleRowHeaders ( )

overridevirtual

Returns: The XAccessibleTable interface of the row header bar.

Definition at line 127 of file AccessibleGridControlHeader.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive().

◆ getImplementationId()

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

overridevirtual

Returns: a unique implementation ID.

Reimplemented from accessibility::AccessibleGridControlTableBase.

Definition at line 182 of file AccessibleGridControlHeader.cxx.

◆ getImplementationName()

OUString SAL_CALL accessibility::AccessibleGridControlHeader::getImplementationName ( )

overridevirtual

Returns: The name of this class.

Definition at line 177 of file AccessibleGridControlHeader.cxx.

◆ getSelectedAccessibleColumns()

Sequence< sal_Int32 > SAL_CALL accessibility::AccessibleGridControlHeader::getSelectedAccessibleColumns ( )

overridevirtual

Returns: An index list of completely selected columns.

Definition at line 148 of file AccessibleGridControlHeader.cxx.

◆ getSelectedAccessibleRows()

Sequence< sal_Int32 > SAL_CALL accessibility::AccessibleGridControlHeader::getSelectedAccessibleRows ( )

overridevirtual

Returns: An index list of completely selected rows.

Definition at line 143 of file AccessibleGridControlHeader.cxx.

◆ grabFocus()

void SAL_CALL accessibility::AccessibleGridControlHeader::grabFocus ( )

overridevirtual

Grabs the focus to (the current cell of) the data table.

Definition at line 101 of file AccessibleGridControlHeader.cxx.

References accessibility::AccessibleGridControlBase::ensureIsAlive().

◆ implGetBoundingBox()

tools::Rectangle accessibility::AccessibleGridControlHeader::implGetBoundingBox ( )

overrideprivatevirtual

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

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

Implements accessibility::AccessibleGridControlBase.

Definition at line 189 of file AccessibleGridControlHeader.cxx.

References vcl::table::IAccessibleTable::calcHeaderRect(), vcl::table::IAccessibleTable::GetAccessibleParentWindow(), tools::Rectangle::getOpenHeight(), tools::Rectangle::getOpenWidth(), vcl::table::IAccessibleTable::GetWindowExtentsRelative(), isColumnBar(), accessibility::AccessibleGridControlBase::m_aTable, and tools::Rectangle::TopLeft().

◆ implGetBoundingBoxOnScreen()

tools::Rectangle accessibility::AccessibleGridControlHeader::implGetBoundingBoxOnScreen ( )

overrideprivatevirtual

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

Returns: The bounding box (VCL rect.) in screen coordinates.

Implements accessibility::AccessibleGridControlBase.

Definition at line 201 of file AccessibleGridControlHeader.cxx.

References vcl::table::IAccessibleTable::calcHeaderRect(), tools::Rectangle::getOpenHeight(), tools::Rectangle::getOpenWidth(), vcl::table::IAccessibleTable::GetWindowExtentsAbsolute(), isColumnBar(), accessibility::AccessibleGridControlBase::m_aTable, and tools::Rectangle::TopLeft().

◆ implGetChild()

Reference< XAccessible > accessibility::AccessibleGridControlHeader::implGetChild	(	sal_Int32	nRow,
		sal_uInt32	nColumnPos
	)

private

Returns the specified row or column.

Uses one of the parameters, depending on object type.

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

Returns: The XAccessible interface of the specified column/row.

Definition at line 212 of file AccessibleGridControlHeader.cxx.

References accessibility::AccessibleGridControlBase::m_aTable, accessibility::AccessibleGridControlBase::m_eObjType, vcl::table::TCTYPE_COLUMNHEADERBAR, vcl::table::TCTYPE_COLUMNHEADERCELL, vcl::table::TCTYPE_ROWHEADERBAR, and vcl::table::TCTYPE_ROWHEADERCELL.

Referenced by getAccessibleAtPoint().

◆ isAccessibleColumnSelected()

sal_Bool SAL_CALL accessibility::AccessibleGridControlHeader::isAccessibleColumnSelected ( sal_Int32 nColumn )

overridevirtual

Returns: TRUE, if the specified column is completely selected.

Definition at line 158 of file AccessibleGridControlHeader.cxx.

◆ isAccessibleRowSelected()

sal_Bool SAL_CALL accessibility::AccessibleGridControlHeader::isAccessibleRowSelected ( sal_Int32 nRow )

overridevirtual

Returns: TRUE, if the specified row is completely selected.

Definition at line 153 of file AccessibleGridControlHeader.cxx.

◆ isAccessibleSelected()

sal_Bool SAL_CALL accessibility::AccessibleGridControlHeader::isAccessibleSelected	(	sal_Int32	nRow,
		sal_Int32	nColumn
	)

overridevirtual

Returns: TRUE, if the specified cell is selected.

Definition at line 169 of file AccessibleGridControlHeader.cxx.

◆ isColumnBar()

bool accessibility::AccessibleGridControlHeader::isColumnBar ( ) const

inlineprivate

Returns: TRUE, if the objects is a header bar for columns.

Definition at line 145 of file AccessibleGridControlHeader.hxx.

References accessibility::AccessibleGridControlBase::getType().

Referenced by AccessibleGridControlHeader(), implGetBoundingBox(), and implGetBoundingBoxOnScreen().

◆ isRowBar()

bool accessibility::AccessibleGridControlHeader::isRowBar ( ) const

inlineprivate

Returns: TRUE, if the objects is a header bar for rows.

Definition at line 140 of file AccessibleGridControlHeader.hxx.

References accessibility::AccessibleGridControlBase::getType().

Referenced by AccessibleGridControlHeader().

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

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AccessibleGridControlHeader()

◆ ~AccessibleGridControlHeader()

Member Function Documentation

◆ getAccessibleAtPoint()

◆ getAccessibleCellAt()

◆ getAccessibleChild()

◆ getAccessibleColumnDescription()

◆ getAccessibleColumnHeaders()

◆ getAccessibleIndexInParent()

◆ getAccessibleRowDescription()

◆ getAccessibleRowHeaders()

◆ getImplementationId()

◆ getImplementationName()

◆ getSelectedAccessibleColumns()

◆ getSelectedAccessibleRows()

◆ grabFocus()

◆ implGetBoundingBox()

◆ implGetBoundingBoxOnScreen()

◆ implGetChild()

◆ isAccessibleColumnSelected()

◆ isAccessibleRowSelected()

◆ isAccessibleSelected()

◆ isColumnBar()

◆ isRowBar()