New or updated functions and scripts in JAWS 8.0
(Based on search of the fsdn.chm documentation)
29 entries

CONTENTS

Function: TULSwitchToRuleSet
Function: ShowScreenSensitiveHelp
Function: AnnounceDocumentElements
Function: CustomPageSummaryReported
Function: DocumentLoadedAtFormField
Function: GetListOfTagsWithAttribute
Function: MoveToTagWithAttributeByIndex
Function: PageChangedEvent
Function: ControlShiftEnterKey
Script: ControlShiftEnter
Script: DoNativeKey
Function: SayLineUnit
Function: GetCellSpan
Function: GetTableName
Function: GetTableSelectionRange
Function: SetColumnHeader
Function: SetRowHeader
Function: CollectWindowInfo
Function: GetRightLeaf
Function: GetTreeInfo
Script: UtilityNodeCapture
Script: UtilityShowObjectHierarchyInfo
Script: UtilityShowObjectListInfoByName
Script: UtilityShowObjectList
Script: UtilityTreeCapture
Function: GetOwningAppName
Function: GetFixedProductVersion
Function: GetCurrentLinkIndex
Function: SayObjectActiveItem
----------

Function: TULSwitchToRuleSet

Description

This function switches the TextUnitLocator module to use the named rule set
for the currently active cursor. If the name is empty, the default rules set
for the current cursor and window class will be used. When switching to the
default, the following search is performed: attempt to switch to a set for the
current cursor and window class, if not found, switch to the rule for the
current cursor, if not found, switch to the default rule. See default.jcf
sections whose names begin with TextUnitRuleSet for details. The string
following the first part of the section name is used as the rule set name for
this function. For example, to switch to the rule set for the section whose
name is "TextUnitRuleSet joe", use TULSwitchToRuleSet("joe"). See default.jcf
for details about the keys for a rule.

Returns

Type: int
Description: TRUE or FALSE depending on whether the switch succeeded.

Parameters

Param 1:

Type: string
Description: of rule to switch active cursor to or empty string to switch back
to default for current situation.
Include: Required

----------

Function: ShowScreenSensitiveHelp

Description

Use this function if you want to add extra information to the screen-sensitive
help message.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: The help message.
Include: Required

----------

Function: AnnounceDocumentElements

Description

Used by DocumentLoadedEvent to announce the number of frames, heading and
links on the current HTML page.

Returns

Type: Void

Parameters

No Parameters

----------

Function: CustomPageSummaryReported

Description

Speak or shows the custom page summary, based on the user's setting for custom
page summary.

Returns

Type: int
Description: True if the custom page summary was spoken or shown, false
otherwise.

Parameters

No Parameters

----------

Function: DocumentLoadedAtFormField

Description

Used by DocumentLoadedEvent to determine if the focus was on a form field when
the document laoded.

Returns

Type: int
Description: True if the focus is on a form field, false otherwise

Parameters

No Parameters

----------

Function: GetListOfTagsWithAttribute

Description

This function returns a delimited list of elements with the specified tag
currently rendered in the VPC buffer. The element must have the supplied
attribute. You may optionally also indicate if the tags may be nested or not
(which will affect their index). Specify the delimiter for the list using the
optional string parameter. This function is used in conjunction with
MoveToTagWithAttributeByIndex. The list's elements are in two parts, the first
part is the value of the supplied attribute followed by a colon. The second
part is the inner text of the element. For example, in The AOL AIM Triton
History Window, this function may be used to obtain information about the
messages. The list will look something like |MSGID:text|MSGID:text|...

Returns

Type: String
Description: the delimited list of tags.

Parameters

Param 1:

Type: string
Description: the UPPERCASE HTML tag to collect.
Include: Required

Param 2:

Type: string
Description: the attribute which each element in the list must have and whose
value is included as part of the list items retrieved.
Include: Required

Param 3:

Type: int
Description: TRUE to allow nested elements, FALSE to disallow nesting. Default
is TRUE
Include: Optional

Param 4:

Type: String
Description: The delimiter to use to separate the tag information for each tag
in the list.
Include: Optional

Param 5:

Type: handle
Description: the handle of the document (may not have focus). If this
parameter is not supplied, we assume the document has focus.
Include: Optional

----------

Function: MoveToTagWithAttributeByIndex

Description

This function moves to a specified tag on a webpage. Specify the 1-based index
of the particular tag to move to In order for the index to correctly match
elements retrieved with GetListOfTagsWithAttribute, the same attribute and
nesting parameter must be supplied. This is primarily used with the
GetListOfTagsWithAttribute function which returns a delimited string
containing tag information for each tag currently rendered in the virtual
document with the specified attribute. The page must have focus for this
function to work.

Returns

Type: Int
Description: true if the virtual cursor was moved to a tag, false otherwise.

Parameters

Param 1:

Type: Int
Description: index of tag relative to collection of tags with specified
attribute present.
Include: Required

Param 2:

Type: string
Description: the tag to move to
Include: Required

Param 3:

Type: string
Description: the attribute which must be present in order to count the tag as
being included in the index
Include: Required

Param 4:

Type: int
Description: TRUE to allow nesting when determining the instance of the
element to move to, must match the value used when obtaining the list of tags
with the specified attribute.
Include: Required

----------

Function: PageChangedEvent

Description

This event fires when Internet Explorer switches to a new page tab.

Returns

Type: Void

Parameters

Param 1:

Type: handle
Description: The handle of the page.
Include: Required

Param 2:

Type: string
Description: The name of the page of the foreground tab.
Include: Required

----------

Function: ControlShiftEnterKey

Description

Passes the Control Shift Enter key through to the application. If the virtual
cursor is active and on an element then the focus is set on that element and
Control+Shift+Enter key is passed to the application.

Returns

Type: Void

Parameters

No Parameters

----------

Script: ControlShiftEnter

Description

This script passes control shift enter directly to the application so that the
application can perform the associated action. For example, when you press
this keystroke within IE7 on a link, it creates a tab for the link in IE.

Returns

Type: Void

Parameters

No Parameters

----------

Script: DoNativeKey

Description

Returns

Type: Void

Parameters

No Parameters

----------

Function: SayLineUnit

Description

Moves to the line specified by the unit movement and then speaks. For JAWS 8.0
and later, only speaks the line, the calling script must perform the movement
first.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: The movement unit. The movement unit defines the type of movement
which was performed before speaking. See HJConst.jsh for unit movement
constants, all prefixed by UnitMove_.
Include: Required

Param 2:

Type: int
Description: Boolean denoting whether or not a navigation movement occured
triggering the call to speak the line. This parameter is only valid for JAWS
8.0 and later.
Include: Optional

----------

Function: GetCellSpan

Description

When in a table or spreadsheet, gets the number of rows and columns spanned by
the current cell.

Returns

Type: int
Description: True if the function succeeded, false otherwise.

Parameters

Param 1:

Type: int
Description: When the function returns, contains the number of rows spanned by
the current table cell.
Include: Required
* Returns data by reference

Param 2:

Type: int
Description: When the function returns, contains the number of columns spanned
by the current table cell.
Include: Required
* Returns data by reference

----------

Function: GetTableName

Description

Returns

Type: String
Description: The Table name

Parameters

No Parameters

----------

Function: GetTableSelectionRange

Description

Returns

Type: Void

Parameters

Param 1:

Type: int
Description:
Include: Required
* Returns data by reference

Param 2:

Type: int
Description:
Include: Required
* Returns data by reference

Param 3:

Type: string
Description:
Include: Required
* Returns data by reference

Param 4:

Type: int
Description:
Include: Required
* Returns data by reference

Param 5:

Type: int
Description:
Include: Required
* Returns data by reference

Param 6:

Type: string
Description:
Include: Required
* Returns data by reference

----------

Function: SetColumnHeader

Description

Sets the row to be used when announcing column headers.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: Specifies the row containing column headers.
Include: Required

----------

Function: SetRowHeader

Description

Sets the column to be used when announcing row headers.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: Specifies the column containing row headers.
Include: Required

----------

Function: CollectWindowInfo

Description

collects the technical information about a window.

Returns

Type: string
Description: The information retrieved for the window.

Parameters

Param 1:

Type: handle
Description: The window for which the information will be collected.
Include: Required

----------

Function: GetRightLeaf

Description

Traverses the window tree to find the right-most leaf window, starting from
the specified root window.

Returns

Type: handle
Description: The right-most leaf window handle.

Parameters

Param 1:

Type: handle
Description: The starting window handle, the root position.
Include: Required

Param 2:

Type: string
Description: ByRef The string describing the path from the root to the leaf.
Include: Required

Param 3:

Type: int
Description: ByRef The hierarchical x position of the leaf window.
Include: Required

Param 4:

Type: int
Description: ByRef The hierarchical y position of the leaf window.
Include: Required

----------

Function: GetTreeInfo

Description

Used by TreeCapture script to traverse the window tree and retrieve informatin
about each window in the tree.

Returns

Type: string
Description: The collected technical information about all windows in the
tree.

Parameters

Param 1:

Type: handle
Description: The starting window, the root of the window tree to be traversed.
Include: Required

----------

Script: UtilityNodeCapture

Description

Use NodeCapture in home row mode to review the collection of information about
the current home row window. Pressing Escape dismisses the virtual viewer and
returns you to the home row utility.

Returns

Type: Void

Parameters

No Parameters

----------

Script: UtilityShowObjectHierarchyInfo

Description

Displays information about the focus object and its hierarchical ancestors.
Level 0 is the current focus object, level 1 is its parent, 2 its grand
parent, etc.

Returns

Type: Void

Parameters

No Parameters

----------

Script: UtilityShowObjectListInfoByName

Description

Shows information about each object in the current home row window in the
virtual viewer. Press Escape to dismiss the virtual viewer and return to home
row.

Returns

Type: Void

Parameters

No Parameters

----------

Script: UtilityShowObjectList

Description

Shows the list of objects for the current home row window in the virtual
viewer. Press Escape to dismiss the virtual viewer and return to home row.

Returns

Type: Void

Parameters

No Parameters

----------

Script: UtilityTreeCapture

Description

Use NodeCapture in home row mode to review the collection of information about
the window structure starting with the current home row window. Pressing
Escape dismisses the virtual viewer and returns you to the home row utility.

Returns

Type: Void

Parameters

No Parameters

----------

Function: GetOwningAppName

Description

Determines the executable name and extension of the application to which a
window belongs.

Returns

Type: string
Description: the executable name and extension of the application which owns
the window.

Parameters

Param 1:

Type: handle
Description: The window to test for its owning application.
Include: Required

----------

Function: GetFixedProductVersion

Description

GetFixedProductVersion gets the application's fixed product version.

Returns

Type: Void

Parameters

Param 1:

Type: string
Description: The path of the program for which you want the information. You
can get the path by using GetAppFilePath.
Include: Required

Param 2:

Type: Int
Description: Type the variable to receive the major version value.
Include: Required
* Returns data by reference

Param 3:

Type: Int
Description: Type the variable to receive the minor version value.
Include: Required
* Returns data by reference

Param 4:

Type: Int
Description: Type the variable to receive the update version value.
Include: Required
* Returns data by reference

Param 5:

Type: Int
Description: Type the variable to receive the build number value.
Include: Required
* Returns data by reference

----------

Function: GetCurrentLinkIndex

Description

The first link in the buffer is 1, the second 2, etc.

Returns

Type: int
Description: The number of the link

Parameters

No Parameters

----------

Function: SayObjectActiveItem

Description

Says the active element in certain controls. For example in a list view, it
will say the selected item. In a menu, it will say the active menu item. In a
dialog box, it will say the selected tab.

Returns

Type: Void

Parameters

Param 1:

Type: int
Description: As of JAWS 8.0, TRUE if you wish to have JAWS announce positional
information such as n of m items, FALSE otherwise.
Include: Optional

----------End of Document


