User Guide

The Squish User's Guide provides explanations of all of Squish most commonly used features, and provides many idiomatic examples of how best to use Squish.

Most of the User Guide is devoted to Squish's scripting support, the different scripting languages Squish supports, and the script APIs which are available when working with test scripts. Many examples are presented to show how to do things in practice. (For a complete reference to the Squish APIs see the API Reference Manual and for coverage of Squish's tools see the Tools Reference Manual and the IDE Reference Manual.)

Important: Encoding

The Squish IDE loads and saves test scripts (e.g., files with names matching test.*), as Unicode text using the UTF-8 encoding. All the Squish tools assume that UTF-8 is used for all the scripts they execute. (See the Editor view.) If you don't edit your test scripts using the Squish IDE, make sure that the editor you use loads and saves the scripts using UTF-8; or, if your editor is not Unicode-capable, then the most sensible alternative is to restrict your code to 7-bit ASCII—which all modern editors support—since this is a subset of UTF-8.

Note also that some characters, most notably double quotes (") and backslashes (\), must be quoted in string literals. For example, "C:\\My Documents". (This is a requirement shared by all the scripting languages that Squish supports.)

© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.