strepsirrhini/office-gobmx
9
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
office-gobmx/winaccessibility/source/UAccCOM/MAccessible.h
Michael Weghorn 5ba7e1586f wina11y: Use enum class for navigation direction 
Switch the `DM_NIR` enum to an enum class
`NavigationDirection` and move it to MAccessible.{h,cxx}
which is the only place where it's used.

The param name of "flags" previously used in
CMAccessible::GetNavigateChildForDM was misleading,
as any of the values can only be handled exclusively.

Change-Id: I39d8d6afc5c8c845b3aa0add7bd314501f4c91b1
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/174320
Reviewed-by: Michael Weghorn <m.weghorn@posteo.de>
Tested-by: Jenkins
2024-10-01 17:47:56 +02:00

223 lines
10 KiB
C++
Raw Blame History

/* -*- 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 .
*/
#pragma once
#include "stdafx.h"
#include "Resource.h" // main symbols
#include <map>
#include <string_view>
#include <com/sun/star/accessibility/XAccessible.hpp>
#include <com/sun/star/accessibility/XAccessibleSelection.hpp>
#include <com/sun/star/accessibility/XAccessibleAction.hpp>
#include <AccObjectWinManager.hxx>
#include "EnumVariant.h"
#include "acccommon.h"
#include <rtl/ustring.hxx>
namespace {
enum class XInterfaceType;
enum class NavigationDirection;
}
/**
*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(IAccessible2_2)
COM_INTERFACE_ENTRY(IDispatch)
COM_INTERFACE_ENTRY(IAccessibleApplication)
COM_INTERFACE_ENTRY(IServiceProvider)
COM_INTERFACE_ENTRY_FUNC_BLIND(0,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
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;
// IAccessible2_2 methods
STDMETHOD(get_attribute)(BSTR name, VARIANT* attribute) override;
STDMETHOD(get_accessibleWithCaret)(IUnknown** accessible, long* caretOffset) override;
STDMETHOD(get_relationTargetsOfType)(BSTR type, long maxTargets, IUnknown*** targets, long* nTargets) 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_XAccRole)(unsigned short pRole) override;
STDMETHOD(DecreaseState)(DWORD pXSate) override;
STDMETHOD(IncreaseState)(DWORD pXSate) override;
STDMETHOD(SetState)(DWORD pXSate) override;
STDMETHOD(Put_XAccValue)(const OLECHAR __RPC_FAR *pszAccValue) 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_XAccObjectManager)(hyper pManager) override;
STDMETHOD(NotifyDestroy)() override;
STDMETHOD(SetXAccessible)(hyper) override;
private:
BSTR m_pszValue;
BSTR m_pszActionDescription;
unsigned short m_iRole;
DWORD m_dState;
IMAccessible* m_pIParent;
// 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;
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, NavigationDirection eDirection);
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
static css::accessibility::XAccessibleContext* GetContextByXAcc(
css::accessibility::XAccessible* pXAcc);
static bool GetXInterfaceFromXAccessible(css::accessibility::XAccessible*,
css::uno::XInterface**, XInterfaceType);
HRESULT WINAPI SmartQI(void* pv, REFIID iid, void** ppvObject);
public:
// AccObjectWinManager is a management object in UNO, here keep its pointer for
// the implementation of accNavigate when descendant manage happens for List,Tree, or Table
// AccObjectWinManager and the following UNO objects XAccessible,XAccessibleSelection,
// XAccessibleAction are all used to operate UNO accessibility information directly when
// implement some specific MSAA methods,such as accSelection,accNavigate
static AccObjectWinManager* g_pAccObjectManager;
static IAccessible* get_IAccessibleFromXAccessible(css::accessibility::XAccessible* pXAcc);
XGUIDToComObjHash m_containedObjects;
static HRESULT WINAPI SmartQI_(void* pv,
REFIID iid, void** ppvObject, DWORD_PTR)
{
return static_cast<CMAccessible*>(pv)->SmartQI(pv,iid,ppvObject);
}
// Helper function for data conversion.
static void ConvertAnyToVariant(const css::uno::Any &rAnyVal,
VARIANT *pvData);
};
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in a new issue View git blame Copy permalink