This class represents the complete accessible BrowseBox object. More...

#include <AccessibleBrowseBox.hxx>

Inheritance diagram for accessibility::AccessibleBrowseBox:

Collaboration diagram for accessibility::AccessibleBrowseBox:

Public Member Functions
void	commitHeaderBarEvent (sal_Int16 nEventId, const css::uno::Any &rNewValue, const css::uno::Any &rOldValue, bool _bColumnHeaderBar)
	commitHeaderBarEvent commit the event at all listeners of the column/row header bar More...

void	commitTableEvent (sal_Int16 nEventId, const css::uno::Any &rNewValue, const css::uno::Any &rOldValue)
	commitTableEvent commit the event at all listeners of the table More...

css::uno::Reference< css::accessibility::XAccessible >	getHeaderBar (AccessibleBrowseBoxObjType _eObjType)
	returns the accessible object for the row or the column header bar More...

css::uno::Reference< css::accessibility::XAccessible >	getTable ()
	returns the accessible object for the table representation More...

Public Member Functions inherited from accessibility::AccessibleBrowseBoxBase
	AccessibleBrowseBoxBase (css::uno::Reference< css::accessibility::XAccessible > xParent, ::vcl::IAccessibleTableProvider &rBrowseBox, css::uno::Reference< css::awt::XWindow > _xFocusWindow, AccessibleBrowseBoxObjType eObjType)
	Constructor sets specified name and description. More...

	AccessibleBrowseBoxBase (css::uno::Reference< css::accessibility::XAccessible > xParent, ::vcl::IAccessibleTableProvider &rBrowseBox, css::uno::Reference< css::awt::XWindow > _xFocusWindow, AccessibleBrowseBoxObjType eObjType, OUString rName, OUString rDescription)
	Constructor sets specified name and description. 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 void SAL_CALL	disposing (const css::lang::EventObject &Source) override

virtual void SAL_CALL	focusGained (const css::awt::FocusEvent &e) override

virtual void SAL_CALL	focusLost (const css::awt::FocusEvent &e) 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

AccessibleBrowseBoxObjType	getType () const

void	setAccessibleName (const OUString &rName)
	Changes the name of the object and notifies listeners. More...

void	setAccessibleDescription (const OUString &rDescription)
	Changes the description of the object and notifies listeners. More...

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

::osl::Mutex &	getMutex ()

void	ensureIsAlive () const

Protected Member Functions
	AccessibleBrowseBox (const css::uno::Reference< css::accessibility::XAccessible > &_rxParent, const css::uno::Reference< css::accessibility::XAccessible > &_rxCreator, ::vcl::IAccessibleTableProvider &_rBrowseBox)

virtual	~AccessibleBrowseBox () override

void	setCreator (const css::uno::Reference< css::accessibility::XAccessible > &_rxCreator)
	sets the XAccessible which created the context More...

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

virtual sal_Int64 SAL_CALL	getAccessibleChildCount () override

virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL	getAccessibleChild (sal_Int64 nChildIndex) 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 BrowseBox. More...

virtual OUString SAL_CALL	getImplementationName () override

virtual tools::Rectangle	implGetBoundingBox () override

virtual tools::Rectangle	implGetBoundingBoxOnScreen () override

css::uno::Reference< css::accessibility::XAccessible >	implGetTable ()
	This method creates (once) and returns the accessible data table child. More...

css::uno::Reference< css::accessibility::XAccessible >	implGetHeaderBar (AccessibleBrowseBoxObjType eObjType)
	This method creates (once) and returns the specified header bar. More...

css::uno::Reference< css::accessibility::XAccessible >	implGetFixedChild (sal_Int64 nChildIndex)
	This method returns one of the children that are always present: Data table, row and column header bar or corner control. More...

virtual rtl::Reference< AccessibleBrowseBoxTable >	createAccessibleTable ()
	This method creates and returns an accessible table. More...

virtual void SAL_CALL	disposing () override
	Cleans up members. More...

virtual void SAL_CALL	disposing (const css::lang::EventObject &Source) override
	Cleans up members. More...

Protected Member Functions inherited from accessibility::AccessibleBrowseBoxBase
virtual	~AccessibleBrowseBoxBase () override

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

bool	implIsShowing ()
	Determines whether the BrowseBox 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	implSetName (const OUString &rName)
	Changes the name of the object (flat assignment, no notify). More...

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 coordinates. More...

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

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

Private Attributes
css::uno::WeakReference< css::accessibility::XAccessible >	m_aCreator
	the css::accessibility::XAccessible which created the AccessibleBrowseBox More...

rtl::Reference< AccessibleBrowseBoxTable >	mxTable
	The data table child. More...

rtl::Reference< AccessibleBrowseBoxHeaderBar >	mxRowHeaderBar
	The header bar for rows ("handle column"). More...

rtl::Reference< AccessibleBrowseBoxHeaderBar >	mxColumnHeaderBar
	The header bar for columns (first row of the table). More...

Friends
class	AccessibleBrowseBoxAccess

Additional Inherited Members
Protected Attributes inherited from accessibility::AccessibleBrowseBoxBase
css::uno::Reference< css::accessibility::XAccessible >	mxParent
	The parent accessible object. More...

::vcl::IAccessibleTableProvider *	mpBrowseBox
	The VCL BrowseBox control. More...

css::uno::Reference< css::awt::XWindow >	m_xFocusWindow
	This is the window which get all the nice focus events. More...

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

Detailed Description

This class represents the complete accessible BrowseBox object.

Definition at line 36 of file AccessibleBrowseBox.hxx.

Constructor & Destructor Documentation

◆ AccessibleBrowseBox()

accessibility::AccessibleBrowseBox::AccessibleBrowseBox	(	const css::uno::Reference< css::accessibility::XAccessible > &	_rxParent,
		const css::uno::Reference< css::accessibility::XAccessible > &	_rxCreator,
		::vcl::IAccessibleTableProvider &	_rBrowseBox
	)

protected

Definition at line 41 of file AccessibleBrowseBox.cxx.

References VCLUnoHelper::GetInterface(), vcl::IAccessibleTableProvider::GetWindowInstance(), accessibility::AccessibleBrowseBoxBase::m_xFocusWindow, and accessibility::AccessibleBrowseBoxBase::mpBrowseBox.

◆ ~AccessibleBrowseBox()

accessibility::AccessibleBrowseBox::~AccessibleBrowseBox ( )

overrideprotectedvirtual

Definition at line 60 of file AccessibleBrowseBox.cxx.

Member Function Documentation

◆ commitHeaderBarEvent()

void accessibility::AccessibleBrowseBox::commitHeaderBarEvent	(	sal_Int16	nEventId,
		const css::uno::Any &	rNewValue,
		const css::uno::Any &	rOldValue,
		bool	_bColumnHeaderBar
	)

commitHeaderBarEvent commit the event at all listeners of the column/row header bar

Parameters

nEventId	the event id
rNewValue	the new value
rOldValue	the old value
_bColumnHeaderBar	true if a column based header bar, false if a row based header bar

Definition at line 262 of file AccessibleBrowseBox.cxx.

References mxColumnHeaderBar, and mxRowHeaderBar.

Referenced by accessibility::AccessibleBrowseBoxAccess::commitHeaderBarEvent().

◆ commitTableEvent()

void accessibility::AccessibleBrowseBox::commitTableEvent	(	sal_Int16	nEventId,
		const css::uno::Any &	rNewValue,
		const css::uno::Any &	rOldValue
	)

commitTableEvent commit the event at all listeners of the table

Parameters

nEventId	the event id
rNewValue	the new value
rOldValue	the old value

Definition at line 254 of file AccessibleBrowseBox.cxx.

References mxTable.

Referenced by accessibility::AccessibleBrowseBoxAccess::commitTableEvent().

◆ createAccessibleTable()

rtl::Reference< AccessibleBrowseBoxTable > accessibility::AccessibleBrowseBox::createAccessibleTable ( )

protectedvirtual

This method creates and returns an accessible table.

Returns: An AccessibleBrowseBoxTable.

Reimplemented in accessibility::AccessibleTabListBox.

Definition at line 247 of file AccessibleBrowseBox.cxx.

References m_aCreator, and accessibility::AccessibleBrowseBoxBase::mpBrowseBox.

Referenced by implGetTable().

◆ disposing() [1/3]

void SAL_CALL accessibility::AccessibleBrowseBoxBase::disposing ( )

overrideprotectedvirtual

Cleans up members.

Reimplemented from accessibility::AccessibleBrowseBoxBase.

Definition at line 102 of file AccessibleBrowseBoxBase.cxx.

◆ disposing() [2/3]

void SAL_CALL accessibility::AccessibleBrowseBox::disposing ( )

overrideprotectedvirtual

Commits DeFunc event to listeners and cleans up members.

Reimplemented from accessibility::AccessibleBrowseBoxBase.

Definition at line 65 of file AccessibleBrowseBox.cxx.

References accessibility::AccessibleBrowseBoxBase::disposing(), accessibility::AccessibleBrowseBoxBase::getMutex(), m_aCreator, mxColumnHeaderBar, mxRowHeaderBar, and mxTable.

◆ disposing() [3/3]

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

overrideprotectedvirtual

Cleans up members.

Reimplemented from accessibility::AccessibleBrowseBoxBase.

Definition at line 170 of file AccessibleBrowseBoxBase.cxx.

◆ getAccessibleAtPoint()

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

overrideprotectedvirtual

Returns: The accessible child rendered under the given point.

Reimplemented from accessibility::AccessibleBrowseBoxBase.

Definition at line 133 of file AccessibleBrowseBox.cxx.

References vcl::BBINDEX_FIRSTCONTROL, tools::Rectangle::Contains(), vcl::IAccessibleTableProvider::ConvertPointToControlIndex(), vcl::IAccessibleTableProvider::CreateAccessibleControl(), accessibility::AccessibleBrowseBoxBase::ensureIsAlive(), accessibility::AccessibleBrowseBoxBase::getMutex(), implGetFixedChild(), accessibility::AccessibleBrowseBoxBase::mpBrowseBox, nIndex, VCLPoint(), and VCLRectangle().

◆ getAccessibleChild()

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

overrideprotectedvirtual

Returns: The XAccessible interface of the specified child.

Reimplemented in accessibility::AccessibleTabListBox.

Definition at line 103 of file AccessibleBrowseBox.cxx.

References vcl::BBINDEX_FIRSTCONTROL, vcl::IAccessibleTableProvider::CreateAccessibleControl(), accessibility::AccessibleBrowseBoxBase::ensureIsAlive(), getAccessibleChildCount(), accessibility::AccessibleBrowseBoxBase::getMutex(), implGetFixedChild(), and accessibility::AccessibleBrowseBoxBase::mpBrowseBox.

◆ getAccessibleChildCount()

sal_Int64 SAL_CALL accessibility::AccessibleBrowseBox::getAccessibleChildCount ( )

overrideprotectedvirtual

Returns: The count of visible children.

Reimplemented in accessibility::AccessibleTabListBox.

Definition at line 93 of file AccessibleBrowseBox.cxx.

References vcl::BBINDEX_FIRSTCONTROL, accessibility::AccessibleBrowseBoxBase::ensureIsAlive(), vcl::IAccessibleTableProvider::GetAccessibleControlCount(), accessibility::AccessibleBrowseBoxBase::getMutex(), and accessibility::AccessibleBrowseBoxBase::mpBrowseBox.

Referenced by getAccessibleChild().

◆ getHeaderBar()

css::uno::Reference< css::accessibility::XAccessible > accessibility::AccessibleBrowseBox::getHeaderBar ( AccessibleBrowseBoxObjType _eObjType )

inline

returns the accessible object for the row or the column header bar

Definition at line 124 of file AccessibleBrowseBox.hxx.

References implGetHeaderBar().

Referenced by accessibility::AccessibleTabListBox::getHeaderBar(), and accessibility::AccessibleBrowseBoxAccess::getHeaderBar().

◆ getImplementationName()

OUString SAL_CALL accessibility::AccessibleBrowseBox::getImplementationName ( )

overrideprotectedvirtual

Returns: The name of this class.

Definition at line 172 of file AccessibleBrowseBox.cxx.

◆ getTable()

css::uno::Reference< css::accessibility::XAccessible > accessibility::AccessibleBrowseBox::getTable ( )

inline

returns the accessible object for the table representation

Definition at line 133 of file AccessibleBrowseBox.hxx.

References implGetTable().

Referenced by accessibility::AccessibleBrowseBoxAccess::getTable().

◆ grabFocus()

void SAL_CALL accessibility::AccessibleBrowseBox::grabFocus ( )

overrideprotectedvirtual

Grabs the focus to the BrowseBox.

Definition at line 162 of file AccessibleBrowseBox.cxx.

References accessibility::AccessibleBrowseBoxBase::ensureIsAlive(), accessibility::AccessibleBrowseBoxBase::getMutex(), vcl::IAccessibleTableProvider::GrabFocus(), and accessibility::AccessibleBrowseBoxBase::mpBrowseBox.

◆ implGetBoundingBox()

tools::Rectangle accessibility::AccessibleBrowseBox::implGetBoundingBox ( )

overrideprotectedvirtual

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::AccessibleBrowseBoxBase.

Definition at line 180 of file AccessibleBrowseBox.cxx.

References vcl::IAccessibleTableProvider::GetAccessibleParentWindow(), vcl::IAccessibleTableProvider::GetWindowExtentsRelative(), and accessibility::AccessibleBrowseBoxBase::mpBrowseBox.

◆ implGetBoundingBoxOnScreen()

tools::Rectangle accessibility::AccessibleBrowseBox::implGetBoundingBoxOnScreen ( )

overrideprotectedvirtual

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

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

Implements accessibility::AccessibleBrowseBoxBase.

Definition at line 188 of file AccessibleBrowseBox.cxx.

References vcl::IAccessibleTableProvider::GetWindowExtentsAbsolute(), and accessibility::AccessibleBrowseBoxBase::mpBrowseBox.

◆ implGetFixedChild()

css::uno::Reference< css::accessibility::XAccessible > accessibility::AccessibleBrowseBox::implGetFixedChild ( sal_Int64 nChildIndex )

protected

This method returns one of the children that are always present: Data table, row and column header bar or corner control.

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

Returns: The XAccessible interface of the specified child.

Definition at line 229 of file AccessibleBrowseBox.cxx.

References vcl::BBINDEX_COLUMNHEADERBAR, vcl::BBINDEX_ROWHEADERBAR, vcl::BBINDEX_TABLE, implGetHeaderBar(), and implGetTable().

Referenced by getAccessibleAtPoint(), and getAccessibleChild().

◆ implGetHeaderBar()

css::uno::Reference< css::accessibility::XAccessible > accessibility::AccessibleBrowseBox::implGetHeaderBar ( AccessibleBrowseBoxObjType eObjType )

protected

This method creates (once) and returns the specified header bar.

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

Returns: The XAccessible interface of the header bar.

Definition at line 205 of file AccessibleBrowseBox.cxx.

References m_aCreator, accessibility::AccessibleBrowseBoxBase::mpBrowseBox, mxColumnHeaderBar, and mxRowHeaderBar.

Referenced by accessibility::AccessibleTabListBox::getAccessibleChild(), getHeaderBar(), and implGetFixedChild().

◆ implGetTable()

css::uno::Reference< css::accessibility::XAccessible > accessibility::AccessibleBrowseBox::implGetTable ( )

protected

This method creates (once) and returns the accessible data table child.

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

Returns: The XAccessible interface of the data table.

Definition at line 194 of file AccessibleBrowseBox.cxx.

References createAccessibleTable(), and mxTable.

Referenced by accessibility::AccessibleTabListBox::getAccessibleChild(), getTable(), accessibility::AccessibleTabListBox::getTable(), and implGetFixedChild().

◆ setCreator()

void accessibility::AccessibleBrowseBox::setCreator ( const css::uno::Reference< css::accessibility::XAccessible > & _rxCreator )

protected

sets the XAccessible which created the context

To be called only once, and only if in the ctor NULL was passed.

Definition at line 50 of file AccessibleBrowseBox.cxx.

References m_aCreator.

Referenced by accessibility::AccessibleTabListBox::AccessibleTabListBox().

Friends And Related Function Documentation

◆ AccessibleBrowseBoxAccess

friend class AccessibleBrowseBoxAccess

friend

Definition at line 38 of file AccessibleBrowseBox.hxx.

Member Data Documentation

◆ m_aCreator

css::uno::WeakReference< css::accessibility::XAccessible > accessibility::AccessibleBrowseBox::m_aCreator

private

the css::accessibility::XAccessible which created the AccessibleBrowseBox

Definition at line 177 of file AccessibleBrowseBox.hxx.

Referenced by createAccessibleTable(), disposing(), implGetHeaderBar(), and setCreator().

◆ mxColumnHeaderBar

rtl::Reference<AccessibleBrowseBoxHeaderBar> accessibility::AccessibleBrowseBox::mxColumnHeaderBar

private

The header bar for columns (first row of the table).

Definition at line 186 of file AccessibleBrowseBox.hxx.

Referenced by commitHeaderBarEvent(), disposing(), and implGetHeaderBar().

◆ mxRowHeaderBar

rtl::Reference<AccessibleBrowseBoxHeaderBar> accessibility::AccessibleBrowseBox::mxRowHeaderBar

private

The header bar for rows ("handle column").

Definition at line 183 of file AccessibleBrowseBox.hxx.

Referenced by commitHeaderBarEvent(), disposing(), and implGetHeaderBar().

◆ mxTable

rtl::Reference<AccessibleBrowseBoxTable> accessibility::AccessibleBrowseBox::mxTable

private

The data table child.

Definition at line 180 of file AccessibleBrowseBox.hxx.

Referenced by commitTableEvent(), disposing(), and implGetTable().

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

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AccessibleBrowseBox()

◆ ~AccessibleBrowseBox()

Member Function Documentation

◆ commitHeaderBarEvent()

◆ commitTableEvent()

◆ createAccessibleTable()

◆ disposing() [1/3]

◆ disposing() [2/3]

◆ disposing() [3/3]

◆ getAccessibleAtPoint()

◆ getAccessibleChild()

◆ getAccessibleChildCount()

◆ getHeaderBar()

◆ getImplementationName()

◆ getTable()

◆ grabFocus()

◆ implGetBoundingBox()

◆ implGetBoundingBoxOnScreen()

◆ implGetFixedChild()

◆ implGetHeaderBar()

◆ implGetTable()

◆ setCreator()

Friends And Related Function Documentation

◆ AccessibleBrowseBoxAccess

Member Data Documentation

◆ m_aCreator

◆ mxColumnHeaderBar

◆ mxRowHeaderBar

◆ mxTable