NVDA Helper
In-process and lite high-speed utilities for NVDA
NvdaInProcUtils Interface Reference

Useful utlity methods that can be executed in-process from NVDA. More...

import <nvdaInProcUtils.idl;

Public Types

typedef voidnvdaRegistrationHandle_t
 

Public Member Functions

error_status_t registerNVDAProcess ([in] handle_t bindingHandle, [out] nvdaRegistrationHandle_t *registrationhandle)
 
error_status_t unregisterNVDAProcess ([in, out] nvdaRegistrationHandle_t *registrationhandle)
 
error_status_t winword_expandToLine ([in] const unsigned long windowHandle, [in] const int offset, [out] int *lineStart, [out] int *lineEnd)
 
error_status_t winword_getTextInRange ([in] const unsigned long windowHandle, [in] const int startOffset, [in] const int endOffset, [in] const long formatConfig, [out] BSTR *text)
 
error_status_t winword_moveByLine ([in] const unsigned long windowHandle, [in] const int offset, [in] const int moveBack, [out] int *newOffset)
 
error_status_t sysListView32_getGroupInfo ([in] const unsigned long windowHandle, [in] int groupIndex, [out, string] BSTR *header, [out, string] BSTR *footer, [out] int *state)
 
error_status_t sysListView32_getColumnContent ([in] const unsigned long windowHandle, [in] int item, [in] int subItem, [out, string] BSTR *text)
 
error_status_t sysListView32_getColumnLocation ([in] const unsigned long windowHandle, [in] int item, [in] int subItem, [out] RECT *location)
 
error_status_t sysListView32_getColumnHeader ([in] const unsigned long windowHandle, [in] int subItem, [out, string] BSTR *text)
 
error_status_t sysListView32_getColumnOrderArray ([in] const unsigned long windowHandle, [in] const int columnCount, [out, size_is(columnCount)] int *columnOrderArray)
 
error_status_t getActiveObject ([in] handle_t bindingHandle, [in, string] const wchar_t *progid, [out] IUnknown **ppUnknown)
 
error_status_t dumpOnCrash ([in] handle_t bindingHandle, [in, string] const wchar_t *minidumpPath)
 
error_status_t IA2Text_findContentDescendant ([in] handle_t bindingHandle, [in] const unsigned long hwnd, [in] long parentID, [in] long what, [out] long *descendantID, [out] long *descendantOffset)
 
error_status_t getTextFromIAccessible ([in] handle_t bindingHandle, [in] const unsigned long hwnd, [in] long parentID, [out, string] BSTR *textBuf, [in, defaultvalue(TRUE)] const boolean recurse, [in, defaultvalue(TRUE)] const boolean includeTopLevelText)
 
error_status_t outlook_getMAPIProp (const long threadID, [in] IUnknown *mapiObject, const unsigned long mapiPropTag, [out] VARIANT *val)
 
error_status_t excel_getCellInfos ([in] const unsigned long windowHandle,[in] BSTR rangeAddress, [in] long cellInfoFlags, [in] long cellCount, [out, size_is(cellCount)] EXCEL_CELLINFO *cellInfos, [out] long *numCellsFetched)
 

Detailed Description

Useful utlity methods that can be executed in-process from NVDA.

Member Typedef Documentation

◆ nvdaRegistrationHandle_t

Member Function Documentation

◆ registerNVDAProcess()

error_status_t NvdaInProcUtils::registerNVDAProcess ( [in] handle_t bindingHandle,
[out] nvdaRegistrationHandle_t * registrationhandle )

◆ unregisterNVDAProcess()

error_status_t NvdaInProcUtils::unregisterNVDAProcess ( [in, out] nvdaRegistrationHandle_t * registrationhandle)

◆ winword_expandToLine()

error_status_t NvdaInProcUtils::winword_expandToLine ( [in] const unsigned long windowHandle,
[in] const int offset,
[out] int * lineStart,
[out] int * lineEnd )

◆ winword_getTextInRange()

error_status_t NvdaInProcUtils::winword_getTextInRange ( [in] const unsigned long windowHandle,
[in] const int startOffset,
[in] const int endOffset,
[in] const long formatConfig,
[out] BSTR * text )

◆ winword_moveByLine()

error_status_t NvdaInProcUtils::winword_moveByLine ( [in] const unsigned long windowHandle,
[in] const int offset,
[in] const int moveBack,
[out] int * newOffset )

◆ sysListView32_getGroupInfo()

error_status_t NvdaInProcUtils::sysListView32_getGroupInfo ( [in] const unsigned long windowHandle,
[in] int groupIndex,
[out, string] BSTR * header,
[out, string] BSTR * footer,
[out] int * state )

◆ sysListView32_getColumnContent()

error_status_t NvdaInProcUtils::sysListView32_getColumnContent ( [in] const unsigned long windowHandle,
[in] int item,
[in] int subItem,
[out, string] BSTR * text )

◆ sysListView32_getColumnLocation()

error_status_t NvdaInProcUtils::sysListView32_getColumnLocation ( [in] const unsigned long windowHandle,
[in] int item,
[in] int subItem,
[out] RECT * location )

◆ sysListView32_getColumnHeader()

error_status_t NvdaInProcUtils::sysListView32_getColumnHeader ( [in] const unsigned long windowHandle,
[in] int subItem,
[out, string] BSTR * text )

◆ sysListView32_getColumnOrderArray()

error_status_t NvdaInProcUtils::sysListView32_getColumnOrderArray ( [in] const unsigned long windowHandle,
[in] const int columnCount,
[out, size_is(columnCount)] int * columnOrderArray )

◆ getActiveObject()

error_status_t NvdaInProcUtils::getActiveObject ( [in] handle_t bindingHandle,
[in, string] const wchar_t * progid,
[out] IUnknown ** ppUnknown )

◆ dumpOnCrash()

error_status_t NvdaInProcUtils::dumpOnCrash ( [in] handle_t bindingHandle,
[in, string] const wchar_t * minidumpPath )

◆ IA2Text_findContentDescendant()

error_status_t NvdaInProcUtils::IA2Text_findContentDescendant ( [in] handle_t bindingHandle,
[in] const unsigned long hwnd,
[in] long parentID,
[in] long what,
[out] long * descendantID,
[out] long * descendantOffset )

◆ getTextFromIAccessible()

error_status_t NvdaInProcUtils::getTextFromIAccessible ( [in] handle_t bindingHandle,
[in] const unsigned long hwnd,
[in] long parentID,
[out, string] BSTR * textBuf,
[in, defaultvalue(TRUE)] const boolean recurse,
[in, defaultvalue(TRUE)] const boolean includeTopLevelText )

◆ outlook_getMAPIProp()

error_status_t NvdaInProcUtils::outlook_getMAPIProp ( const long threadID,
[in] IUnknown * mapiObject,
const unsigned long mapiPropTag,
[out] VARIANT * val )

◆ excel_getCellInfos()

error_status_t NvdaInProcUtils::excel_getCellInfos ( [in] const unsigned long windowHandle,
[in] BSTR rangeAddress,
[in] long cellInfoFlags,
[in] long cellCount,
[out, size_is(cellCount)] EXCEL_CELLINFO * cellInfos,
[out] long * numCellsFetched )

The documentation for this interface was generated from the following file: