LibreOffice Module winaccessibility (master) 1
AccObjectManagerAgent.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#pragma once
21
22#include <memory>
23
24#include <prewin.h>
25#include <Windows.h>
26#include <postwin.h>
27
28#include <com/sun/star/accessibility/XAccessible.hpp>
29
30struct IMAccessible;
31struct IAccessible;
33enum class UnoMSAAEvent;
34
35/****************************************************************
36AccObjectManagerAgent is used for managing AccObjects, which encapsulates
37platform differences,and call AccObjectWinManager for Windows platform. To do for
38Linux platform
39*****************************************************************/
41{
42private:
43
44 std::unique_ptr<AccObjectWinManager> pWinManager;
45
46public:
47
49 virtual ~AccObjectManagerAgent();
50
51 virtual bool InsertAccObj(css::accessibility::XAccessible* pXAcc,
52 css::accessibility::XAccessible* pParentXAcc,
53 HWND hWnd = nullptr);
54 virtual void GetIAccessibleFromResID(long childID,IMAccessible**);
55 virtual bool GetIAccessibleFromXAccessible(css::accessibility::XAccessible* pXAcc, IAccessible** ppIA);
56
57 virtual void DeleteAccObj( css::accessibility::XAccessible* pXAcc );
58 virtual IMAccessible* GetIMAccByXAcc(css::accessibility::XAccessible* pXAcc);
59
60 bool NotifyAccEvent(UnoMSAAEvent eEvent, css::accessibility::XAccessible* pXAcc = nullptr);
61
62 bool InsertChildrenAccObj(css::accessibility::XAccessible* pXAcc,
63 HWND hWnd = nullptr);
64 void DeleteChildrenAccObj( css::accessibility::XAccessible* pXAcc );
65
66 void DecreaseState( css::accessibility::XAccessible* pXAcc, sal_Int64 pState );
67 void IncreaseState( css::accessibility::XAccessible* pXAcc, sal_Int64 pState );
68 void UpdateState( css::accessibility::XAccessible* pXAcc );
69
70 void UpdateAction( css::accessibility::XAccessible* pXAcc );
71
72 void UpdateValue( css::accessibility::XAccessible* pXAcc );
73 void UpdateValue( css::accessibility::XAccessible* pXAcc, css::uno::Any );
74
75 void UpdateAccName( css::accessibility::XAccessible* pXAcc, css::uno::Any newName);
76 void UpdateAccName( css::accessibility::XAccessible* pXAcc);
77
78 void NotifyDestroy(css::accessibility::XAccessible* pXAcc);
79
80 css::accessibility::XAccessible* GetParentXAccessible( css::accessibility::XAccessible* pXAcc );
81 short GetParentRole(css::accessibility::XAccessible* pXAcc );
82 bool IsContainer(css::accessibility::XAccessible* pXAcc);
83
84 void SaveTopWindowHandle(HWND hWnd, css::accessibility::XAccessible* pXAcc);
85
86 void UpdateChildState(css::accessibility::XAccessible* pXAcc);
87
88 bool IsSpecialToolbarItem(css::accessibility::XAccessible* pXAcc);
89
90 short GetRole(css::accessibility::XAccessible* pXAcc);
91
92 css::accessibility::XAccessible* GetAccDocByAccTopWin( css::accessibility::XAccessible* pXAcc );
93 bool IsTopWinAcc( css::accessibility::XAccessible* pXAcc );
94
95 bool IsStateManageDescendant(css::accessibility::XAccessible* pXAcc);
96
97 sal_Int64 Get_ToATInterface(sal_Int64 hWnd, sal_Int64 lParam, sal_Int64 wParam);
98
99};
100
101/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
short GetParentRole(css::accessibility::XAccessible *pXAcc)
void UpdateValue(css::accessibility::XAccessible *pXAcc, css::uno::Any)
css::accessibility::XAccessible * GetAccDocByAccTopWin(css::accessibility::XAccessible *pXAcc)
bool IsSpecialToolbarItem(css::accessibility::XAccessible *pXAcc)
virtual void GetIAccessibleFromResID(long childID, IMAccessible **)
Return com object interface by querying child id.
void DecreaseState(css::accessibility::XAccessible *pXAcc, sal_Int64 pState)
Interface of decreasing MSAA state when some UNO state is decreased.
short GetRole(css::accessibility::XAccessible *pXAcc)
virtual void DeleteAccObj(css::accessibility::XAccessible *pXAcc)
When a new UNO XAccessible object is destroyed, we delete its corresponding com object and remove it ...
void UpdateValue(css::accessibility::XAccessible *pXAcc)
virtual bool GetIAccessibleFromXAccessible(css::accessibility::XAccessible *pXAcc, IAccessible **ppIA)
Return object interface by querying interface.
void UpdateAction(css::accessibility::XAccessible *pXAcc)
Interface of updating MSAA name when UNO action changed event occurs.
void UpdateAccName(css::accessibility::XAccessible *pXAcc, css::uno::Any newName)
bool IsStateManageDescendant(css::accessibility::XAccessible *pXAcc)
void SaveTopWindowHandle(HWND hWnd, css::accessibility::XAccessible *pXAcc)
save the pair <topwindowhandle, XAccessible>
void IncreaseState(css::accessibility::XAccessible *pXAcc, sal_Int64 pState)
Interface of increasing MSAA name when some UNO state is increased.
virtual IMAccessible * GetIMAccByXAcc(css::accessibility::XAccessible *pXAcc)
Return com object interface by querying XAccessible interface.
void UpdateAccName(css::accessibility::XAccessible *pXAcc)
AccObjectManagerAgent()
Construction/Destruction.
sal_Int64 Get_ToATInterface(sal_Int64 hWnd, sal_Int64 lParam, sal_Int64 wParam)
Implementation of interface XMSAAService's method getAccObjectPtr() that returns the corresponding CO...
void DeleteChildrenAccObj(css::accessibility::XAccessible *pXAcc)
When new UNO children XAccessible objects are destroyed, we delete their corresponding com objects an...
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 inse...
bool IsContainer(css::accessibility::XAccessible *pXAcc)
Judge whether a XAccessible object is a container object.
css::accessibility::XAccessible * GetParentXAccessible(css::accessibility::XAccessible *pXAcc)
bool NotifyAccEvent(UnoMSAAEvent eEvent, css::accessibility::XAccessible *pXAcc=nullptr)
Interface of notify MSAA event when some UNO event occurred.
void UpdateChildState(css::accessibility::XAccessible *pXAcc)
bool IsTopWinAcc(css::accessibility::XAccessible *pXAcc)
std::unique_ptr< AccObjectWinManager > pWinManager
void NotifyDestroy(css::accessibility::XAccessible *pXAcc)
Notify manager when a XAccessible object is destroying.
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 objec...
void UpdateState(css::accessibility::XAccessible *pXAcc)
UnoMSAAEvent