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

import <displayModel.idl;

Public Member Functions

error_status_t getWindowTextInRect ([in] handle_t bindingHandle, [in] const unsigned long windowHandle, const boolean includeDescendantWindows, [in] const int left, [in] const int top, [in] const int right, [in] const int bottom, [in] const int minHorizontalWhitespace, [in] const int minVerticalWhitespace, [in] const boolean stripOuterWhitespace, [out, string] BSTR *text, [out, string] BSTR *characterPoints)
 Retreaves the text within the given rectangle (in client coordinates), within the given window.
 
error_status_t getCaretRect ([in] handle_t bindingHandle, [in] const long threadID, [out] long *left, [out] long *top, [out] long *right, [out] long *bottom)
 
error_status_t getFocusRect ([in] handle_t bindingHandle, [in] const unsigned long hwnd, [out] long *left, [out] long *top, [out] long *right, [out] long *bottom)
 Get the coordinates of the current focus rectangle if it exists.
 
error_status_t requestTextChangeNotificationsForWindow ([in] handle_t bindingHandle, [in] const unsigned long windowHandle, [in] const BOOL enable)
 Request that text change notifications be sent when text is updated in the given window.
 

Detailed Description

Member Function Documentation

◆ getWindowTextInRect()

error_status_t DisplayModel::getWindowTextInRect ( [in] handle_t bindingHandle,
[in] const unsigned long windowHandle,
const boolean includeDescendantWindows,
[in] const int left,
[in] const int top,
[in] const int right,
[in] const int bottom,
[in] const int minHorizontalWhitespace,
[in] const int minVerticalWhitespace,
[in] const boolean stripOuterWhitespace,
[out, string] BSTR * text,
[out, string] BSTR * characterPoints )

Retreaves the text within the given rectangle (in client coordinates), within the given window.

◆ getCaretRect()

error_status_t DisplayModel::getCaretRect ( [in] handle_t bindingHandle,
[in] const long threadID,
[out] long * left,
[out] long * top,
[out] long * right,
[out] long * bottom )

◆ getFocusRect()

error_status_t DisplayModel::getFocusRect ( [in] handle_t bindingHandle,
[in] const unsigned long hwnd,
[out] long * left,
[out] long * top,
[out] long * right,
[out] long * bottom )

Get the coordinates of the current focus rectangle if it exists.

◆ requestTextChangeNotificationsForWindow()

error_status_t DisplayModel::requestTextChangeNotificationsForWindow ( [in] handle_t bindingHandle,
[in] const unsigned long windowHandle,
[in] const BOOL enable )

Request that text change notifications be sent when text is updated in the given window.

Parameters
enableif true then notifications will start or if already started a reference count will be increased. If flase then the reference count will be decreased and if it hits 0 notifications will stop.

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