source: cprs/trunk/CPRS-Chart/JAWS Support Files/VA508JAWS.jsd@ 840

Last change on this file since 840 was 830, checked in by Kevin Toppenberg, 14 years ago

Upgrading to version 27

File size: 10.3 KB
Line 
1:function VA508Cast
2:Returns variant No Return Description
3:Synopsis Conversion functionality (cast of any type to any other type within reason)
4:Param variant/value No Description
5
6:function getListType
7:Returns string
8:Synopsis returns the type of list such as extended selection, multi-selection, listview, or listbox
9:Param int
10
11:function isSpecialFocus
12:Returns int
13:Synopsis returns true if we are in a menu, the jaws cursor, invisible cursor, or user cursor is active or if we are in an hj dialog
14:Param int
15
16:function watchCount
17:Synopsis Used in Debugging
18:Param string
19
20:function VA508SendMessage
21:Returns int success or failure
22:Synopsis Send message wrapper with common message id for communicating with dll
23:Param handle/Window handle of dll window
24:Param int/wParam wParam
25:Param int/lParam lParam
26
27:function Get4KName
28:Returns string No Return Description
29:Synopsis Returns the window name up to 4k of the data window
30:Param handle/hWnd handle of the data window
31
32:function VA508GetStringValue
33:Returns string Returns the data for a given var property such as a caption
34:Synopsis Returns the data for a given var property such as caption, usually called after getApplicationData has set the data
35:Param string/VarName the var to get
36
37:function VA508GetApplicationData
38:Synopsis tell framework to set contents of data window so we can get that info using getStringValue
39:Param handle/hwnd Handle of window to query for
40:Param int/iQueryCode Query code
41
42:function VA508ResetGlobals
43:Synopsis Clears out some global variables
44
45:function VA508EnsureInitialized
46:Synopsis Makes sure the Script is working with the VA App
47:Description Before the script file tries to communicate with the VA application, it needs to make sure the VA application wants to try and communicate with it.
48
49:function VA508cacheGetVal
50:Returns int No Return Description
51:Synopsis Get a property value from the cache.
52:Param int/iQueryCode No Description
53:Param string/byRef No Description
54
55:function VA508CacheUpdate
56:Synopsis Update the property cache. Called only by VA508getComponentProp() and VA508 ResetGlobals
57:Param handle/hwnd Handle of the window to cache for, or 0 to clear the cache
58
59:function VA508FieldNameFromQueryCode
60:Returns string No Return Description
61:Synopsis Return the framework field name corresponding to the given query code.
62:Param int/iQueryCode No Description
63
64:function VA508QueryCodeFromFieldName
65:Returns int No Return Description
66:Synopsis Return the query code corresponding to the given framework field name.
67:Param string/sFieldName No Description
68
69:function VA508GetComponentProp
70:Returns int 1 on success, 0 if the property is not found, -1 on error
71:Synopsis returns the requested property of a given window if one is available through the framework
72:Param handle/hWnd handle of control
73:Param string/sProp Name of property
74:Param int/iCacheHandling Whether to update cache, skip the cache, or just use the cache
75:Param string/byRef sVal The property value if found
76
77:function VA508CacheSetVals
78:Synopsis Update the property cache when the framework sends an event indicating property changes.
79:Param handle/hwnd No Description
80:Param int/iDataStatus No Description
81:Param string/sCaption No Description
82:Param string/sValue No Description
83:Param string/sControlType No Description
84:Param string/sState No Description
85:Param string/sInstructions No Description
86:Param string/sItemInstructions No Description
87
88:function VA508GetGridData
89:Returns int No Return Description
90:Synopsis Fills the VA508cacheGrid* globals.
91:Param variant/fromWhere No Description
92:Param int/dontCheck No Description
93
94:function VA508SayData
95:Returns int No Return Description
96:Synopsis function for actually speaking data for control when needed
97:Param handle/hwnd handle of window
98
99:function tvGetFocusItemExpandStateString
100:Returns string No Return Description
101:Synopsis Returns a string with open or closed representing the state of the currently focused tree view node
102:Param handle/hwnd No Description
103
104:function bxTestNum
105:Synopsis used for debugging purposes
106:Param int/n No Description
107
108:function autoCloseIfOpenCombo
109:Synopsis Automatically close a combo box if one is open when tab or shift+tab is pressed
110
111:function VA508TranslateProps
112:Returns int No Return Description
113:Synopsis Handles custom translations of types and states for output.
114:Param string/sTable No Description
115:Param int/iQueryCode No Description
116:Param string/byRef No Description
117:Param string/byRef No Description
118
119:function controlpropGet
120:Returns int No Return Description
121:Synopsis Handles all control property requests.
122:Param string/sOrigin No Description
123:Param string/whichProp No Description
124:Param string/byRef sVal
125:Param string
126
127:function BraillePropHelper
128:Returns int No Return Description
129:Synopsis Logic for BrailleAddObject* functions to use.
130:Param string/whichProp No Description
131:Param int/nSubtype No Description
132
133:function BrailleClassFound
134:Returns int
135:Synopsis returns true if there was a custom braille class reclass found in the jcf for a custom framework control type
136:Param string
137:Param int
138
139:script f2editTreeNode
140:Synopsis Edits the current tree node's name if applicable
141:Description This command simulates a left click on the currently selected node of a Delphi treeView control, which can open the current node's name for editing. On any other control, the key pressed is passed through to the application.
142
143:function VA508ChangeEvent
144:Synopsis called by framework dll to tell scripts when an event occurs that changes the property of the currently focused control
145:Param handle/hwnd No Description
146:Param int/iDataStatus No Description
147:Param string/sCaption, No Description
148:Param string/sValue, No Description
149:Param string/sControlType No Description
150:Param string/sState No Description
151:Param string/sInstructions No Description
152:Param string/sItemInstructions No Description
153
154:function AnnounceProp
155:Synopsis announce a property if one was set by the changeEvent and it hasn't already been canceled
156:Param int
157:Param int
158:Param int
159
160:function AnnounceEvent
161:Synopsis helper function that is scheduled from changeEvent for speaking changes in framework properties
162
163:function ChangeDocumentWindow
164:Synopsis allows control tab to announce the correct tab when focus in on page tab control and style is set to button or flat button
165:Description allows control tab when pressed on a child object of a page tab to announce the change in page
166:Param int/direction No Description
167
168:function getSelectedTab
169:Returns string No Return Description
170:Synopsis gets the selected tab from a TTabControl when a child control is in focus
171
172:function SelectTab
173:Synopsis Used for TTabControl to activate a new tab using MSAA
174:Param int/direction No Description
175
176:function ClearSuppressFocusChange
177:Synopsis resets the global variable that suppress focus changes from being announced
178
179:function isSpinBox
180:Returns int No Return Description
181:Synopsis returns true if window with handle is a spinbox
182:Param handle/hwnd No Description
183
184:function getValue
185:Returns string No Return Description
186:Synopsis get value for element from framework, falls back on getObjectValue()
187
188:function SpeakCellUnit
189:Returns int No Return Description
190:Synopsis Speaks the aspects of a cell that are different from the last cell visited
191:Param string/str the direction we just moved
192
193:function getCurrentCellHeadersData
194:Returns string No Return Description
195:Synopsis returns the full string of col number, row number, column name, row name, and cell data for the current table cell
196
197:function UpdateBrailleClasses
198:Synopsis Called from autoStartEvent to load jcf settings into memory for braille reclassing
199:Returns int
200
201:function UpdateControlTypes
202:Synopsis Called from autoStartEvent to load jcf settings into memory for custom control type reclassing
203:Returns int
204
205:function ControlTypeFound
206:Returns int
207:Synopsis returns true of a new control type string is found in the jcf file to be spoken instead of the custom framework control type
208:Param string
209:Param string
210
211:function ToggleGridSpeechMode
212:Returns string
213:Synopsis toggles whether table headers are announced or not
214:Param int
215
216:function ToggleGridBrailleMode
217:Returns string
218:Synopsis toggles whether table headers are shown in Braille or not
219:Param int
220
221:function getAccName
222:Returns string Returns an msaa directly using msaa rather than getObjectName()
223:Synopsis returns an accessible name depending on context
224
225:function getAccValue
226:Returns string No Return Description
227:Synopsis returns an accessible value depending on context
228
229:function getAccState
230:Returns string Returns an msaa state string that can be spoken via msaa directly rather than getObjectState()
231:Synopsis returns an accessible state depending on context
232
233:function lt_stringCast
234:Returns string
235:Param variant
236
237:function lt_stringSegmentWithMultiCharDelim
238:Returns string
239:Param string
240:Param string
241:Param int
242
243:function lt_canTryLVCalls
244:Returns int
245
246:function lt_getMSAARect
247:Returns int
248:Param object
249:Param int
250:Param int
251:Param int
252:Param int
253:Param int
254
255:function lt_move
256:Returns int
257:Param string
258
259:function lt_clearSuppressHighlight
260
261:script moveToTopOfColumn
262:Returns undef
263
264:script moveToBottomOfColumn
265:Returns undef
266
267:script moveToStartOfRow
268:Returns undef
269
270:script moveToEndOfRow
271:Returns undef
272
273:script ltLeftClickCell
274:Synopsis Clicks the current cell with the left mouse button
275:Description This command simulates a left mouse click on the current cell
276
277:script ltRightClickCell
278:Synopsis Clicks the current cell with the right mouse button
279:Description This command simulates a right mouse click on the current cell
280
281:script ltLeftClickHeader
282:Synopsis Clicks the current cell's column header with the left mouse button
283:Description This command simulates a right mouse click on the current cell's column header
284
285:script ltRightClickHeader
286:Synopsis Clicks the current cell's column header with the right mouse button
287:Description This command simulates a right mouse click on the current cell's column header
288
289:script VA508SendCustomCommand
290:Synopsis Custom command for this application
291:Description This is a custom command for this application, implemented directly by the accessibility framework
292
293
Note: See TracBrowser for help on using the repository browser.