NVDA Helper
In-process and lite high-speed utilities for NVDA
|
Renders content in to a virtual buffer. More...
import <vbuf.idl;
Public Types | |
typedef void * | VBufRemote_bufferHandle_t |
typedef unsigned hyper | VBufRemote_nodeHandle_t |
Public Member Functions | |
VBufRemote_bufferHandle_t | createBuffer ([in] handle_t bindingHandle, [in] int docHandle, [in] int ID, [in, string] const wchar_t *backendName) |
Creates a new virtualBuffer. | |
void | destroyBuffer ([in, out] VBufRemote_bufferHandle_t *buffer) |
Destroies a virtual buffer. | |
int | getFieldNodeOffsets ([in] VBufRemote_bufferHandle_t buffer, [in] VBufRemote_nodeHandle_t node, [out] int *startOffset, [out] int *endOffset) |
Calculates the start and end character offsets of the given node in the buffer. | |
int | isFieldNodeAtOffset ([in] VBufRemote_bufferHandle_t buffer, [in] VBufRemote_nodeHandle_t node, [in] int offset) |
finds out if a given field is positioned at a given character offset in this buffer. | |
int | locateTextFieldNodeAtOffset ([in] VBufRemote_bufferHandle_t buffer, [in] int offset, [out] int *nodeStartOffset, [out] int *nodeEndOffset, [out] VBufRemote_nodeHandle_t *foundNode) |
locates the text field node at the given offset | |
int | locateControlFieldNodeAtOffset ([in] VBufRemote_bufferHandle_t buffer, [in] int offset, [out] int *startOffset, [out] int *endOffset, [out] int *docHandle, [out] int *ID, [out] VBufRemote_nodeHandle_t *foundNode) |
locates the deepest control field node at the given offset | |
int | getControlFieldNodeWithIdentifier ([in] VBufRemote_bufferHandle_t buffer, [in] int docHandle, [in] int ID, [out] VBufRemote_nodeHandle_t *foundNode) |
locates the controlFieldNode with the given identifier | |
int | getIdentifierFromControlFieldNode ([in] VBufRemote_bufferHandle_t buffer, [in] VBufRemote_nodeHandle_t node, [out] int *docHandle, [out] int *ID) |
Retreaves the identifier for the given controlFieldNode. | |
int | findNodeByAttributes ([in] VBufRemote_bufferHandle_t buffer, [in] int offset, [in] int direction, [in, string] const wchar_t *attribs, [in, string] const wchar_t *regexp, [out] int *startOffset, [out] int *endOffset, [out] VBufRemote_nodeHandle_t *foundNode) |
Finds a field node that contains particular attributes. | |
int | getSelectionOffsets ([in] VBufRemote_bufferHandle_t buffer, [out] int *startOffset, [out] int *endOffset) |
Retreaves the current selection offsets for the buffer. | |
int | setSelectionOffsets ([in] VBufRemote_bufferHandle_t buffer, [in] int startOffset, [in] int endOffset) |
sets the selection offsets for the buffer. | |
int | getTextLength ([in] VBufRemote_bufferHandle_t buffer) const |
retreaves the length of all the text in the buffer. | |
int | getTextInRange ([in] VBufRemote_bufferHandle_t buffer, [in] int startOffset, [in] int endOffset, [out, string] BSTR *text, [in] boolean useMarkup) |
Retreaves the text in the buffer between given offsets, optionally containing markup. | |
int | getLineOffsets ([in] VBufRemote_bufferHandle_t buffer, [in] int offset, [in] int maxLineLength, [in] boolean useScreenLayout, [out] int *startOffset, [out] int *endOffset) |
Expands the given offset to the start and end offsets of the containing line. | |
Renders content in to a virtual buffer.
unsigned hyper VBuf::VBufRemote_nodeHandle_t |
VBufRemote_bufferHandle_t VBuf::createBuffer | ( | [in] handle_t | bindingHandle, |
[in] int | docHandle, | ||
[in] int | ID, | ||
[in, string] const wchar_t * | backendName ) |
Creates a new virtualBuffer.
bindingHandle | the binding handle for the inproc worker's rpc server |
docHandle | uniquely identifies the document or window being virtualized |
ID | uniquely identifies the object with in the document or window where rendering should start from |
backendName | The name of the backend (the path to the correct dll will be calculated automatically) |
void VBuf::destroyBuffer | ( | [in, out] VBufRemote_bufferHandle_t * | buffer | ) |
Destroies a virtual buffer.
buffer | a pointer to the virtual buffer you want to destroy |
int VBuf::getFieldNodeOffsets | ( | [in] VBufRemote_bufferHandle_t | buffer, |
[in] VBufRemote_nodeHandle_t | node, | ||
[out] int * | startOffset, | ||
[out] int * | endOffset ) |
Calculates the start and end character offsets of the given node in the buffer.
buffer | the virtual buffer to use |
node | the node you want the offsets of. |
startOffset | memory where this method can place the found start offset. |
endOffset | memory where this method can place the found end offset. |
int VBuf::isFieldNodeAtOffset | ( | [in] VBufRemote_bufferHandle_t | buffer, |
[in] VBufRemote_nodeHandle_t | node, | ||
[in] int | offset ) |
finds out if a given field is positioned at a given character offset in this buffer.
buffer | the virtual buffer you are interested in |
node | the field you are interested in. |
offset | the character offset you are interested in. |
int VBuf::locateTextFieldNodeAtOffset | ( | [in] VBufRemote_bufferHandle_t | buffer, |
[in] int | offset, | ||
[out] int * | nodeStartOffset, | ||
[out] int * | nodeEndOffset, | ||
[out] VBufRemote_nodeHandle_t * | foundNode ) |
locates the text field node at the given offset
buffer | the virtual buffer to use |
offset | the offset to use |
nodeStartOffset | memory where the found text field's start offset will be placed. |
nodeEndOffset | memory where the found text field's end offset will be placed. |
foundNode | the located text field node. |
int VBuf::locateControlFieldNodeAtOffset | ( | [in] VBufRemote_bufferHandle_t | buffer, |
[in] int | offset, | ||
[out] int * | startOffset, | ||
[out] int * | endOffset, | ||
[out] int * | docHandle, | ||
[out] int * | ID, | ||
[out] VBufRemote_nodeHandle_t * | foundNode ) |
locates the deepest control field node at the given offset
buffer | the virtual buffer to use |
offset | the offset to use |
startOffset | memory where the found text field's start offset will be placed. |
endOffset | memory where the found text field's end offset will be placed. |
docHandle | memory where the docHandle of the found control field node will be placed. |
ID | memory where the ID of the found control field node will be placed. |
foundNode | the located control field node. |
int VBuf::getControlFieldNodeWithIdentifier | ( | [in] VBufRemote_bufferHandle_t | buffer, |
[in] int | docHandle, | ||
[in] int | ID, | ||
[out] VBufRemote_nodeHandle_t * | foundNode ) |
locates the controlFieldNode with the given identifier
buffer | the virtual buffer to use |
docHandle | the docHandle of the control field node you wish to find |
ID | the ID of the control field node you wish to find |
foundNode | the controlFieldNode with the given identifier |
int VBuf::getIdentifierFromControlFieldNode | ( | [in] VBufRemote_bufferHandle_t | buffer, |
[in] VBufRemote_nodeHandle_t | node, | ||
[out] int * | docHandle, | ||
[out] int * | ID ) |
Retreaves the identifier for the given controlFieldNode.
buffer | the virtual buffer to use |
node | the controlFieldNode who's identifier should be retreaved. |
docHandle | a memory address where the docHandle should be placed. |
ID | a memory address where the ID should be placed. |
int VBuf::findNodeByAttributes | ( | [in] VBufRemote_bufferHandle_t | buffer, |
[in] int | offset, | ||
[in] int | direction, | ||
[in, string] const wchar_t * | attribs, | ||
[in, string] const wchar_t * | regexp, | ||
[out] int * | startOffset, | ||
[out] int * | endOffset, | ||
[out] VBufRemote_nodeHandle_t * | foundNode ) |
Finds a field node that contains particular attributes.
buffer | the virtual buffer to use |
offset | offset in the buffer to start searching from |
direction | which direction to search |
attribs | the attributes to search |
regexp | regular expression the requested attributes must match |
startOffset | memory where the start offset of the found node can be placed |
endOffset | memory where the end offset of the found node will be placed |
foundNode | the found field node |
int VBuf::getSelectionOffsets | ( | [in] VBufRemote_bufferHandle_t | buffer, |
[out] int * | startOffset, | ||
[out] int * | endOffset ) |
Retreaves the current selection offsets for the buffer.
buffer | the virtual buffer to use |
startOffset | memory where the start offset of the selection will be placed |
endOffset | memory where the end offset of the selection will be placed |
int VBuf::setSelectionOffsets | ( | [in] VBufRemote_bufferHandle_t | buffer, |
[in] int | startOffset, | ||
[in] int | endOffset ) |
sets the selection offsets for the buffer.
buffer | the virtual buffer to use |
startOffset | the offset the start of the selection should be set to. |
endOffset | the offset the end of the selection should be set to. |
int VBuf::getTextLength | ( | [in] VBufRemote_bufferHandle_t | buffer | ) | const |
retreaves the length of all the text in the buffer.
buffer | the virtual buffer to use |
int VBuf::getTextInRange | ( | [in] VBufRemote_bufferHandle_t | buffer, |
[in] int | startOffset, | ||
[in] int | endOffset, | ||
[out, string] BSTR * | text, | ||
[in] boolean | useMarkup ) |
Retreaves the text in the buffer between given offsets, optionally containing markup.
buffer | the virtual buffer to use |
startOffset | the offset to start from |
endOffset | the offset to end at. Use -1 to mean end of buffer. |
text | receives a pointer to the text in the given range |
useMarkup | if true then markup is included in the text denoting field starts and ends. |
int VBuf::getLineOffsets | ( | [in] VBufRemote_bufferHandle_t | buffer, |
[in] int | offset, | ||
[in] int | maxLineLength, | ||
[in] boolean | useScreenLayout, | ||
[out] int * | startOffset, | ||
[out] int * | endOffset ) |
Expands the given offset to the start and end offsets of the containing line.
buffer | the virtual buffer to use |
offset | the offset to expand. |
maxLineLength | the maximum length of a line. |
useScreenLayout | if true then lines will only break on block controls or line feed characters, if false then lines will break on all field nodes. |
startOffset | memory to place the calculated line start offset |
endOffset | memory to place the calculated line end offset |