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

Methods to control NVDA via NVDA in-process code. More...

import <nvdaControllerInternal.idl;

Public Member Functions

error_status_t __stdcall requestRegistration ([in, string] const wchar_t *uuidString)
 
error_status_t __stdcall inputLangChangeNotify ([in] const long threadID, [in] const unsigned long hkl, [in, string] const wchar_t *layoutString)
 Notifies NVDA that the keyboard layout has changed for this thread.
 
error_status_t __stdcall typedCharacterNotify ([in] const wchar_t ch)
 Notifies NVDA that a character has been typed in this thread.
 
error_status_t __stdcall displayModelTextChangeNotify ([in] const long hwnd, [in] const long left, [in] const long top, [in] const long right, [in] const long bottom)
 Notifies NVDA that text in the given rectangle (in screen coordinates), in the given window, has changed.
 
error_status_t __stdcall logMessage ([in] const long level, [in] const long processID, [in, string] const wchar_t *message)
 Logs a message at the given level to NVDA.
 
error_status_t __stdcall inputCompositionUpdate ([in, string] const wchar_t *compositionString, [in] const int selectionStart, [in] const int selectionEnd, [in] const int isReading)
 Notifies NVDA of updates to the current input composition (including the full content, the selection offsets and the newly added text if any).
 
error_status_t __stdcall inputCandidateListUpdate ([in, string] const wchar_t *candidates, [in] const long selectionIndex, [in, string] const wchar_t *inputMethod)
 
error_status_t __stdcall IMEOpenStatusUpdate ([in] const long open)
 
error_status_t __stdcall inputConversionModeUpdate ([in] const long oldFlags, [in] const long newFlags,[in] const unsigned long lcid)
 
error_status_t __stdcall vbufChangeNotify ([in] const int rootDocHandle, [in] const int rootID)
 Notifies NVDA that a virtual buffer has changed.
 
error_status_t __stdcall installAddonPackageFromPath ([in, string] const wchar_t *addonPath)
 Requests for installation of the add-on package from specified path.
 
error_status_t __stdcall drawFocusRectNotify ([in] const long hwnd, [in] const long left, [in] const long top, [in] const long right, [in] const long bottom)
 Notifies NVDA that a focus rect has been drawn in the given window.
 
error_status_t __stdcall reportLiveRegion ([in, string] const wchar_t *text, [in, string] const wchar_t *level)
 Notifies NVDA that a live region was updated.
 
error_status_t __stdcall openConfigDirectory ()
 Asks NVDA to open currently used configuration directory.
 

Detailed Description

Methods to control NVDA via NVDA in-process code.

Member Function Documentation

◆ requestRegistration()

error_status_t __stdcall NvdaControllerInternal::requestRegistration ( [in, string] const wchar_t * uuidString)

◆ inputLangChangeNotify()

error_status_t __stdcall NvdaControllerInternal::inputLangChangeNotify ( [in] const long threadID,
[in] const unsigned long hkl,
[in, string] const wchar_t * layoutString )

Notifies NVDA that the keyboard layout has changed for this thread.

Parameters
threadIDthe thread the layout change occured in
hklthe current layout retreaved either by GetKeyboardLayout or the lParam of wm_inputLangChange.
layoutStringthe current identifier string returned from GetKeyboardLayoutName.

◆ typedCharacterNotify()

error_status_t __stdcall NvdaControllerInternal::typedCharacterNotify ( [in] const wchar_t ch)

Notifies NVDA that a character has been typed in this thread.

Parameters
chthe character typed.

◆ displayModelTextChangeNotify()

error_status_t __stdcall NvdaControllerInternal::displayModelTextChangeNotify ( [in] const long hwnd,
[in] const long left,
[in] const long top,
[in] const long right,
[in] const long bottom )

Notifies NVDA that text in the given rectangle (in screen coordinates), in the given window, has changed.

◆ logMessage()

error_status_t __stdcall NvdaControllerInternal::logMessage ( [in] const long level,
[in] const long processID,
[in, string] const wchar_t * message )

Logs a message at the given level to NVDA.

Parameters
levelthe level of the message
processId of the process where the message is sent from
messagethe log message

◆ inputCompositionUpdate()

error_status_t __stdcall NvdaControllerInternal::inputCompositionUpdate ( [in, string] const wchar_t * compositionString,
[in] const int selectionStart,
[in] const int selectionEnd,
[in] const int isReading )

Notifies NVDA of updates to the current input composition (including the full content, the selection offsets and the newly added text if any).

◆ inputCandidateListUpdate()

error_status_t __stdcall NvdaControllerInternal::inputCandidateListUpdate ( [in, string] const wchar_t * candidates,
[in] const long selectionIndex,
[in, string] const wchar_t * inputMethod )

◆ IMEOpenStatusUpdate()

error_status_t __stdcall NvdaControllerInternal::IMEOpenStatusUpdate ( [in] const long open)

◆ inputConversionModeUpdate()

error_status_t __stdcall NvdaControllerInternal::inputConversionModeUpdate ( [in] const long oldFlags,
[in] const long newFlags,
[in] const unsigned long lcid )

◆ vbufChangeNotify()

error_status_t __stdcall NvdaControllerInternal::vbufChangeNotify ( [in] const int rootDocHandle,
[in] const int rootID )

Notifies NVDA that a virtual buffer has changed.

◆ installAddonPackageFromPath()

error_status_t __stdcall NvdaControllerInternal::installAddonPackageFromPath ( [in, string] const wchar_t * addonPath)

Requests for installation of the add-on package from specified path.

Parameters
addonPathpath to the add-on package file.

◆ drawFocusRectNotify()

error_status_t __stdcall NvdaControllerInternal::drawFocusRectNotify ( [in] const long hwnd,
[in] const long left,
[in] const long top,
[in] const long right,
[in] const long bottom )

Notifies NVDA that a focus rect has been drawn in the given window.

◆ reportLiveRegion()

error_status_t __stdcall NvdaControllerInternal::reportLiveRegion ( [in, string] const wchar_t * text,
[in, string] const wchar_t * level )

Notifies NVDA that a live region was updated.

Parameters
textthe text to report for the live region.
levelThe level of live region, I.E. "polite"

◆ openConfigDirectory()

error_status_t __stdcall NvdaControllerInternal::openConfigDirectory ( )

Asks NVDA to open currently used configuration directory.


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