Chapter 18. API Reference Manual

Table of Contents

18.1. Tester-Created Special Functions
18.2. Equivalent Script API
18.3. Squish API
18.3.1. Constructors, Functions and Properties
18.3.2. Functions and Properties (Mac OS X)
18.3.3. Object Access Functions
18.3.4. Synchronization Functions
18.3.5. Interaction Functions
18.3.6. Debugging Functions
18.3.7. Conversion Functions
18.3.8. Verification Functions
18.3.9. Test Data Functions
18.3.10. Object Map Functions
18.3.11. Application Context
18.3.12. Image Object
18.3.13. squishinfo Object
18.3.14. testInteraction Functions
18.3.15. testSettings Object
18.3.16. User Interface Types
18.3.17. Miscellaneous Functions
18.3.18. Low-Level Functions
18.4. Qt Convenience API
18.4.1. QWebView Class
18.4.2. QML Extension API
18.4.3. GestureBuilder
18.5. Tk Convenience API
18.6. XView Convenience API
18.7. Java™ Convenience API
18.7.1. Native Java Arrays
18.7.2. Java™ Hardcoded Synthetic Properties
18.7.3. Java Extension API for Custom Widgets
18.8. Mac OS X Convenience API
18.9. iOS Convenience API
18.9.1. GestureBuilder
18.10. Web Object API
18.10.1. Browser Object
18.10.2. HTML_Anchor Class
18.10.3. HTML_Array Class
18.10.4. HTML_Button Class
18.10.5. HTML_ButtonBase Class
18.10.6. HTML_CheckBox Class
18.10.7. HTML_CalendarEvent Class
18.10.8. HTML_CalendarView Class
18.10.9. HTML_ColorField Class
18.10.10. HTML_CustomButton Class
18.10.11. HTML_CustomButtonBase Class
18.10.12. HTML_CustomComboBox Class
18.10.13. HTML_CustomCheckbox Class
18.10.14. HTML_CustomItem Class
18.10.15. HTML_CustomItemView Class
18.10.16. HTML_CustomRadioButton Class
18.10.17. HTML_CustomSelectList Class
18.10.18. HTML_CustomText Class
18.10.19. HTML_DateChooser Class
18.10.20. HTML_Document Class
18.10.21. HTML_ExpandableSectionHeader Class
18.10.22. HTML_Form Class
18.10.23. HTML_FormElement Class
18.10.24. HTML_ImageButton Class
18.10.25. HTML_Menu Class
18.10.26. HTML_MenuButton Class
18.10.27. HTML_MenuItem Class
18.10.28. HTML_Object Class
18.10.29. HTML_Option Class
18.10.30. HTML_RadioButton Class
18.10.31. HTML_Select Class
18.10.32. HTML_ProgressBar Class
18.10.33. HTML_Style Class
18.10.34. HTML_Tab Class
18.10.35. HTML_TabWidget Class
18.10.36. HTML_Text Class
18.10.37. HTML_TextArea Class
18.10.38. HTML_TextBase Class
18.10.39. HTML_XPathResult Class
18.10.40. JsObject Class
18.10.41. JavaScript Extension API
18.11. Flex Object API
18.12. Windows Object API
18.13. Android Convenience API
18.13.1. GestureBuilder
18.14. Python Notes
18.14.1. Default File Encoding (UTF-8)
18.14.2. Default type of string return values (Unicode)
18.14.3. Squish's Python Modules
18.14.4. Python Types Hidden by Squish
18.14.5. Python Functions Hidden by Squish
18.14.6. Importing Custom Python Modules
18.14.7. Using Squish Functions in Python Modules/Packages
18.14.8. Language Documentation
18.15. Tcl Notes
18.15.1. Language Documentation
18.16. JavaScript Notes and Extension APIs
18.16.1. Language Documentation
18.16.2. Language Core
18.16.3. File Object
18.16.4. OS Object
18.16.5. XML Object
18.16.6. SQL
18.16.7. Socket Object
18.17. Perl Notes
18.17.1. Language Documentation
18.18. Ruby Notes
18.18.1. Language Documentation

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 17) 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 18.4.2) (Qt), JavaScript Extension API (Section 18.10.41) (Web), and Java Extension API for Custom Widgets (Section 18.7.3) (Java).)

[Note]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.