LibreOffice Module winaccessibility (master) 1
Public Member Functions | Private Attributes | List of all members
AccObjectManagerAgent Class Reference

#include <AccObjectManagerAgent.hxx>

Public Member Functions

 AccObjectManagerAgent ()
 Construction/Destruction. More...
 
virtual ~AccObjectManagerAgent ()
 
virtual bool InsertAccObj (css::accessibility::XAccessible *pXAcc, css::accessibility::XAccessible *pParentXAcc, HWND hWnd=nullptr)
 When a new UNO XAccessible object is found by listener, we create a corresponding com object and insert it to our manager list. More...
 
virtual void GetIAccessibleFromResID (long childID, IMAccessible **)
 Return com object interface by querying child id. More...
 
virtual bool GetIAccessibleFromXAccessible (css::accessibility::XAccessible *pXAcc, IAccessible **ppIA)
 Return object interface by querying interface. More...
 
virtual void DeleteAccObj (css::accessibility::XAccessible *pXAcc)
 When a new UNO XAccessible object is destroyed, we delete its corresponding com object and remove it from our manager list. More...
 
virtual IMAccessible * GetIMAccByXAcc (css::accessibility::XAccessible *pXAcc)
 Return com object interface by querying XAccessible interface. More...
 
bool NotifyAccEvent (UnoMSAAEvent eEvent, css::accessibility::XAccessible *pXAcc=nullptr)
 Interface of notify MSAA event when some UNO event occurred. More...
 
bool InsertChildrenAccObj (css::accessibility::XAccessible *pXAcc, HWND hWnd=nullptr)
 When a UNO XAccessible object's new children are found by listener, we create corresponding com objects and insert them to our manager list. More...
 
void DeleteChildrenAccObj (css::accessibility::XAccessible *pXAcc)
 When new UNO children XAccessible objects are destroyed, we delete their corresponding com objects and remove them from our manager list. More...
 
void DecreaseState (css::accessibility::XAccessible *pXAcc, sal_Int64 pState)
 Interface of decreasing MSAA state when some UNO state is decreased. More...
 
void IncreaseState (css::accessibility::XAccessible *pXAcc, sal_Int64 pState)
 Interface of increasing MSAA name when some UNO state is increased. More...
 
void UpdateState (css::accessibility::XAccessible *pXAcc)
 
void UpdateAction (css::accessibility::XAccessible *pXAcc)
 Interface of updating MSAA name when UNO action changed event occurs. More...
 
void UpdateValue (css::accessibility::XAccessible *pXAcc)
 
void UpdateValue (css::accessibility::XAccessible *pXAcc, css::uno::Any)
 
void UpdateAccName (css::accessibility::XAccessible *pXAcc, css::uno::Any newName)
 
void UpdateAccName (css::accessibility::XAccessible *pXAcc)
 
void NotifyDestroy (css::accessibility::XAccessible *pXAcc)
 Notify manager when a XAccessible object is destroying. More...
 
css::accessibility::XAccessible * GetParentXAccessible (css::accessibility::XAccessible *pXAcc)
 
short GetParentRole (css::accessibility::XAccessible *pXAcc)
 
bool IsContainer (css::accessibility::XAccessible *pXAcc)
 Judge whether a XAccessible object is a container object. More...
 
void SaveTopWindowHandle (HWND hWnd, css::accessibility::XAccessible *pXAcc)
 save the pair <topwindowhandle, XAccessible> More...
 
void UpdateChildState (css::accessibility::XAccessible *pXAcc)
 
bool IsSpecialToolbarItem (css::accessibility::XAccessible *pXAcc)
 
short GetRole (css::accessibility::XAccessible *pXAcc)
 
css::accessibility::XAccessible * GetAccDocByAccTopWin (css::accessibility::XAccessible *pXAcc)
 
bool IsTopWinAcc (css::accessibility::XAccessible *pXAcc)
 
bool IsStateManageDescendant (css::accessibility::XAccessible *pXAcc)
 
sal_Int64 Get_ToATInterface (sal_Int64 hWnd, sal_Int64 lParam, sal_Int64 wParam)
 Implementation of interface XMSAAService's method getAccObjectPtr() that returns the corresponding COM interface with the MS event. More...
 

Private Attributes

std::unique_ptr< AccObjectWinManager > pWinManager
 

Detailed Description

Definition at line 40 of file AccObjectManagerAgent.hxx.

Constructor & Destructor Documentation

◆ AccObjectManagerAgent()

AccObjectManagerAgent::AccObjectManagerAgent ( )

Construction/Destruction.

Parameters

return

Definition at line 33 of file AccObjectManagerAgent.cxx.

◆ ~AccObjectManagerAgent()

AccObjectManagerAgent::~AccObjectManagerAgent ( )
virtual

Definition at line 38 of file AccObjectManagerAgent.cxx.

Member Function Documentation

◆ DecreaseState()

void AccObjectManagerAgent::DecreaseState ( css::accessibility::XAccessible *  pXAcc,
sal_Int64  pState 
)

Interface of decreasing MSAA state when some UNO state is decreased.

Parameters
pXAccUno XAccessible interface of control.
pStateThe lost state of control.
Returns

Definition at line 176 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccComponentEventListener::FireStateFocusedChange(), AccContainerEventListener::FireStateFocusedChange(), AccComponentEventListener::FireStatePropertyChange(), AccContainerEventListener::FireStatePropertyChange(), AccMenuEventListener::FireStatePropertyChange(), AccDescendantManagerEventListener::HandleSelectionChangedEvent(), AccParagraphEventListener::notifyEvent(), AccComponentEventListener::SetComponentState(), AccContainerEventListener::SetComponentState(), AccDialogEventListener::SetComponentState(), AccFrameEventListener::SetComponentState(), and AccWindowEventListener::SetComponentState().

◆ DeleteAccObj()

void AccObjectManagerAgent::DeleteAccObj ( css::accessibility::XAccessible *  pXAcc)
virtual

When a new UNO XAccessible object is destroyed, we delete its corresponding com object and remove it from our manager list.

Parameters
pXAccUno XAccessible interface of control.
Returns

Definition at line 152 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccListEventListener::HandleActiveDescendantChangedEvent(), AccTableEventListener::HandleActiveDescendantChangedEvent(), AccTreeEventListener::HandleActiveDescendantChangedEvent(), AccContainerEventListener::HandleChildChangedEvent(), AccDescendantManagerEventListener::HandleChildChangedEvent(), AccDialogEventListener::HandleChildChangedEvent(), AccFrameEventListener::HandleChildChangedEvent(), AccMenuEventListener::HandleChildChangedEvent(), AccWindowEventListener::HandleChildChangedEvent(), AccDescendantManagerEventListener::HandleChildChangedNoFocusEvent(), AccDescendantManagerEventListener::NotifyChildEvent(), and AccTopWindowListener::windowClosed().

◆ DeleteChildrenAccObj()

void AccObjectManagerAgent::DeleteChildrenAccObj ( css::accessibility::XAccessible *  pXAcc)

When new UNO children XAccessible objects are destroyed, we delete their corresponding com objects and remove them from our manager list.

Parameters
pXAccUno XAccessible interface of control.
Returns

Definition at line 164 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccContainerEventListener::HandleAllChildrenChangedEvent(), AccContainerEventListener::HandleChildChangedEvent(), AccDescendantManagerEventListener::HandleChildChangedEvent(), AccDialogEventListener::HandleChildChangedEvent(), AccFrameEventListener::HandleChildChangedEvent(), AccMenuEventListener::HandleChildChangedEvent(), AccWindowEventListener::HandleChildChangedEvent(), AccDescendantManagerEventListener::HandleChildChangedNoFocusEvent(), AccTableEventListener::HandleTableModelChangeEvent(), and AccTopWindowListener::windowClosed().

◆ Get_ToATInterface()

sal_Int64 AccObjectManagerAgent::Get_ToATInterface ( sal_Int64  hWnd,
sal_Int64  lParam,
sal_Int64  wParam 
)

Implementation of interface XMSAAService's method getAccObjectPtr() that returns the corresponding COM interface with the MS event.

Returns
Com interface.

Definition at line 352 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccTopWindowListener::GetMSComPtr().

◆ GetAccDocByAccTopWin()

XAccessible * AccObjectManagerAgent::GetAccDocByAccTopWin ( css::accessibility::XAccessible *  pXAcc)

Definition at line 322 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccEventListener::HandleNameChangedEvent().

◆ GetIAccessibleFromResID()

void AccObjectManagerAgent::GetIAccessibleFromResID ( long  childID,
IMAccessible **  pIMAcc 
)
virtual

Return com object interface by querying child id.

Parameters
pXAccUno XAccessible interface of control.
Returns
Com interface.

Definition at line 260 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by CMAccessible::get_accFocus(), and CMAccessible::GetChildInterface().

◆ GetIAccessibleFromXAccessible()

bool AccObjectManagerAgent::GetIAccessibleFromXAccessible ( css::accessibility::XAccessible *  pXAcc,
IAccessible **  ppIA 
)
virtual

Return object interface by querying interface.

Parameters
pXAccUno XAccessible interface of control.
Returns
Com interface.

Definition at line 271 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by CMAccessible::get_IAccessibleFromXAccessible().

◆ GetIMAccByXAcc()

IMAccessible * AccObjectManagerAgent::GetIMAccByXAcc ( css::accessibility::XAccessible *  pXAcc)
virtual

Return com object interface by querying XAccessible interface.

Parameters
pXAccUno XAccessible interface of control.
Returns
Com interface.

Definition at line 236 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by CMAccessible::GetNavigateChildForDM().

◆ GetParentRole()

short AccObjectManagerAgent::GetParentRole ( css::accessibility::XAccessible *  pXAcc)

Definition at line 291 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccEventListener::GetParentRole().

◆ GetParentXAccessible()

XAccessible * AccObjectManagerAgent::GetParentXAccessible ( css::accessibility::XAccessible *  pXAcc)

Definition at line 283 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccListEventListener::HandleValueChangedEvent().

◆ GetRole()

short AccObjectManagerAgent::GetRole ( css::accessibility::XAccessible *  pXAcc)

Definition at line 314 of file AccObjectManagerAgent.cxx.

References AccObjectWinManager::GetRole(), and pWinManager.

Referenced by AccDescendantManagerEventListener::HandleSelectionChangedEvent().

◆ IncreaseState()

void AccObjectManagerAgent::IncreaseState ( css::accessibility::XAccessible *  pXAcc,
sal_Int64  pState 
)

Interface of increasing MSAA name when some UNO state is increased.

Parameters
pXAccUno XAccessible interface of control.
pStateThe new state of control.
Returns

Definition at line 190 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccEventListener::FireStateFocusedChange(), AccContainerEventListener::FireStateFocusedChange(), AccComponentEventListener::FireStatePropertyChange(), AccContainerEventListener::FireStatePropertyChange(), AccMenuEventListener::FireStatePropertyChange(), AccListEventListener::HandleActiveDescendantChangedEvent(), AccDescendantManagerEventListener::HandleSelectionChangedEvent(), AccTopWindowListener::HandleWindowOpened(), AccParagraphEventListener::notifyEvent(), AccComponentEventListener::SetComponentState(), AccContainerEventListener::SetComponentState(), AccDialogEventListener::SetComponentState(), AccFrameEventListener::SetComponentState(), and AccWindowEventListener::SetComponentState().

◆ InsertAccObj()

bool AccObjectManagerAgent::InsertAccObj ( css::accessibility::XAccessible *  pXAcc,
css::accessibility::XAccessible *  pParentXAcc,
HWND  hWnd = nullptr 
)
virtual

When a new UNO XAccessible object is found by listener, we create a corresponding com object and insert it to our manager list.

Parameters
pXAccUno XAccessible interface of control.
pWndThe top window handle containing control.
Returns
If the method is correctly processed.

Definition at line 107 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccTopWindowListener::AddAllListeners(), CMAccessible::ConvertAnyToVariant(), CAccTable::get_accessibleAt(), CAccTableCell::get_columnHeaderCells(), CAccTableCell::get_rowHeaderCells(), CAccTable::get_selectedCells(), CMAccessible::GetChildInterface(), CMAccessible::GetNavigateChildForDM(), AccListEventListener::HandleActiveDescendantChangedEvent(), AccTableEventListener::HandleActiveDescendantChangedEvent(), AccTreeEventListener::HandleActiveDescendantChangedEvent(), AccContainerEventListener::HandleChildChangedEvent(), AccDescendantManagerEventListener::HandleChildChangedEvent(), AccDialogEventListener::HandleChildChangedEvent(), AccFrameEventListener::HandleChildChangedEvent(), AccMenuEventListener::HandleChildChangedEvent(), AccWindowEventListener::HandleChildChangedEvent(), AccDescendantManagerEventListener::HandleChildChangedNoFocusEvent(), and CEnumVariant::Next().

◆ InsertChildrenAccObj()

bool AccObjectManagerAgent::InsertChildrenAccObj ( css::accessibility::XAccessible *  pXAcc,
HWND  hWnd = nullptr 
)

When a UNO XAccessible object's new children are found by listener, we create corresponding com objects and insert them to our manager list.

Parameters
pXAccUno XAccessible interface of control.
pWndThe top window handle containing control.
Returns
If the method is correctly processed.

Definition at line 138 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccContainerEventListener::HandleAllChildrenChangedEvent(), AccContainerEventListener::HandleChildChangedEvent(), AccDescendantManagerEventListener::HandleChildChangedEvent(), AccDialogEventListener::HandleChildChangedEvent(), AccFrameEventListener::HandleChildChangedEvent(), AccMenuEventListener::HandleChildChangedEvent(), AccWindowEventListener::HandleChildChangedEvent(), AccDescendantManagerEventListener::HandleChildChangedNoFocusEvent(), and AccTableEventListener::HandleTableModelChangeEvent().

◆ IsContainer()

bool AccObjectManagerAgent::IsContainer ( css::accessibility::XAccessible *  pXAcc)

Judge whether a XAccessible object is a container object.

Parameters
pXAccUno XAccessible interface of control.
Returns
If the method is correctly processed.

Definition at line 223 of file AccObjectManagerAgent.cxx.

References AccObjectWinManager::IsContainer(), and pWinManager.

Referenced by AccTopWindowListener::AddAllListeners().

◆ IsSpecialToolbarItem()

bool AccObjectManagerAgent::IsSpecialToolbarItem ( css::accessibility::XAccessible *  pXAcc)

Definition at line 306 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccComponentEventListener::FireStatePropertyChange().

◆ IsStateManageDescendant()

bool AccObjectManagerAgent::IsStateManageDescendant ( css::accessibility::XAccessible *  pXAcc)

Definition at line 339 of file AccObjectManagerAgent.cxx.

References AccObjectWinManager::IsStateManageDescendant(), and pWinManager.

Referenced by AccTopWindowListener::AddAllListeners(), AccDescendantManagerEventListener::NotifyChildEvent(), and AccContainerEventListener::UpdateAllChildrenState().

◆ IsTopWinAcc()

bool AccObjectManagerAgent::IsTopWinAcc ( css::accessibility::XAccessible *  pXAcc)

Definition at line 330 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccEventListener::HandleNameChangedEvent().

◆ NotifyAccEvent()

bool AccObjectManagerAgent::NotifyAccEvent ( UnoMSAAEvent  eEvent,
css::accessibility::XAccessible *  pXAcc = nullptr 
)

Interface of notify MSAA event when some UNO event occurred.

Parameters
pXAccUno XAccessible interface of control.
eEventevent type.
Returns
If the method is correctly processed.

Definition at line 210 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccEventListener::FireStateFocusedChange(), AccComponentEventListener::FireStateFocusedChange(), AccContainerEventListener::FireStateFocusedChange(), AccComponentEventListener::FireStatePropertyChange(), AccContainerEventListener::FireStatePropertyChange(), AccComponentEventListener::HandleActionChangedEvent(), AccListEventListener::HandleActiveDescendantChangedEvent(), AccTableEventListener::HandleActiveDescendantChangedEvent(), AccTreeEventListener::HandleActiveDescendantChangedEvent(), AccContainerEventListener::HandleAllChildrenChangedEvent(), AccEventListener::HandleBoundrectChangedEvent(), AccComponentEventListener::HandleCaretChangedEvent(), AccParagraphEventListener::HandleCaretChangedEvent(), AccContainerEventListener::HandleChildChangedEvent(), AccDescendantManagerEventListener::HandleChildChangedEvent(), AccDialogEventListener::HandleChildChangedEvent(), AccFrameEventListener::HandleChildChangedEvent(), AccMenuEventListener::HandleChildChangedEvent(), AccWindowEventListener::HandleChildChangedEvent(), AccContainerEventListener::HandleColumnChangedEvent(), AccEventListener::HandleDescriptionChangedEvent(), AccEventListener::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(), AccTableEventListener::HandleTableModelChangeEvent(), AccComponentEventListener::HandleTextChangedEvent(), AccContainerEventListener::HandleTextChangedEvent(), AccComponentEventListener::HandleTextSelectionChangedEvent(), AccParagraphEventListener::HandleTextSelectionChangedEvent(), AccComponentEventListener::HandleValueChangedEvent(), AccContainerEventListener::HandleValueChangedEvent(), AccListEventListener::HandleValueChangedEvent(), AccEventListener::HandleVisibleDataChangedEvent(), AccTopWindowListener::HandleWindowOpened(), AccContainerEventListener::NotifyChildEvent(), AccDescendantManagerEventListener::NotifyChildEvent(), AccTableEventListener::notifyEvent(), AccContainerEventListener::SetComponentState(), and AccTopWindowListener::windowClosed().

◆ NotifyDestroy()

void AccObjectManagerAgent::NotifyDestroy ( css::accessibility::XAccessible *  pXAcc)

Notify manager when a XAccessible object is destroying.

Parameters
pXAccUno XAccessible interface of control.
Returns
.

Definition at line 249 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccEventListener::RemoveMeFromBroadcaster().

◆ SaveTopWindowHandle()

void AccObjectManagerAgent::SaveTopWindowHandle ( HWND  hWnd,
css::accessibility::XAccessible *  pXAcc 
)

save the pair <topwindowhandle, XAccessible>

Parameters
hWnd,topwindow handle
pXAccXAccessible interface for top window
Returns
void

Definition at line 123 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccTopWindowListener::HandleWindowOpened().

◆ UpdateAccName() [1/2]

void AccObjectManagerAgent::UpdateAccName ( css::accessibility::XAccessible *  pXAcc)

◆ UpdateAccName() [2/2]

void AccObjectManagerAgent::UpdateAccName ( css::accessibility::XAccessible *  pXAcc,
css::uno::Any  newName 
)

Referenced by AccEventListener::HandleNameChangedEvent(), AccContainerEventListener::HandleNameChangedEvent(), and AccObjectContainerEventListener::HandleStateChangedEvent().

◆ UpdateAction()

void AccObjectManagerAgent::UpdateAction ( css::accessibility::XAccessible *  pXAcc)

Interface of updating MSAA name when UNO action changed event occurs.

Parameters
pXAccUno XAccessible interface of control.
Returns

Definition at line 58 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccComponentEventListener::FireStatePropertyChange(), and AccComponentEventListener::HandleActionChangedEvent().

◆ UpdateChildState()

void AccObjectManagerAgent::UpdateChildState ( css::accessibility::XAccessible *  pXAcc)

Definition at line 299 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccMenuEventListener::FireStatePropertyChange().

◆ UpdateState()

void AccObjectManagerAgent::UpdateState ( css::accessibility::XAccessible *  pXAcc)

Definition at line 198 of file AccObjectManagerAgent.cxx.

References pWinManager.

Referenced by AccListEventListener::HandleActiveDescendantChangedEvent(), AccComponentEventListener::SetComponentState(), AccContainerEventListener::SetComponentState(), and AccContainerEventListener::UpdateAllChildrenState().

◆ UpdateValue() [1/2]

void AccObjectManagerAgent::UpdateValue ( css::accessibility::XAccessible *  pXAcc)

Referenced by AccComponentEventListener::HandleTextChangedEvent(), AccContainerEventListener::HandleTextChangedEvent(), AccComponentEventListener::HandleValueChangedEvent(), AccContainerEventListener::HandleValueChangedEvent(), AccListEventListener::HandleValueChangedEvent(), and AccEventListener::HandleVisibleDataChangedEvent().

◆ UpdateValue() [2/2]

void AccObjectManagerAgent::UpdateValue ( css::accessibility::XAccessible *  pXAcc,
css::uno::Any   
)

Member Data Documentation

◆ pWinManager

std::unique_ptr<AccObjectWinManager> AccObjectManagerAgent::pWinManager
private

Definition at line 44 of file AccObjectManagerAgent.hxx.

Referenced by DecreaseState(), DeleteAccObj(), DeleteChildrenAccObj(), Get_ToATInterface(), GetAccDocByAccTopWin(), GetIAccessibleFromResID(), GetIAccessibleFromXAccessible(), GetIMAccByXAcc(), GetParentRole(), GetParentXAccessible(), GetRole(), IncreaseState(), InsertAccObj(), InsertChildrenAccObj(), IsContainer(), IsSpecialToolbarItem(), IsStateManageDescendant(), IsTopWinAcc(), NotifyAccEvent(), NotifyDestroy(), SaveTopWindowHandle(), UpdateAction(), UpdateChildState(), and UpdateState().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:35:19 for LibreOffice Module winaccessibility (master) by doxygen 1.9.3