API Reference for Enthought Tool Suite 3.0.1

Classes

• Bunch - See http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52308
• WinGuiAutoError

Function summary

• activateMenuItem(hWnd, menuItemPath)
• clickButton(hwnd)
• clickStatic(hwnd)
• doubleClickStatic(hwnd)
• dumpWindow(hwnd)
• findControl(topHwnd, wantedText = None, wantedClass = None, selectionFunction = None)
• findControls(topHwnd, wantedText = None, wantedClass = None, selectionFunction = None)
• findTopWindow(wantedText = None, wantedClass = None, selectionFunction = None)
• findTopWindows(wantedText = None, wantedClass = None, selectionFunction = None)
• getComboboxItems(hwnd)
• getEditText(hwnd)
• getListboxItems(hwnd)
• getMenuInfo(hMenu, uIDItem)
• getTopMenu(hWnd)
• selectComboboxItem(hwnd, item)
• selectListboxItem(hwnd, item)
• setEditText(hwnd, text, append = False)

Functions

• activateMenuItem(hWnd, menuItemPath)

  Activate a menu item.

  Parameters

  hWnd

  The window handle of the top level window whose menu you wish to activate.

  menuItemPath

  The path to the required menu item. This should be a sequence specifying the path through the menu to the required item. Each item in this path can be specified either as an index, or as a menu name.

  Raises

  WinGuiAutoError when the requested menu option isn't found.

  Usage example:

  activateMenuItem(notepadWindow, ('file', 'open'))
  

  Which is exactly equivalent to:

  activateMenuItem(notepadWindow, (0, 1))
  

• clickButton(hwnd)

  Simulates a single mouse click on a button

  Parameters

  hwnd

  Window handle of the required button.

  Usage example:

  okButton = findControl(fontDialog,
                         wantedClass="Button",
                         wantedText="OK")
  clickButton(okButton)
  

• clickStatic(hwnd)

  Simulates a single mouse click on a static

  Parameters

  hwnd

  Window handle of the required static.

  Usage example: TODO

• doubleClickStatic(hwnd)

  Simulates a double mouse click on a static

  Parameters

  hwnd

  Window handle of the required static.

  Usage example: TODO

• dumpWindow(hwnd)

  Dump all controls from a window into a nested list

  Useful during development, allowing to you discover the structure of the contents of a window, showing the text and class of all contained controls.

  Parameters

  hwnd

  The window handle of the top level window to dump.

  Returns

  A nested list of controls. Each entry consists of the control's hwnd, its text, its class, and its sub-controls, if any.

  Usage example:

  replaceDialog = findTopWindow(wantedText='Replace')
  pprint.pprint(dumpWindow(replaceDialog))
  

• findControl(topHwnd, wantedText = None, wantedClass = None, selectionFunction = None)

  Find a control.

  You can identify a control using caption, classe, a custom selection function, or any combination of these. (Multiple selection criteria are ANDed. If this isn't what's wanted, use a selection function.)

  Parameters

  topHwnd

  The window handle of the top level window in which the required controls reside.

  wantedText

  Text which the required control's captions must contain.

  wantedClass

  Class to which the required control must belong.

  selectionFunction

  Control selection function. Reference to a function should be passed here. The function should take hwnd as an argument, and should return True when passed the hwnd of the desired control.

  Returns

  The window handle of the first control matching the supplied selection criteria.

  Raises

  WinGuiAutoError, when no control found.

  Usage example:

  optDialog = findTopWindow(wantedText="Options")
  okButton = findControl(optDialog,
                         wantedClass="Button",
                         wantedText="OK")
  

• findControls(topHwnd, wantedText = None, wantedClass = None, selectionFunction = None)

  Find controls.

  You can identify controls using captions, classes, a custom selection function, or any combination of these. (Multiple selection criteria are ANDed. If this isn't what's wanted, use a selection function.)

  Parameters

  topHwnd

  The window handle of the top level window in which the required controls reside.

  wantedText

  Text which the required controls' captions must contain.

  wantedClass

  Class to which the required controls must belong.

  selectionFunction

  Control selection function. Reference to a function should be passed here. The function should take hwnd as an argument, and should return True when passed the hwnd of a desired control.

  Returns

  The window handles of the controls matching the supplied selection criteria.

  Usage example:

  optDialog = findTopWindow(wantedText="Options")
  def findButtons(hwnd, windowText, windowClass):
      return windowClass == "Button"
  buttons = findControl(optDialog, wantedText="Button")
  

• findTopWindow(wantedText = None, wantedClass = None, selectionFunction = None)

  Find the hwnd of a top level window. You can identify windows using captions, classes, a custom selection function, or any combination of these. (Multiple selection criteria are ANDed. If this isn't what's wanted, use a selection function.)

  Parameters

  wantedText

  Text which the required window's captions must contain.

  wantedClass

  Class to which the required window must belong.

  selectionFunction

  Window selection function. Reference to a function should be passed here. The function should take hwnd as an argument, and should return True when passed the hwnd of a desired window.

  Raises

  WinGuiAutoError

  When no window found.

  Usage example:

  optDialog = findTopWindow(wantedText="Options")
  

• findTopWindows(wantedText = None, wantedClass = None, selectionFunction = None)

  Find the hwnd of top level windows.

  You can identify windows using captions, classes, a custom selection function, or any combination of these. (Multiple selection criteria are ANDed. If this isn't what's wanted, use a selection function.)

  Parameters

  wantedText

  Text which required windows' captions must contain.

  wantedClass

  Class to which required windows must belong.

  selectionFunction

  Window selection function. Reference to a function should be passed here. The function should take hwnd as an argument, and should return True when passed the hwnd of a desired window.

  Returns

  A list containing the window handles of all top level windows matching the supplied selection criteria.

  Usage example:

  optDialogs = findTopWindows(wantedText="Options")
  

• getComboboxItems(hwnd)

  Returns the items in a combo box control.

  Parameters

  hwnd

  Window handle for the combo box.

  Returns

  Combo box items.

  Usage example:

  fontCombo = findControl(fontDialog, wantedClass="ComboBox")
  fontComboItems = getComboboxItems(fontCombo)
  

• getEditText(hwnd)

  Returns the text in an edit control.

  Parameters

  hwnd

  Window handle for the edit control.

  Returns

  Edit control text lines.

  Usage example:

  pprint.pprint(getEditText(editArea))
  

• getListboxItems(hwnd)

  Returns the items in a list box control.

  Parameters

  hwnd

  Window handle for the list box.

  Returns

  List box items.

  Usage example: TODO

• getMenuInfo(hMenu, uIDItem)

  Get various info about a menu item.

  Parameters

  hMenu

  The menu in which the item is to be found.

  uIDItem

  The item's index

  Returns

  Menu item information object. This object is basically a 'bunch' (see http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/52308). It will have useful attributes: name, itemCount, submenu, isChecked, isDisabled, isGreyed, and isSeperator

  Raises

  WinGuiAutoError when the requested menu option isn't found.

  Usage example:

  submenuInfo = getMenuInfo(hMenu, submenu)
  hMenu, hMenuItemCount = submenuInfo.submenu, submenuInfo.itemCount
  

• getTopMenu(hWnd)

  Get a window's main, top level menu.

  Parameters

  hWnd

  The window handle of the top level window for which the top level menu is required.

  Returns

  The menu handle of the window's main, top level menu.

  Usage example:

  hMenu = getTopMenu(hWnd)
  

• selectComboboxItem(hwnd, item)

  Selects a specified item in a Combo box control.

  Parameters

  hwnd

  Window handle of the required combo box.

  item

  The reqired item. Either an index, of the text of the required item.

  Usage example:

  fontComboItems = getComboboxItems(fontCombo)
  selectComboboxItem(fontCombo,
                     random.choice(fontComboItems))
  

• selectListboxItem(hwnd, item)

  Selects a specified item in a list box control.

  Parameter

  hwnd

  Window handle of the required list box.

  item

  The reqired item. Either an index, of the text of the required item.

  Usage example: TODO

• setEditText(hwnd, text, append = False)

  Set an edit control's text.

  Parameters

  hwnd

  The edit control's hwnd.

  text

  The text to send to the control. This can be a single string, or a sequence of strings. If the latter, each will be become a a seperate line in the control.

  append

  Should the new text be appended to the existing text? Defaults to False, meaning that any existing text will be replaced. If True, the new text will be appended to the end of the existing text. Note that the first line of the new text will be directly appended to the end of the last line of the existing text. If appending lines of text, you may wish to pass in an empty string as the 1st element of the 'text' argument.

  Usage example:

  print "Enter various bits of text."
  setEditText(editArea, "Hello, again!")
  time.sleep(.5)
  setEditText(editArea, "You still there?")
  time.sleep(.5)
  setEditText(editArea, ["Here come", "two lines!"])
  time.sleep(.5)
  
  print "Add some..."
  setEditText(editArea, ["", "And a 3rd one!"], append=True)
  time.sleep(.5)
  

Imported Names

© Copyright 2002-2008 Enthought, Inc.