Module enthought.guitest.win32.guitest

AttachWin(*args)

AttachWin(HWND hwnd, BOOL fAttach) -> BOOL

CheckButton(*args)

CheckButton(HWND hwnd)

The names say it. Works on radio buttons and checkboxes. For regular buttons, use IsWindowEnabled.

ClientToScreen(*args)

ClientToScreen(HWND hwnd, int x, int y, int out_x, int out_y)

EnableWindow(*args)

EnableWindow(HWND hwnd, BOOL fEnable) -> BOOL

FindAndCheck(window, parent = None)

Find the check button item specified as either a window id (HWND) or window title and then check it.

FindWindowLike(titlere, classre = '', childid = None, maxlevel = None, window = None)

Finds the window handles of the windows matching the specified parameters and returns them as a list. The search strings may all be passed as regular expressions.

You may specify the handle of the window to search under. The routine searches through all of this windows children and their children recursively. If 'undef' then the routine searches through all windows. There is also a regexp used to match against the text in the window caption and another regexp used to match against the text in the window class. If you pass a child ID number, the functions will only match windows with this id.

GetActiveWindow(*args)

GetActiveWindow(HWND hwnd) -> HWND

GetCaretPos(*args)

GetCaretPos(HWND hwnd, int out_x, int out_y)

Retrieves the caret's position, in client coordinates as (x,y) array. (Like Windows function)

GetChildDepth(*args)

GetChildDepth(HWND hAncestor, HWND hChild) -> DWORD

Using the GetParent library function in a loop, returns the distance between an ancestor window and a child (descendant) window.

Features/bugs:

If the given 'ancsetor' is not really an ancestor, the return value is the distance of child from the root window (0). If you supply the same id for both the ancestor and the child you get 1. If the ancestor you are checking is not 0 then the distance given is 1 larger than it should be.

GetChildWindows(*args)

GetChildWindows(HWND hWnd, int nelem) -> HWND

Using EnumChildWindows library function (see MSDN) it returns the WindowID of each child window. If the children have their own children the function returns them too until the tree ends.

GetClassName(*args)

GetClassName(HWND hwnd) -> char

Using the same Windows library function returns the name of the class wo which the specified window belongs.

See MSDN for more details.

You can also check out MSDN to see an overview of the Window Classes.

GetComboContents(*args)

GetComboContents(HWND hWnd) -> VectorString

GetComboText(*args)

GetComboText(HWND hwnd, int index) -> char

GetCursorPos(*args)

GetCursorPos(int out_x, int out_y)

Retrieves the cursor's position,in screen coordinates as (x,y) array.

GetDesktopWindow(*args)

GetDesktopWindow() -> HWND

Returns a handle to the desktop window

GetFocus(*args)

GetFocus(HWND hwnd) -> HWND

GetForegroundWindow(*args)

GetForegroundWindow() -> HWND

GetListContents(*args)

GetListContents(HWND hWnd) -> VectorString

Fetch the contents of the list and combo boxes.

GetListText(*args)

GetListText(HWND hwnd, int index) -> char

GetListViewContents(*args)

GetListViewContents(HWND hWnd) -> VectorString

Returns a list of the contents of the specified list view.

GetMenu(*args)

GetMenu(HWND hWnd) -> HMENU

Using the corresponding library function (see MSDN) it returns a MenuID number

GetMenuItemCount(*args)

GetMenuItemCount(HMENU hMenu) -> int

Returns the number of elements in the given menu.

GetMenuItemID(*args)

GetMenuItemID(HMENU hMenu, int nPos) -> UINT

GetMenuItemIndex(*args)

GetMenuItemIndex(HMENU hm, char sitem) -> int

First argument is a MenuId and the second is the (localized !) name of the menu including the hot key:'Rep&eat'.

Returns the index of the menu item (-1 if not found)

GetMenuItemInfo(*args)

GetMenuItemInfo(HMENU hMenu, UINT uItem) -> VectorString

Receives a menu handler (one we got from GetMenu or GetSubMenu) and a number (which is the location of the item within the given menu).

Returns a hash of which there are currently 2 keys: type can be either 'string' or 'separator' - this is the type of the menu item text is the visible text of the menu item (provided only for 'string' type)

WARNING: This is an experimental function. Its behavior might change.

GetParent(*args)

GetParent(HWND hwnd) -> HWND

A library function (see MSDN) to return the WindowID of the parent window. See MSDN for the special cases.

GetScreenRes(*args)

GetScreenRes(int out_x, int out_y)

Returns screen resolution.

GetSubMenu(*args)

GetSubMenu(HMENU hMenu, int nPos) -> HMENU

GetSystemMenu(*args)

GetSystemMenu(HWND hWnd, BOOL bRevert) -> HMENU

GetTabItems(*args)

GetTabItems(HWND hWnd) -> VectorString

Returns a list of a tab control's labels.

GetTopLevelWindows(*args)

GetTopLevelWindows(int nelem) -> HWND

Using EnumWindows library function (see MSDN) it returns the WindowID of all the top-level window.

GetTreeViewSelPath(*args)

GetTreeViewSelPath(HWND hWnd) -> char

Returns a string containing the path (i.e., 'parent|child') of the currently selected tree view item.

oldpath = GetTreeViewSelPath(window) SelTreeViewItemPath(window, 'Parent|Child') SelTreeViewItemPath(window, oldpath);

GetWindow(*args)

GetWindow(HWND hwnd, UINT uCmd) -> HWND

GetWindowID(window)

Returns the control Id of the specified window.

GetWindowLong(*args)

GetWindowLong(HWND hwnd, int index) -> long

GetWindowRect(*args)

GetWindowRect(HWND hWnd, int left, int top, int right, int bottom)

GetWindowText(*args)

GetWindowText(HWND hwnd) -> char

Get the text name of the window as shown on the top of it. Beware, this is text depends on localization.

GrayOutButton(*args)

GrayOutButton(HWND hwnd)

The names say it. Works on radio buttons and checkboxes. For regular buttons, use IsWindowEnabled.

IsCheckedButton(*args)

IsCheckedButton(HWND hwnd) -> BOOL

The names say it. Works on radio buttons and checkboxes. For regular buttons, use IsWindowEnabled.

IsChild(*args)

IsChild(HWND hWndParent, HWND hWnd) -> BOOL

Using the corresponding library function (see MSDN) it returns true if the second window is an immediate child or a descendant window of the first window.

IsGrayedButton(*args)

IsGrayedButton(HWND hwnd) -> BOOL

The names say it. Works on radio buttons and checkboxes. For regular buttons, use IsWindowEnabled.

IsKeyPressed(*args)

IsKeyPressed(char name) -> BOOL

Wrapper around the GetAsyncKeyState API function. Returns TRUE if the user presses the specified key.

IsKeyPressed('ESC') IsKeyPressed('A') IsKeyPressed('DOWN')

IsListViewItemSel(*args)

IsListViewItemSel(HWND hWnd, char lpItem) -> BOOL

Determines if the specified list view item is selected.

IsTabItemSel(*args)

IsTabItemSel(HWND hWnd, char lpItem) -> BOOL

Determines if the specified tab item is selected.

IsWindow(*args)

IsWindow(HWND hwnd) -> BOOL

IsWindowEnabled(*args)

IsWindowEnabled(HWND hwnd) -> BOOL

IsWindowStyle(window, style)

Determines if a window has the specified style. See sample script for more details.

IsWindowStyleEx(window, exstyle)

Determines if a window has the specified extended style.

IsWindowVisible(*args)

IsWindowVisible(HWND hwnd) -> BOOL

MatchTitleOrId(window, regex)

MenuSelect(item, window = None, menu = None)

Allows selecting a menu programmatically.

Simple Examples: # Exit foreground application through application menu. MenuSelect('&File|E&xit')

# Exit foreground application through system menu MenuSelect('&Close', 0, GetSystemMenu(GetForegroundWindow(), False))

MenuSelectItem(window, menu, items)

Parameters: window (Window Handle), menu (Parent/Root Menu), items (Menu Item Path).

Returns: False on failure, True on success

MouseClick(window, parent = None, x_off = 0, y_off = 0, button = '{LEFT}', delay = 0)

Allows one to easily interact with an application through mouse emulation.

window - Regexp for a Window caption / Child caption, or just a Child ID.

parent - Handle to parent window. Default is foreground window. Use GetDesktopWindow() return value for this if clicking on an application title bar.

x_off - Offset for X axis. Default is 0.

y_off - Offset for Y axis. Default is 0.

button - {LEFT}, {MIDDLE}, {RIGHT}. Default is {LEFT}

delay - Default is 0. 0.50 = 500 ms. Delay between button down and button up.

Simple Examples:

# Click on CE button if its parent window is in foreground. MouseClick('^CE$')

# Right click on CE button if its parent window is in foreground MouseClick('^CE$', button='{RIGHT}')

# Click on 8 button window under the specified parent window; where # [PARENTHWND] will be replaced by a parent handle variable. MouseClick('8', [PARENTHWND]);

# Click on Calculator parent window itself MouseClick('Calculator', GetDesktopWindow());

MouseMoveAbsPix(*args)

MouseMoveAbsPix(int x, int y)

Move the mouse cursor to the screen pixel indicated as parameter.: # Moves to x=200, y=100 in pixel coordinates. MouseMoveAbsPix(200, 100);

MouseMoveWheel(*args)

MouseMoveWheel(DWORD dwChange)

Positive or negative value to direct mouse wheel movement.

NormToScreen(*args)

NormToScreen(int x, int y, int out_x, int out_y)

The opposite transformation to ScreenToNorm

PostMessage(*args)

PostMessage(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam) -> int

See corresponding Windows library function in MSDN.

PushButton(button, delay)

Equivalent to PushChildButton(GetForegroundWindow(), button, delay)

PushChildButton(parent, button, delay = 0)

Allows generating a mouse click on a particular button.

parent - the parent window of the button

button - either the text in a button (e.g.'Yes') or the control ID of a button.

delay - the time (0.25 means 250 ms) to wait between the mouse down and the mouse up event. This is useful for debugging.

ScreenToClient(*args)

ScreenToClient(HWND hwnd, int x, int y, int out_x, int out_y)

ScreenToNorm(*args)

ScreenToNorm(int x, int y, int out_x, int out_y)

Returns normalised coordinates of given point (0-FFFF as a fraction of screen resolution)

SelComboItem(*args)

SelComboItem(HWND hWnd, int iItem) -> BOOL

Selects an item in the combo box based off an index (zero-based).

SelComboItemText(*args)

SelComboItemText(HWND hWnd, char lpItem) -> BOOL

Selects an item in the combo box based off text (case insensitive).

SelectTabItem(window, item, parent = None)

Select tab item of window given item number and parent.

SelListViewItem(*args)

SelListViewItem(HWND hWnd, int iItem, BOOL bMulti=False) -> BOOL SelListViewItem(HWND hWnd, int iItem) -> BOOL

Selects an item in the list view based off an index (zero-based).

# Select first item, clears out any previous selections. SelListViewItem(win, 0) # Select an additional item. SelListViewItem(win, 1, 1)

SelListViewItemText(*args)

SelListViewItemText(HWND hWnd, char lpItem, BOOL bMulti=False) -> BOOL SelListViewItemText(HWND hWnd, char lpItem) -> BOOL

Selects an item in the list view based off text (case insensitive).

# Select first item, clears out any previous selections. SelListViewItemText($win, 'Temp') # Select an additional item. SelListViewItemText($win, 'cabs', 1)

SelTabItem(*args)

SelTabItem(HWND hWnd, int iItem) -> BOOL

Selects a tab based off an index (zero-based).

SelTabItemText(*args)

SelTabItemText(HWND hWnd, char lpItem) -> BOOL

Selects a tab based off text label (case insensitive).

SelTreeViewItemPath(*args)

SelTreeViewItemPath(HWND hWnd, char lpPath) -> BOOL

Selects a tree view item based off a 'path' (case insensitive).

# Select Machine item and Processors sub-item. SelTreeViewItemPath(window, 'Machine|Processors')

SelTreeViewItemPath(window, 'Item')

SendKeys(keys, delay = 50)

Sends keystrokes to the active window as if typed at the
keyboard using the optional delay between keystrokes (default is
50 ms and should be OK for most uses).

The keystrokes to send are specified in KEYS. There are several
characters that have special meaning. This allows sending control
codes and modifiers:

- ~ means ENTER
- + means SHIFT 
- ^ means CTRL 
- % means ALT

The parens allow character grouping. You may group several
characters, so that a specific keyboard modifier applies to all of
them.  E.g. SendKeys('ABC') is equivalent to SendKeys('+(abc)').

The curly braces are used to quote special characters (SendKeys('{+}{{}')
sends a '+' and a '{'). You can also use them to specify certain
named actions:

===========   ======================
Name          Action
===========   ======================
{BACKSPACE}   Backspace
{BS}          Backspace
{BKSP}        Backspace
{BREAK}       Break
{CAPS}        Caps Lock
{DELETE}      Delete
{DOWN}        Down arrow
{END}         End
{ENTER}       Enter (same as ~)
{ESCAPE}      Escape
{HELP}        Help key
{HOME}        Home
{INSERT}      Insert
{LEFT}        Left arrow
{NUMLOCK}     Num lock
{PGDN}        Page down
{PGUP}        Page up
{PRTSCR}      Print screen
{RIGHT}       Right arrow
{SCROLL}      Scroll lock
{TAB}         Tab
{UP}          Up arrow
{PAUSE}       Pause
{F1}          Function Key 1
...           ...
{F24}         Function Key 24
{SPC}         Spacebar
{SPACE}       Spacebar
{SPACEBAR}    Spacebar
{LWI}         Left Windows Key
{RWI}         Right Windows Key 
{APP}         Open Context Menu Key
===========   ======================

All these named actions take an optional integer argument, like in
{RIGHT 5}.  For all of them, except PAUSE, the argument means a
repeat count. For PAUSE it means the number of milliseconds SendKeys
should pause before proceding.

In this implementation, SendKeys always returns after sending the
keystrokes.  There is no way to tell if an application has processed
those keys when the function returns.

SendKeysImp(*args)

SendKeysImp(char s, DWORD wait)

SendLButtonDown(*args)

SendLButtonDown()

SendLButtonUp(*args)

SendLButtonUp()

SendMButtonDown(*args)

SendMButtonDown()

SendMButtonUp(*args)

SendMButtonUp()

SendMessage(*args)

SendMessage(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam) -> int

This is a library function (see MSDN) used by a number of the functions provided by Win32::GuiTest. It sends the specified message to a window or windows. HWnd is the WindowID or HWND_BROADCAST to send message to all top level windows. Message is not sent to child windows. (If I understand this correctly this means it is sent to all the immediate children of the root window (0). Msg the message wParam additional parameter lParam additioanl parameter

It is most likely you won't use this directly but through one of the other functions .

SendMouse(command)

This function emulates mouse input. The command parameter is a string containing one or more of the following substrings:

{LEFTDOWN} left button down
{LEFTUP} left button up
{MIDDLEDOWN} middle button down
{MIDDLEUP} middle button up
{RIGHTDOWN} right button down
{RIGHTUP} right button up
{LEFTCLICK} left button single click
{MIDDLECLICK} middle button single click
{RIGHTCLICK} right button single click
{ABSx,y} move to absolute coordinate ( x, y )
{RELx,y} move to relative coordinate ( x, y )

Note: Absolute mouse coordinates range from 0 to 65535. Relative coordinates can be positive or negative. If you need pixel coordinates you can use MouseMoveAbsPix.

Also equivalent low-level functions are available:

SendLButtonUp()
SendLButtonDown()
SendMButtonUp()
SendMButtonDown()
SendRButtonUp()
SendRButtonDown()
SendMouseMoveRel(x,y)
SendMouseMoveAbs(x,y)

SendMouseMoveAbs(*args)

SendMouseMoveAbs(int x, int y)

SendMouseMoveRel(*args)

SendMouseMoveRel(int x, int y)

SendRawKey(*args)

SendRawKey(UINT vk, DWORD flags)

Wrapper around keybd_event. Allows sending low-level keys. The first argument is any of the VK_* constants. The second argument can be 0, KEYEVENTF_EXTENDEDKEY, KEYEVENTF_KEYUP or a combination of them.

KEYEVENTF_EXTENDEDKEY - Means it is an extended key (i.e. to distinguish between arrow keys on the numeric keypad and elsewhere).

KEYEVENTF_KEYUP - Means keyup. Unspecified means keydown.

#Example use Win32::GuiTest qw/:FUNC :VK/;

while 1:

SendRawKey(VK_DOWN, KEYEVENTF_EXTENDEDKEY) SendKeys('{PAUSE 200}');

SendRButtonDown(*args)

SendRButtonDown()

SendRButtonUp(*args)

SendRButtonUp()

SetActiveWindow(*args)

SetActiveWindow(HWND hwnd) -> HWND

SetFocus(*args)

SetFocus(HWND hWnd) -> HWND

Sets the keyboard focus to the specified window

SetForegroundWindow(*args)

SetForegroundWindow(HWND hWnd) -> BOOL

See corresponding Windows functions.

SetWindowPos(*args)

SetWindowPos(HWND hWnd, HWND hWndInsertAfter, int X, int Y, int cx,: int cy, UINT uFlags) -> BOOL

ShowWindow(*args)

ShowWindow(HWND hwnd, int nCmdShow) -> BOOL

TabCtrl_GetCurFocus(*args)

TabCtrl_GetCurFocus(HWND hWnd) -> int

TabCtrl_GetItemCount(*args)

TabCtrl_GetItemCount(HWND hWnd) -> int

TabCtrl_SetCurFocus(*args)

TabCtrl_SetCurFocus(HWND hWnd, int item)

TabCtrl_SetCurSel(*args)

TabCtrl_SetCurSel(HWND hWnd, int item) -> int

UnCheckButton(*args)

UnCheckButton(HWND hwnd)

The names say it. Works on radio buttons and checkboxes. For regular buttons, use IsWindowEnabled.

WaitWindow(titlere, wait = 10)

Minimal version of WaitWindowLike. Only requires the window title regexp. You can also specify the wait timeout in seconds.

titlere - Regexp for the window title

wait - How many seconds should we wait before giving up

WaitWindowLike(parent, titlere, classre, wid, depth, wait = 10)

Function which allows one to wait for a window to appear vs. using hard waits (e.g. sleep 2).

parent - Where to start (parent window)

titlere - Regexp for the window title

classre - Regexp for the window class name

wid - Numeric Window or Control ID

depth - How deep should we search before we stop

wait - How many seconds should we wait before giving up

WindowFromPoint(*args)

WindowFromPoint(int x, int y) -> HWND

WMGetText(*args)

WMGetText(HWND hwnd) -> char

Sends a WM_GETTEXT to a window and returns its contents

WMSetText(*args)

WMSetText(HWND hwnd, char text) -> int

Sends a WM_SETTEXT to a window setting its contents

Local name	Refers to
_guitest	_guitest
re	re
time	time
types	types

Module enthought.guitest.win32.guitest

Variables

Classes

Function summary

Functions

Imported Names

Module enthought.​guitest.​win32.​guitest

Variables

Classes

Function summary

Functions

Imported Names

Module enthought.guitest.win32.guitest