Index of the controls module
-
m
pywinauto.controls
...
- Controls package
-
m
menuwrapper
...
- Wrapper around Menu's and Menu items
- a Timings ...
-
C
Menu
...
- A simple wrapper around a menu handle
- f Items ... - Return a list of all the items in this menu
- f Item ... - Return a specific menu item
- f GetProperties ... - Return the properties for the menu as a list of dictionaries
- f GetMenuPath ... - Walk the items in this menu to find the item specified by path
- f ItemCount ... - Return the count of items in this menu
- f __init__ ... - Initialize the class.
-
C
MenuItemNotEnabled
...
- Raised when a menuitem is not enabled
-
C
MenuItem
...
- Wrap a menu item
- f SubMenu ... - Return the SubMenu or None if no submenu
- f Index ... - Return the index of this menu item
- f Text ... - Return the state of this menu item
- f IsEnabled ... - Return True if the item is enabled.
- f State ... - Return the state of this menu item
- f ID ... - Return the ID of this menu item
- f __init__ ... - Initalize the menu item
- f IsChecked ... - Return True if the item is checked.
- f Select ... - Select the menu item
- f GetProperties ... - Return the properties for the item as a dict
- f Type ... - Return the Type of this menu item
- f Click ... - Click on the menu item
- f Rectangle ... - Get the rectangle of the menu item
-
m
win32_controls
...
- Wraps various standard windows controls
-
C
StaticWrapper
...
- Wrap a windows Static control
- a handle ...
- a windowclasses ...
- a friendlyclassname ...
- f __init__ ... - Initialize the control
-
C
ListBoxWrapper
...
- Wrap a windows ListBox control
- a windowclasses ...
- a friendlyclassname ...
- f Select ... - Select the ListBox item
- f Texts ... - Return the texts of the control
- f __init__ ... - Initialize the control
- f SetItemFocus ... - Set the ListBox focus to the item at index
- f ItemCount ... - Return the number of items in the ListBox
- f SelectedIndices ... - The currently selected indices of the listbox
- f GetItemFocus ... - Retrun the index of current selection in a ListBox
- f ItemTexts ... - Return the text of the items of the listbox
- f ItemData ... - Return the ItemData if any associted with the item
-
C
ButtonWrapper
...
- Wrap a windows Button control
- a windowclasses ...
- a friendlyclassname ...
- f UnCheck ... - Uncheck a checkbox
- f SetCheckIndeterminate ... - Set the checkbox to indeterminate
- f GetCheckState ... - Return the check state of the checkbox
- f FriendlyClassName ... - Return the friendly class name of the button
- f __init__ ... - Initialize the control
- f Check ... - Check a checkbox
- f IsDialog ... - Buttons are never dialogs so return False
- f Click ... - Click the Button control
-
C
DialogWrapper
...
- Wrap a dialog
- a windowclasses ...
- a friendlyclassname ...
- f ClientAreaRect ... - Return the client area rectangle
- f __init__ ... - Initialize the DialogWrapper
- f WriteToXML ... - Write the dialog an XML file (requires elementtree)
- f RunTests ... - Run the tests on dialog
-
C
EditWrapper
...
- Wrap a windows Edit control
- a windowclasses ...
- a friendlyclassname ...
- f SetText ... - Set the text of the edit control
- f Select ... - Set the edit selection of the edit control
- f Texts ... - Get the text of the edit control
- f LineCount ... - Return how many lines there are in the Edit
- f __init__ ... - Initialize the control
- f TextBlock ... - Get the text of the edit control
- f GetLine ... - Return the line specified
- f SetWindowText ... - Override SetWindowText for edit controls because it should not be used for Edit controls.
- f LineLength ... - Return how many characters there are in the line
- f SelectionIndices ... - The start and end indices of the current selection
- f SetEditText ... - Set the text of the edit control
-
C
ComboBoxWrapper
...
- Wrap a windows ComboBox control
- a windowclasses ...
- a friendlyclassname ...
- f Select ... - Select the ComboBox item
- f Texts ... - Return the text of the items in the combobox
- f GetProperties ... - Return the properties of the control as a dictionary
- f __init__ ... - Initialize the control
- f DroppedRect ... - Get the dropped rectangle of the combobox
- f SelectedIndex ... - Return the selected index
- f ItemCount ... - Return the number of items in the combobox
- f ItemTexts ... - Return the text of the items of the combobox
- f ItemData ... - Return the item data associted with this item
-
C
PopupMenuWrapper
...
- Wrap a Popup Menu
- a windowclasses ...
- a friendlyclassname ...
- f IsDialog ... - Return whether it is a dialog
-
C
StaticWrapper
...
- Wrap a windows Static control
-
m
common_controls
...
- Classes that wrap the Windows Common controls
- C AnimationWrapper ... - Class that wraps Windows Animation common control
-
C
StatusBarWrapper
...
- Class that wraps Windows Status Bar common control
- a windowclasses ...
- a friendlyclassname ...
- f Texts ... - Return the texts for the control
- f PartRightEdges ... - Return the widths of the parts
- f BorderWidths ... - Return the border widths of the StatusBar
- f __init__ ... - Initialise the instance
- f ClientRects ... - Return the client rectangles for the control
- f GetPartRect ... - Return the rectangle of the part specified by part_index
- f GetPartText ... - Return the text of the part specified by part_index
- f PartCount ... - Return the number of parts
-
C
HeaderWrapper
...
- Class that wraps Windows ListView Header common control
- a windowclasses ...
- a friendlyclassname ...
- f GetColumnText ... - Return the text for the column specified by column_index
- f GetColumnRectangle ... - Return the rectangle for the column specified by column_index
- f Texts ... - Return the texts of the Header control
- f __init__ ... - Initialise the instance
- f ItemCount ... - Return the number of columns in this header
- f ClientRects ... - Return all the client rectangles for the header control
-
C
AccessDenied
...
- Raised when we cannot allocate memory in the control's process
-
C
TabControlWrapper
...
- Class that wraps Windows Tab common control
- a windowclasses ...
- a friendlyclassname ...
- f Select ... - Select the specified tab on the tab control
- f Texts ... - Return the texts of the Tab Control
- f RowCount ... - Return the number of rows of tabs
- f GetProperties ... - Return the properties of the TabControl as a Dictionary
- f TabCount ... - Return the number of tabs
- f GetTabRect ... - Return the rectangle to the tab specified by tab_index
- f GetTabText ... - Return the text of the tab
- f __init__ ... - Initialise the instance
- f GetSelectedTab ... - Return the index of the selected tab
- f ClientRects ... - Return the client rectangles for the Tab Control
- C HotkeyWrapper ... - Class that wraps Windows Hotkey common control
-
C
ToolbarWrapper
...
- Class that wraps Windows Toolbar common control
- a windowclasses ...
- a friendlyclassname ...
- f GetButtonRect ... - Get the rectangle of a button on the toolbar
- f Texts ... - Return the texts of the Toolbar
- f ButtonCount ... - Return the number of buttons on the ToolBar
- f GetToolTipsControl ... - Return the tooltip control associated with this control
- f GetButton ... - Return information on the Toolbar button
- f Button ... - Return the button at index button_index
- f PressButton ... - Find where the button is and click it
- f __init__ ... - Initialise the instance
- C PagerWrapper ... - Class that wraps Windows Pager common control
-
C
UpDownWrapper
...
- Class that wraps Windows UpDown common control
- a windowclasses ...
- a friendlyclassname ...
- f GetRange ... - Return the lower, upper range of the up down control
- f GetBase ... - Get the base the UpDown control (either 10 or 16)
- f __init__ ... - Initialise the instance
- f GetValue ... - Get the current value of the UpDown control
- f SetValue ... - Set the value of the of the UpDown control to some integer value
- f GetBuddyControl ... - Get the buddy control of the updown control
- f Increment ... - Increment the number in the UpDown control by one
- f Decrement ... - Decrement the number in the UpDown control by one
-
C
TreeViewWrapper
...
- Class that wraps Windows TreeView common control
- a windowclasses ...
- a friendlyclassname ...
- f Select ... - Select the treeview item
- f Texts ... - Return all the text for the tree view
- f GetProperties ... - Get the properties for the control as a dictionary
- f __init__ ... - Initialise the instance
- f ItemCount ... - Return the count of the items in the treeview
- f EnsureVisible ... - Make sure that the TreeView item is visible
- f IsSelected ... - Return True if the item is selected
- f Root ... - Return the root element of the tree view
- C ProgressWrapper ... - Class that wraps Windows Progress common control
-
C
ToolTipsWrapper
...
- Class that wraps Windows ToolTips common control (not fully implemented)
- a windowclasses ...
- a friendlyclassname ...
- f Texts ... - Return the text of all the tooltips
- f __init__ ... - Initialize the instance
- f ToolCount ... - Return the number of tooltips
- f GetTipText ... - Return the text of the tooltip
- C ComboBoxExWrapper ... - Class that wraps Windows ComboBoxEx common control
- C CalendarWrapper ... - Class that wraps Windows Calendar common control
- C TrackbarWrapper ... - Class that wraps Windows Trackbar common control
- C IPAddressWrapper ... - Class that wraps Windows IPAddress common control
- C DateTimePickerWrapper ... - Class that wraps Windows DateTimePicker common control
-
C
ReBarWrapper
...
- Class that wraps Windows ReBar common control
- a windowclasses ...
- a friendlyclassname ...
- f Texts ... - Return the texts of the Rebar
- f GetBand ... - Get a band of the ReBar control
- f GetToolTipsControl ... - Return the tooltip control associated with this control
- f BandCount ... - Return the number of bands in the control
- f __init__ ... - Initialise the instance
- C ToolTip ... - Class that Wraps a single tip from a ToolTip control
- C BandWrapper ... - Simple wrapper around REBARBANDINFOW to allow setting new attributes
-
C
ListViewWrapper
...
- Class that wraps Windows ListView common control
- a windowclasses ...
- a friendlyclassname ...
- f IsFocused ... - Return True if the item has the focus
- f GetColumn ... - Get the information for a column of the ListView
- f Check ... - Check the ListView item
- f Select ... - Mark the item as selected
- f ItemCount ... - The number of items in the ListView
- f Items ... - Get all the items in the list view
- f Deselect ... - Mark the item as not selected
- f Columns ... - Get the information on the columns of the ListView
- f IsSelected ... - Return True if the item is selected
- f GetHeaderControl ... - Returns the Header control associated with the ListView
- f GetSelectedCount ... - Return the number of selected items
- f __init__ ... - Initialise the instance
- f ColumnCount ... - Return the number of columns
- f UnCheck ... - Uncheck the ListView item
- f GetItemRect ... - Return the bounding rectangle of the list view item
- f IsChecked ... - Return whether the ListView item is checked or not
- f Texts ... - Get the texts for the ListView control
- f GetItem ... - Return the item of the list view"
- f ColumnWidths ... - Return a list of all the column widths
-
m
HwndWrapper
...
- Basic wrapping of Windows controls
- C InvalidWindowHandle ... - Raised when an invalid handle is passed to HwndWrapper
-
C
HwndWrapper
...
- Default wrapper for controls.
- f PostMessage ... - Post a message to the control message queue and return
- f ProcessID ... - Return the ID of process that owns this window
- f SendMessageTimeout ... - Send a message to the control and wait for it to return or to timeout
- f IsChild ... - Return True if this window is a child of 'parent'.
- f ReleaseMouseInput ... - Release the mouse button
- f ReleaseMouse ... - Release the mouse button
- f Menu ... - Return the menu of the control
- f Style ... - Returns the style of window
- f GetShowState ... - Get the show state and Maximized/minimzed/restored state
- f Close ... - Close the window
- f ContextHelpID ... - Return the Context Help ID of the window
- f Texts ... - Return the text for each item of this control"
- f SendMessage ... - Send a message to the control and wait for it to return
- f VerifyActionable ... - Verify that the control is both visible and enabled
- f GetProperties ... - Return the properties of the control as a dictionary
- f IsVisible ... - Whether the window is visible or not
- f VerifyEnabled ... - Verify that the control is enabled
- f PressMouse ... - Press the mouse button
- f Rectangle ... - Return the rectangle of window
- f SetFocus ... - Set the focus to this control
- f Parent ... - Return the parent of this control
- f MenuSelect ... - Select the menuitem specifed in path
- f MoveMouse ... - Move the mouse
- f MenuItems ... - Return the menu items for the dialog
- f MoveWindow ... - Move the window to the new coordinates
- f FriendlyClassName ... - Return the friendly class name for the control
- f ControlCount ... - Return the number of children of this control
- f SetApplicationData ... - Application data is data from a previous run of the software
- f DragMouse ... - Drag the mouse
- f WindowText ... - Window text of the control
- f __init__ ... - Initialize the control
- f DoubleClick ... - Perform a double click action
- f Class ... - Return the class name of the window
- f IsDialog ... - Return true if the control is a top level window
- f Click ... - Simulates a mouse click on the control
- f Minimize ... - Minimize the window
- f ClientRects ... - Return the client rect for each item in this control
- f IsEnabled ... - Whether the window is enabled or not
- f Fonts ... - Return the font for each item in this control
- f TypeKeys ... - Type keys to the window using SendKeys
- f DebugMessage ... - Write some debug text over the window
- f IsUnicode ... - Whether the window is unicode or not
- f Scroll ... - Ask the control to scroll itself
- f DoubleClickInput ... - Double click at the specified coordinates
- f NotifyParent ... - Send the notification message to parent of this control
- f __eq__ ... - Returns True if the handles of both controls are the same
- f PressMouseInput ... - Press a mouse button using SendInput
- f VerifyVisible ... - Verify that the control is visible
- f DrawOutline ... - Draw an outline around the window
- f HasExStyle ... - Return True if the control has the specified extended sytle
- f PopupWindow ... - Return any owned Popups
- f UserData ... - Extra data associted with the window
- f HasStyle ... - Return True if the control has the specified sytle
- f RightClickInput ... - Right click at the specified coords
- f SetWindowText ... - Set the text of the window
- f Restore ... - Restore the window
- f ClickInput ... - Click at the specified coordinates
- f CaptureAsImage ... - Return a PIL image of the control
- f TopLevelParent ... - Return the top level window of this control
- f ClientRect ... - Returns the client rectangle of window
- f GetFocus ... - Return the control in the process of this window that has the Focus
- f ExStyle ... - Returns the Extended style of window
- f Maximize ... - Maximize the window
- f ControlID ... - Return the ID of the window
- f Font ... - Return the font of the window
- f RightClick ... - Perform a right click action
- f Children ... - Return the children of this control as a list
- f CloseClick ... - Peform a click action that should make the window go away
-
C
ControlNotVisible
...
- Raised when a control is nto visible
-
C
ControlNotEnabled
...
- Raised when a control is not enabled
- f GetDialogPropsFromHandle ... - Get the properties of all the controls as a list of dictionaries
-
m
menuwrapper
...
- Wrapper around Menu's and Menu items