GWKB1115 : Getting to Know the GW Toolkit

Product: Window-Eyes
Author: J.J. Meddaugh
Date Added: 01/22/2010
Last Modified: 01/28/2010

The GW Toolkit is one of the building blocks used by most scripts that work with Window-Eyes. Window-Eyes provides a powerful scripting language to handle virtually any task. The Toolkit builds on this language and allows script writers to easily add more functionality to their scripts. For instance, the help dialog, hotkey manager, and custom error reporting are all functions of the Toolkit. Below we will discuss how Window-Eyes users can take advantage of the Toolkit and also how scripters can learn more about the many tools available to them.

The GW Toolkit for Users

For most users, the GW Toolkit will run seamlessly as a part of Window-Eyes. This is because it is loaded on your computer by default when Window-Eyes is installed or upgraded.

It is important, however, to ensure you are running the latest version of the Toolkit, as some scripts may fail or have limited functionality without it.

To check what version of the toolkit you are running, do the following:

  1. Open the Window-Eyes Control Panel. This is Control-Backslash by default.
  2. Press Alt-F for the File menu.
  3. Press M for the Manage Sets and Scripts menu.
  4. Press A for the Add or Remove Packages dialog.
  5. You are now in a list of all packages you have installed. Press down arrow until you hear the GW Toolkit script. You will also hear a number, such as 8.1.1. This is the current version of the script installed on your computer.
  6. To check if there is an update for this script, press Alt-U.
  7. You will either be told of new script updates that are available or that there are none.
  8. If new updates are available for your scripts, they will be listed. The simplest thing to do here is to press Alt-A to update all scripts. Follow the prompts to update your scripts.

The GW Toolkit for Scripters

The Toolkit is one of the most useful building blocks when writing a new script. It is used by virtually every script which is posted on Script Central, and offers a myriad of additional functionality such as dynamic message boxes, script update checking, and a virtual browse mode just to name a few.

The Toolkit comes with its own manual, easily accessible from the Manage Scripts and Sets menu. To locate it, do the following:,

  1. Open the Window-Eyes Control Panel. This is Control-Backslash by default.
  2. Press Alt-F for the File menu.
  3. Press M for the Manage Sets and Scripts menu.
  4. Press M again for the Script Manager.
  5. Arrow down to the GW Toolkit script and press Alt-H for the help and options dialog box.
  6. Finally, press H again for the Toolkit documentation.

The manual is organized to give you an easy reference to the objects available in the Toolkit including examples for each object. If further clarification is needed, the GW Micro scripting mailing list and the GW Wiki are excellent resources which you can use.