1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_WINACCESSIBILITY_SOURCE_UACCCOM_MACCESSIBLE_H
#define INCLUDED_WINACCESSIBILITY_SOURCE_UACCCOM_MACCESSIBLE_H
#include "Resource.h" // main symbols
#include <map>
#include <com/sun/star/accessibility/XAccessible.hpp>
#include <com/sun/star/accessibility/XAccessibleSelection.hpp>
#include <com/sun/star/accessibility/XAccessibleAction.hpp>
#include <AccObjectManagerAgent.hxx>
#include "EnumVariant.h"
#include "acccommon.h"
#include <rtl/ustring.hxx>
#define OBJID_WINDOW ((LONG)0x00000000)
#define OBJID_SYSMENU ((LONG)0xFFFFFFFF)
#define OBJID_TITLEBAR ((LONG)0xFFFFFFFE)
#define OBJID_MENU ((LONG)0xFFFFFFFD)
#define OBJID_CLIENT ((LONG)0xFFFFFFFC)
#define OBJID_VSCROLL ((LONG)0xFFFFFFFB)
#define OBJID_HSCROLL ((LONG)0xFFFFFFFA)
#define OBJID_SIZEGRIP ((LONG)0xFFFFFFF9)
#define OBJID_CARET ((LONG)0xFFFFFFF8)
#define OBJID_CURSOR ((LONG)0xFFFFFFF7)
#define OBJID_ALERT ((LONG)0xFFFFFFF6)
#define OBJID_SOUND ((LONG)0xFFFFFFF5)
#define OBJID_QUERYCLASSNAMEIDX ((LONG)0xFFFFFFF4)
#define OBJID_NATIVEOM ((LONG)0xFFFFFFF0)
/**
*This class implements IMAccessible interface, which inherits from IAccessible2, and
*in turn inherits from IAccessible. So its methods include the methods defined only in
*IAccessible, plus the methods defined only in IAccessible2, plus the methods defined
*only in IMAccessible.
*/
class ATL_NO_VTABLE CMAccessible :
public CComObjectRoot,
public CComCoClass<CMAccessible, &CLSID_MAccessible>,
public IDispatchImpl<IMAccessible, &IID_IMAccessible, &LIBID_UACCCOMLib>,
public IServiceProvider,
public IAccessibleApplication
{
typedef ::std::map<const GUID, CComPtr<IUnknown>, ltComp> XGUIDToComObjHash;
public:
CMAccessible();
virtual ~CMAccessible();
DECLARE_NO_REGISTRY()
DECLARE_GET_CONTROLLING_UNKNOWN()
DECLARE_PROTECT_FINAL_CONSTRUCT()
BEGIN_COM_MAP(CMAccessible)
COM_INTERFACE_ENTRY(IMAccessible)
COM_INTERFACE_ENTRY(IAccessible)
COM_INTERFACE_ENTRY(IAccessible2)
COM_INTERFACE_ENTRY(IDispatch)
COM_INTERFACE_ENTRY(IAccessibleApplication)
COM_INTERFACE_ENTRY(IServiceProvider)
COM_INTERFACE_ENTRY_FUNC_BLIND(NULL,SmartQI_)
#if defined __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Winconsistent-missing-override"
#endif
END_COM_MAP()
#if defined __clang__
#pragma clang diagnostic pop
#endif
// IMAccessible
STDMETHOD(put_accValue)(VARIANT varChild,BSTR szValue) override;
STDMETHOD(put_accName)(VARIANT varChild,BSTR szName) override;
STDMETHOD(accDoDefaultAction)(VARIANT varChild) override;
STDMETHOD(accHitTest)(long xLeft,long yTop,VARIANT *pvarChild) override;
STDMETHOD(accNavigate)(long navDir,VARIANT varStart,VARIANT *pvarEndUpAt) override;
STDMETHOD(accLocation)(long *pxLeft,long *pyTop,long *pcxWidth,long *pcyHeight,VARIANT varChild) override;
STDMETHOD(accSelect)(long flagsSelect,VARIANT varChild) override;
STDMETHOD(get_accDefaultAction)( VARIANT varChild,BSTR *pszDefaultAction) override;
STDMETHOD(get_accSelection)(VARIANT *pvarChildren) override;
STDMETHOD(get_accFocus)(VARIANT *pvarChild) override;
STDMETHOD(get_accKeyboardShortcut)( VARIANT varChild,BSTR *pszKeyboardShortcut) override;
STDMETHOD(get_accHelpTopic)(BSTR *pszHelpFile,VARIANT varChild,long *pidTopic) override;
STDMETHOD(get_accHelp)(VARIANT varChild,BSTR *pszHelp) override;
STDMETHOD(get_accState)(VARIANT varChild,VARIANT *pvarState) override;
STDMETHOD(get_accRole)(VARIANT varChild,VARIANT *pvarRole) override;
STDMETHOD(get_accDescription)(VARIANT varChild,BSTR *pszDescription) override;
STDMETHOD(get_accValue)( VARIANT varChild,BSTR *pszValue) override;
STDMETHOD(get_accName)(VARIANT varChild,BSTR *pszName) override;
STDMETHOD(get_accChild)(VARIANT varChild,IDispatch **ppdispChild) override;
STDMETHOD(get_accChildCount)(long *pcountChildren) override;
STDMETHOD(get_accParent)( IDispatch **ppdispParent) override;
// methods which are defined only in the IAccessible2
// These methods only declare here, and their implementation bodies are empty now.
STDMETHOD(get_nRelations)( long __RPC_FAR *nRelations) override;
STDMETHOD(get_relation)( long relationIndex, IAccessibleRelation __RPC_FAR *__RPC_FAR *relation) override;
STDMETHOD(get_relations)( long maxRelations, IAccessibleRelation __RPC_FAR *__RPC_FAR *relation, long __RPC_FAR *nRelations) override;
STDMETHOD(role)(long __RPC_FAR *role) override;
STDMETHOD(get_nActions)(long __RPC_FAR *nActions);
STDMETHOD(scrollTo)(enum IA2ScrollType scrollType) override;
STDMETHOD(scrollToPoint)(enum IA2CoordinateType coordinateType, long x, long y) override;
STDMETHOD(get_groupPosition)(long __RPC_FAR *groupLevel,long __RPC_FAR *similarItemsInGroup,long __RPC_FAR *positionInGroup) override;
STDMETHOD(get_states)( AccessibleStates __RPC_FAR *states ) override;
STDMETHOD(get_extendedRole)( BSTR __RPC_FAR *extendedRole ) override;
STDMETHOD(get_localizedExtendedRole)( BSTR __RPC_FAR *localizedExtendedRole ) override;
STDMETHOD(get_nExtendedStates)( long __RPC_FAR *nExtendedStates) override;
STDMETHOD(get_extendedStates)( long maxExtendedStates, BSTR __RPC_FAR *__RPC_FAR *extendedStates, long __RPC_FAR *nExtendedStates) override;
STDMETHOD(get_localizedExtendedStates)(long maxLocalizedExtendedStates,BSTR __RPC_FAR *__RPC_FAR *localizedExtendedStates,long __RPC_FAR *nLocalizedExtendedStates) override;
STDMETHOD(get_uniqueID)(long __RPC_FAR *uniqueID) override;
STDMETHOD(get_windowHandle)(HWND __RPC_FAR *windowHandle) override;
STDMETHOD(get_indexInParent)( long __RPC_FAR *accParentIndex ) override;
STDMETHOD(get_locale)( IA2Locale __RPC_FAR *locale ) override;
STDMETHOD(get_attributes)(/*[out]*/ BSTR *pAttr) override;
//IServiceProvider.
STDMETHOD(QueryService)(REFGUID guidService, REFIID riid, void** ppvObject) override;
//IAccessibleApplication
STDMETHOD(get_appName)(BSTR __RPC_FAR *name) override;
STDMETHOD(get_appVersion)(BSTR __RPC_FAR *version) override;
STDMETHOD(get_toolkitName)(BSTR __RPC_FAR *name) override;
STDMETHOD(get_toolkitVersion)(BSTR __RPC_FAR *version) override;
// methods which are defined only in IMAccessible
// These methods are provided for UNO management system.
// The UNO management system use these methods to put Accessibility
// information to COM.
STDMETHOD(Put_XAccName)(const OLECHAR __RPC_FAR *pszName) override;
STDMETHOD(Put_XAccRole)(unsigned short pRole) override;
STDMETHOD(DecreaseState)(DWORD pXSate) override;
STDMETHOD(IncreaseState)(DWORD pXSate) override;
STDMETHOD(SetState)(DWORD pXSate) override;
STDMETHOD(Put_XAccDescription)(const OLECHAR __RPC_FAR *pszDescription) override;
STDMETHOD(Put_XAccValue)(const OLECHAR __RPC_FAR *pszAccValue) override;
STDMETHOD(Put_XAccLocation)(const Location sLocation) override;
STDMETHOD(Put_XAccFocus)(long dChildID) override;
STDMETHOD(Put_XAccParent)(IMAccessible __RPC_FAR *pIParent) override;
STDMETHOD(Put_XAccWindowHandle)(HWND hwnd) override;
STDMETHOD(Put_XAccChildID)(long dChildID) override;
STDMETHOD(Put_XAccAgent)(hyper pAgent) override;
STDMETHOD(NotifyDestroy)(BOOL isDestroy) override;
STDMETHOD(Put_ActionDescription)( const OLECHAR* szAction) override;
STDMETHOD(SetDefaultAction)(hyper pAction) override;
STDMETHOD(GetUNOInterface)(hyper*) override;
STDMETHOD(SetXAccessible)(hyper) override;
private:
OLECHAR* m_pszName;
OLECHAR* m_pszValue;
OLECHAR* m_pszActionDescription;
unsigned short m_iRole;
DWORD m_dState;
OLECHAR* m_pszDescription;
IMAccessible* m_pIParent;
Location m_sLocation;
// identify a COM object/Acc object uniquely
long m_dChildID;
// specify the focus child ID in object self and its direct children
long m_dFocusChildID;
// parent window handle,will be used in the future application, its value comes from UNO
HWND m_hwnd;
// the COM class which implements IEnumVARIANT interface,currently only used in
// the implementation of get_accSelection
CEnumVariant* m_pEnumVar;
// specify if the XAccessible is invalid
BOOL m_isDestroy;
css::uno::Reference<css::accessibility::XAccessible> m_xAccessible;
// initially m_xAction and m_xContext are the same object
// but they may be different once AccObject::UpdateAction() is called?
css::uno::Reference<css::accessibility::XAccessibleAction> m_xAction;
css::uno::Reference<css::accessibility::XAccessibleContext> m_xContext;
private:
// the helper methods in order to implement the above public methods
IMAccessible* GetChildInterface(long dChildIndex);//notice here the parameter is child index,not child id
IMAccessible* GetNavigateChildForDM(VARIANT varCur,short flags);//for descendant manage
HRESULT GetFirstChild(VARIANT varStart,VARIANT* pvarEndUpAt);//for accNavigate implementation
HRESULT GetLastChild(VARIANT varStart,VARIANT* pvarEndUpAt);//for accNavigate implementation
HRESULT GetNextSibling(VARIANT varStart,VARIANT* pvarEndUpAt);//for accNavigate implementation
HRESULT GetPreSibling(VARIANT varStart,VARIANT* pvarEndUpAt);//for accNavigate implementation
BOOL IsDescendantManage();//identify whether the current COM belongs to manage_descendant roles
// the following private methods are used to implement accSelect method
HRESULT SelectChild(css::accessibility::XAccessible* pItem);
HRESULT DeSelectChild(css::accessibility::XAccessible* pItem);
HRESULT SelectMultipleChidren(css::accessibility::XAccessible** pItem,
int size);
HRESULT DeSelectMultipleChildren(css::accessibility::XAccessible** pItem,
int size);
static css::accessibility::XAccessibleContext* GetContextByXAcc(
css::accessibility::XAccessible* pXAcc);
css::uno::Reference<css::accessibility::XAccessibleSelection> GetSelection();
// end accSelect implementation methods
static BOOL GetXInterfaceFromXAccessible(css::accessibility::XAccessible*,
css::uno::XInterface**, int);
HRESULT WINAPI SmartQI(void* pv, REFIID iid, void** ppvObject);
public:
STDMETHOD(Get_XAccChildID)(/*[out,retval]*/ long* childID) override;
// AccObjectManagerAgent is a management object in UNO, here keep its pointer for
// the implementation of accNavigate when descendant manage happens for List,Tree, or Table
// AccObjectManagerAgent and the following UNO objects XAccessble,XAccessibleSelection,
// XAccessibleAction are all used to operate UNO accessiblility information directly when
// implement some specific MSAA methods,such as accSelection,accNavigate
static AccObjectManagerAgent* g_pAgent;
static BOOL get_IAccessibleFromXAccessible(
css::accessibility::XAccessible * pXAcc, IAccessible** ppIA);
BOOL m_bRequiresSave;
XGUIDToComObjHash m_containedObjects;
static HRESULT WINAPI SmartQI_(void* pv,
REFIID iid, void** ppvObject, DWORD_PTR)
{
return static_cast<CMAccessible*>(pv)->SmartQI(pv,iid,ppvObject);
}
static void get_OLECHARFromAny(css::uno::Any& pAny, OLECHAR* pChar);
static void get_OLECHAR4Numbering(const css::uno::Any& pAny,
short numberingLevel, const OUString& numberingPrefix,
OLECHAR* pChar);
// Helper function for data conversion.
static void ConvertAnyToVariant(const css::uno::Any &rAnyVal,
VARIANT *pvData);
};
#endif // INCLUDED_WINACCESSIBILITY_SOURCE_UACCCOM_MACCESSIBLE_H
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
