This chapter documents the script APIs which can be used by Squish test scripts. See the Tutorials and the User Guide's User Guide (Chapter 13) section for complete examples that make use of all the main features that Squish's API offers. (Note that extension APIs are documented in the User Guide: QML Extension API (Section 14.4.2) (Qt), JavaScript Extension API (Section 14.10.22) (Web), and Java Extension API for Custom Widgets (Section 14.7.3) (Java).)

Convenience Function Parameters

Those functions that take an objectOrName argument can be passed a reference to an object or the symbolic or real (multi-property) name of an object as a string. Those functions that take an object argument must be passed an object reference, and those functions that take an objectName must be passed an object's symbolic or real name. (Object references are returned by the waitForObject and findObject functions.)

In this chapter we begin by looking at the special functions that testers create to make their tests usable by Squish. Then we will look at the differences between the supported scripting languages, then Squish's API is covered, then the GUI toolkit-specific convenience APIs are covered, and finally some scripting language-specific issues are dealt with.