LibreOffice Module winaccessibility (master): AccEventListener Class Reference

LibreOffice Module winaccessibility (master) 1

AccEventListener is the general event listener for all controls. More...

#include <AccEventListener.hxx>

Inheritance diagram for AccEventListener:

Collaboration diagram for AccEventListener:

Public Member Functions
	AccEventListener (css::accessibility::XAccessible pAcc, AccObjectManagerAgent Agent)

virtual	~AccEventListener () override

virtual void SAL_CALL	disposing (const css::lang::EventObject &Source) override
	this method is invoked before listener is disposed More...

virtual void SAL_CALL	notifyEvent (const css::accessibility::AccessibleEventObject &aEvent) override
	Uno's event notifier when event is captured. More...

virtual void	HandleNameChangedEvent (css::uno::Any name)
	handle the NAME_CHANGED event More...

virtual void	HandleDescriptionChangedEvent ()
	handle the DESCRIPTION_CHANGED event More...

virtual void	HandleStateChangedEvent (css::uno::Any oldValue, css::uno::Any newValue)
	handle the STATE_CHANGED event More...

virtual void	SetComponentState (sal_Int64 state, bool enable)
	set the new state and fire the MSAA event More...

virtual void	FireStatePropertyChange (sal_Int64 state, bool set)
	fire the MSAA state changed event More...

virtual void	FireStateFocusedChange (bool enable)
	handle the focused event More...

virtual void	HandleBoundrectChangedEvent ()
	handle the BOUNDRECT_CHANGED event More...

virtual void	HandleVisibleDataChangedEvent ()
	handle the VISIBLE_DATA_CHANGED event More...

virtual short	GetRole ()
	get the role of accessible object which is observed More...

virtual short	GetParentRole ()
	get the role of accessible parent object which is observed More...

void	RemoveMeFromBroadcaster (bool isNotifyDestroy)
	remove the listener from accessible object More...

Protected Attributes
css::uno::Reference< css::accessibility::XAccessible >	m_xAccessible

AccObjectManagerAgent *	pAgent

Detailed Description

AccEventListener is the general event listener for all controls.

It defines the procedure of all the event handling and provides the basic support for some simple methods.

Definition at line 34 of file AccEventListener.hxx.

Constructor & Destructor Documentation

◆ AccEventListener()

AccEventListener::AccEventListener	(	css::accessibility::XAccessible *	pAcc,
		AccObjectManagerAgent *	Agent
	)

Definition at line 43 of file AccEventListener.cxx.

◆ ~AccEventListener()

AccEventListener::~AccEventListener ( )

overridevirtual

Definition at line 50 of file AccEventListener.cxx.

Member Function Documentation

◆ disposing()

void AccEventListener::disposing ( const css::lang::EventObject & Source )

overridevirtual

this method is invoked before listener is disposed

Definition at line 255 of file AccEventListener.cxx.

References RemoveMeFromBroadcaster().

◆ FireStateFocusedChange()

void AccEventListener::FireStateFocusedChange ( bool enable )

virtual

handle the focused event

Parameters

enable true if get focus, false if lose focus

Reimplemented in AccComponentEventListener, and AccContainerEventListener.

Definition at line 161 of file AccEventListener.cxx.

References AccObjectManagerAgent::IncreaseState(), m_xAccessible, AccObjectManagerAgent::NotifyAccEvent(), pAgent, and STATE_FOCUSED.

Referenced by SetComponentState().

◆ FireStatePropertyChange()

void AccEventListener::FireStatePropertyChange	(	sal_Int64	state,
		bool	set
	)

virtual

fire the MSAA state changed event

Parameters

state	the state id
set	true if state is set, false if state is unset

Reimplemented in AccComponentEventListener, AccContainerEventListener, and AccMenuEventListener.

Definition at line 179 of file AccEventListener.cxx.

References set().

Referenced by SetComponentState().

◆ GetParentRole()

short AccEventListener::GetParentRole ( )

virtual

get the role of accessible parent object which is observed

Definition at line 208 of file AccEventListener.cxx.

References AccObjectManagerAgent::GetParentRole(), m_xAccessible, and pAgent.

Referenced by AccComponentEventListener::FireStateFocusedChange(), AccContainerEventListener::FireStateFocusedChange(), and AccListEventListener::HandleValueChangedEvent().

◆ GetRole()

short AccEventListener::GetRole ( )

virtual

get the role of accessible object which is observed

Definition at line 194 of file AccEventListener.cxx.

References m_xAccessible.

Referenced by AccContainerEventListener::FireStateFocusedChange(), AccContainerEventListener::HandleNameChangedEvent(), AccContainerEventListener::HandleSelectionChangedEvent(), AccComponentEventListener::SetComponentState(), and AccContainerEventListener::SetComponentState().

◆ HandleBoundrectChangedEvent()

void AccEventListener::HandleBoundrectChangedEvent ( )

virtual

handle the BOUNDRECT_CHANGED event

Definition at line 107 of file AccEventListener.cxx.

References BOUNDRECT_CHANGED, m_xAccessible, AccObjectManagerAgent::NotifyAccEvent(), and pAgent.

Referenced by AccObjectContainerEventListener::HandleVisibleDataChangedEvent(), AccComponentEventListener::notifyEvent(), AccContainerEventListener::notifyEvent(), AccDialogEventListener::notifyEvent(), AccFrameEventListener::notifyEvent(), AccParagraphEventListener::notifyEvent(), and AccWindowEventListener::notifyEvent().

◆ HandleDescriptionChangedEvent()

void AccEventListener::HandleDescriptionChangedEvent ( )

virtual

handle the DESCRIPTION_CHANGED event

Definition at line 99 of file AccEventListener.cxx.

References m_xAccessible, AccObjectManagerAgent::NotifyAccEvent(), OBJECT_DESCRIPTIONCHANGE, and pAgent.

Referenced by notifyEvent().

◆ HandleNameChangedEvent()

void AccEventListener::HandleNameChangedEvent ( css::uno::Any name )

virtual

handle the NAME_CHANGED event

Parameters

name	the new name with changed.

Reimplemented in AccContainerEventListener.

Definition at line 80 of file AccEventListener.cxx.

References AccObjectManagerAgent::GetAccDocByAccTopWin(), AccObjectManagerAgent::IsTopWinAcc(), m_xAccessible, name, AccObjectManagerAgent::NotifyAccEvent(), OBJECT_NAMECHANGE, pAgent, and AccObjectManagerAgent::UpdateAccName().

Referenced by AccContainerEventListener::HandleNameChangedEvent(), and notifyEvent().

◆ HandleStateChangedEvent()

void AccEventListener::HandleStateChangedEvent	(	css::uno::Any	oldValue,
		css::uno::Any	newValue
	)

virtual

handle the STATE_CHANGED event

Parameters

oldValue	the old state of the source of event
newValue	the new state of the source of event

Reimplemented in AccContainerEventListener, and AccObjectContainerEventListener.

Definition at line 126 of file AccEventListener.cxx.

References SetComponentState().

Referenced by notifyEvent().

◆ HandleVisibleDataChangedEvent()

void AccEventListener::HandleVisibleDataChangedEvent ( )

virtual

handle the VISIBLE_DATA_CHANGED event

Reimplemented in AccObjectContainerEventListener.

Definition at line 115 of file AccEventListener.cxx.

References m_xAccessible, AccObjectManagerAgent::NotifyAccEvent(), pAgent, AccObjectManagerAgent::UpdateValue(), and VISIBLE_DATA_CHANGED.

Referenced by AccComponentEventListener::notifyEvent(), AccContainerEventListener::notifyEvent(), AccDialogEventListener::notifyEvent(), AccFrameEventListener::notifyEvent(), AccParagraphEventListener::notifyEvent(), and AccWindowEventListener::notifyEvent().

◆ notifyEvent()

void AccEventListener::notifyEvent ( const css::accessibility::AccessibleEventObject & aEvent )

overridevirtual

Uno's event notifier when event is captured.

Parameters

AccessibleEventObject the event object which contains information about event

Reimplemented in AccComponentEventListener, AccContainerEventListener, AccDescendantManagerEventListener, AccDialogEventListener, AccFrameEventListener, AccListEventListener, AccMenuEventListener, AccParagraphEventListener, AccTableEventListener, AccTreeEventListener, and AccWindowEventListener.

Definition at line 56 of file AccEventListener.cxx.

References aEvent, HandleDescriptionChangedEvent(), HandleNameChangedEvent(), and HandleStateChangedEvent().

Referenced by AccComponentEventListener::notifyEvent(), AccContainerEventListener::notifyEvent(), AccDialogEventListener::notifyEvent(), AccFrameEventListener::notifyEvent(), and AccWindowEventListener::notifyEvent().

◆ RemoveMeFromBroadcaster()

void AccEventListener::RemoveMeFromBroadcaster ( bool isNotifyDestroy )

remove the listener from accessible object

Definition at line 219 of file AccEventListener.cxx.

References Exception, m_xAccessible, AccObjectManagerAgent::NotifyDestroy(), and pAgent.

Referenced by disposing().

◆ SetComponentState()

void AccEventListener::SetComponentState	(	sal_Int64	state,
		bool	enable
	)

virtual

set the new state and fire the MSAA event

Parameters

state	new state id
enable	true if state is set, false if state is unset

Reimplemented in AccComponentEventListener, AccContainerEventListener, AccDialogEventListener, AccFrameEventListener, AccParagraphEventListener, AccTextComponentEventListener, and AccWindowEventListener.

Definition at line 144 of file AccEventListener.cxx.

References FireStateFocusedChange(), and FireStatePropertyChange().

Referenced by HandleStateChangedEvent().

Member Data Documentation

◆ m_xAccessible

css::uno::Reference<css::accessibility::XAccessible> AccEventListener::m_xAccessible

protected

Definition at line 38 of file AccEventListener.hxx.

Referenced by FireStateFocusedChange(), AccComponentEventListener::FireStateFocusedChange(), AccContainerEventListener::FireStateFocusedChange(), AccComponentEventListener::FireStatePropertyChange(), AccContainerEventListener::FireStatePropertyChange(), AccMenuEventListener::FireStatePropertyChange(), GetParentRole(), GetRole(), AccComponentEventListener::HandleActionChangedEvent(), AccListEventListener::HandleActiveDescendantChangedEvent(), AccTableEventListener::HandleActiveDescendantChangedEvent(), AccTreeEventListener::HandleActiveDescendantChangedEvent(), AccContainerEventListener::HandleAllChildrenChangedEvent(), HandleBoundrectChangedEvent(), AccComponentEventListener::HandleCaretChangedEvent(), AccParagraphEventListener::HandleCaretChangedEvent(), AccContainerEventListener::HandleChildChangedEvent(), AccDescendantManagerEventListener::HandleChildChangedEvent(), AccDialogEventListener::HandleChildChangedEvent(), AccFrameEventListener::HandleChildChangedEvent(), AccMenuEventListener::HandleChildChangedEvent(), AccWindowEventListener::HandleChildChangedEvent(), AccDescendantManagerEventListener::HandleChildChangedNoFocusEvent(), AccContainerEventListener::HandleColumnChangedEvent(), HandleDescriptionChangedEvent(), HandleNameChangedEvent(), AccContainerEventListener::HandleNameChangedEvent(), AccContainerEventListener::HandlePageChangedEvent(), AccContainerEventListener::HandleSectionChangedEvent(), AccContainerEventListener::HandleSelectionChangedAddEvent(), AccDescendantManagerEventListener::HandleSelectionChangedAddEvent(), AccContainerEventListener::HandleSelectionChangedEvent(), AccDescendantManagerEventListener::HandleSelectionChangedEvent(), AccComponentEventListener::HandleSelectionChangedEventNoArgs(), AccMenuEventListener::HandleSelectionChangedEventNoArgs(), AccContainerEventListener::HandleSelectionChangedRemoveEvent(), AccDescendantManagerEventListener::HandleSelectionChangedRemoveEvent(), AccContainerEventListener::HandleSelectionChangedWithinEvent(), AccDescendantManagerEventListener::HandleSelectionChangedWithinEvent(), AccObjectContainerEventListener::HandleStateChangedEvent(), AccTableEventListener::HandleTableModelChangeEvent(), AccComponentEventListener::HandleTextChangedEvent(), AccContainerEventListener::HandleTextChangedEvent(), AccComponentEventListener::HandleTextSelectionChangedEvent(), AccParagraphEventListener::HandleTextSelectionChangedEvent(), AccComponentEventListener::HandleValueChangedEvent(), AccContainerEventListener::HandleValueChangedEvent(), AccListEventListener::HandleValueChangedEvent(), HandleVisibleDataChangedEvent(), AccDescendantManagerEventListener::NotifyChildEvent(), AccParagraphEventListener::notifyEvent(), AccTableEventListener::notifyEvent(), RemoveMeFromBroadcaster(), AccComponentEventListener::SetComponentState(), AccContainerEventListener::SetComponentState(), AccDialogEventListener::SetComponentState(), AccFrameEventListener::SetComponentState(), and AccWindowEventListener::SetComponentState().

◆ pAgent

AccObjectManagerAgent* AccEventListener::pAgent

protected

Definition at line 40 of file AccEventListener.hxx.

Referenced by FireStateFocusedChange(), AccComponentEventListener::FireStateFocusedChange(), AccContainerEventListener::FireStateFocusedChange(), AccComponentEventListener::FireStatePropertyChange(), AccContainerEventListener::FireStatePropertyChange(), AccMenuEventListener::FireStatePropertyChange(), GetParentRole(), AccComponentEventListener::HandleActionChangedEvent(), AccListEventListener::HandleActiveDescendantChangedEvent(), AccTableEventListener::HandleActiveDescendantChangedEvent(), AccTreeEventListener::HandleActiveDescendantChangedEvent(), AccContainerEventListener::HandleAllChildrenChangedEvent(), HandleBoundrectChangedEvent(), AccComponentEventListener::HandleCaretChangedEvent(), AccParagraphEventListener::HandleCaretChangedEvent(), AccContainerEventListener::HandleChildChangedEvent(), AccDescendantManagerEventListener::HandleChildChangedEvent(), AccDialogEventListener::HandleChildChangedEvent(), AccFrameEventListener::HandleChildChangedEvent(), AccMenuEventListener::HandleChildChangedEvent(), AccWindowEventListener::HandleChildChangedEvent(), AccDescendantManagerEventListener::HandleChildChangedNoFocusEvent(), AccContainerEventListener::HandleColumnChangedEvent(), HandleDescriptionChangedEvent(), HandleNameChangedEvent(), AccContainerEventListener::HandleNameChangedEvent(), AccContainerEventListener::HandlePageChangedEvent(), AccContainerEventListener::HandleSectionChangedEvent(), AccContainerEventListener::HandleSelectionChangedAddEvent(), AccDescendantManagerEventListener::HandleSelectionChangedAddEvent(), AccContainerEventListener::HandleSelectionChangedEvent(), AccDescendantManagerEventListener::HandleSelectionChangedEvent(), AccComponentEventListener::HandleSelectionChangedEventNoArgs(), AccMenuEventListener::HandleSelectionChangedEventNoArgs(), AccContainerEventListener::HandleSelectionChangedRemoveEvent(), AccDescendantManagerEventListener::HandleSelectionChangedRemoveEvent(), AccContainerEventListener::HandleSelectionChangedWithinEvent(), AccDescendantManagerEventListener::HandleSelectionChangedWithinEvent(), AccObjectContainerEventListener::HandleStateChangedEvent(), AccTableEventListener::HandleTableModelChangeEvent(), AccComponentEventListener::HandleTextChangedEvent(), AccContainerEventListener::HandleTextChangedEvent(), AccComponentEventListener::HandleTextSelectionChangedEvent(), AccParagraphEventListener::HandleTextSelectionChangedEvent(), AccComponentEventListener::HandleValueChangedEvent(), AccContainerEventListener::HandleValueChangedEvent(), AccListEventListener::HandleValueChangedEvent(), HandleVisibleDataChangedEvent(), AccContainerEventListener::NotifyChildEvent(), AccDescendantManagerEventListener::NotifyChildEvent(), AccParagraphEventListener::notifyEvent(), AccTableEventListener::notifyEvent(), RemoveMeFromBroadcaster(), AccComponentEventListener::SetComponentState(), AccContainerEventListener::SetComponentState(), AccDialogEventListener::SetComponentState(), AccFrameEventListener::SetComponentState(), AccWindowEventListener::SetComponentState(), and AccContainerEventListener::UpdateAllChildrenState().

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