Squish/Interacting with Menus

Interacting with menus and menu items

In Verifying the existence of a menu item, we saw how to access single menu items using Squish's real name approach. We can use this approach again, to implement support for dynamically interacting with menus and menu items. That is, we implement one single function for interacting with all menu items in the main window of the AUT, including menu items in sub-menus.

Consider the menu structure above - if we simply record interaction with File -> New…, Edit-> Find -> Find… and Edit-> Find -> Advanced-> Find & Replace…, we end up with code such as:

# File -> New…
activateItem(waitForObjectItem(":MainWindow.menuBar_QMenuBar", "File"))
activateItem(waitForObjectItem(":MainWindow.File_QMenu", "New…"))

# Edit-> Find -> Find…
activateItem(waitForObjectItem(":MainWindow.menuBar_QMenuBar", "Edit"))
activateItem(waitForObjectItem(":MainWindow.Edit_QMenu", "Find"))
activateItem(waitForObjectItem(":Edit.Find_QMenu", "Find…"))

# Edit-> Find -> Advanced-> Find & Replace…
activateItem(waitForObjectItem(":MainWindow.menuBar_QMenuBar", "Edit"))
activateItem(waitForObjectItem(":MainWindow.Edit_QMenu", "Find"))
activateItem(waitForObjectItem(":Edit.Find_QMenu", "Advanced"))
activateItem(waitForObjectItem(":Find.Advanced_QMenu", "Find & Replace…"))

This code requires the menu objects, including the sub-menus, to be added to the object map, which in turn requires us to always record when interacting with a menu or sub-menu that Squish does not yet know about. With the real name approach, we can get around this.

Adding support for any level of menu depth can be done by implementing a function that takes an arbitrary number of arguments, such as below:

def activateMenuItem(menu, *menuPath):
  for item in menuPath:
    activateItem(waitForObjectItem(menu, item))
    menu = {"title": item, "type": "QMenu", "visible": "1", "window": menu["window"]}

The code above only requires one object to be in the object map, and that is the menu bar. Of course, that can also be changed into a real name instead, if necessary.

Usage would simply be:

activateMenuItem(":MainWindow.menuBar_QMenuBar", "File", "New…")
activateMenuItem(":MainWindow.menuBar_QMenuBar", "Edit", "Find", "Find…")
activateMenuItem(":MainWindow.menuBar_QMenuBar", "Edit", "Find", "Advanced", "Find & Replace…")

If you want to use the object names instead the menu strings (e.g. due to translation of the strings) you can use the following function

def activateMenuItem(menu, *menuObjectPath):
  for item in menuObjectPath:
    children = object.children(waitForObject(menu))
    for child in children:
      if child.objectName == item:
        txt = child.title if hasattr(child, 'title') else child.text
        activateItem(waitForObjectItem(menu, txt))
        menu = {"title": item, "type": "QMenu", "visible": "1", "window": menu["window"]}
        break

def foo():
  # assume the object names of 'File' is 'menuFile' and 'New...' is 'actionNew' 
  activateMenuItem(":MainWindow.menuBar_QMenuBar", "menuFile", "actionNew")