IDriverElement

Represents the API for a potential application element

Unreal Engine C++ API Reference > Developer > AutomationDriver

Inheritance Hierarchy

References

   
Module AutomationDriver
Header /Engine/Source/Developer/AutomationDriver/Public/IDriverElement.h
Include #include "IDriverElement.h"

Syntax

class IDriverElement : public [IElementLocator](API\Developer\AutomationDriver\IElementLocator)  

Remarks

Represents the API for a potential application element

Functions

Type Name Description
bool CanFocus ()  
bool Click ( EMouseButtons::Type MouseButton ) Moves the cursor over the element, then triggers the series of events to invoke a click with the specified mouse button
bool Click () Moves the cursor over the element, then triggers the series of events to invoke a click with the left mouse button
bool DoubleClick ( EMouseButtons::Type MouseButton ) Moves the cursor over the element, then triggers the series of events to invoke a double click with the specified mouse button
bool DoubleClick () Moves the cursor over the element, then triggers the series of events to invoke a double click with the left mouse button
bool Exists ()  
bool Focus ( uint32 UserIndex ) Moves focus to the element for the specified user
bool Focus () Moves focus to the element for the default user
FVector2D GetAbsolutePosition ()  
FVector2D GetSize ()  
FText GetText ()  
bool HasFocusedDescendants ()  
bool HasFocusedDescendants ( uint32 UserIndex )  
bool Hover () Moves the cursor over the element, triggering any hover cue the element may have
bool IsChecked ()  
bool IsFocused ()  
bool IsFocused ( uint32 UserIndex )  
bool IsHovered ()  
bool IsInteractable ()  
bool IsScrollable ()  
bool IsScrolledToBeginning ()  
bool IsScrolledToEnd ()  
bool IsVisible ()  
bool Press ( FKey Key ) Moves focus to the element, then triggers the series of events to invoke keyboard input for pressing the specified key.
bool Press ( EMouseButtons::Type MouseButton ) Moves the cursor over the element, then triggers the series of events to invoke mouse input for pressing the specified button.
bool Press ( TCHAR Character ) Moves focus to the element, then triggers the series of events to invoke keyboard input for pressing the specified character.
bool PressChord ( FKey Key1, FKey Key2 ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from 1 to N.
bool PressChord ( FKey Key1, TCHAR Character ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from 1 to N.
bool PressChord ( FKey Key1, FKey Key2, FKey Key3 ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from 1 to N.
bool PressChord ( FKey Key1, FKey Key2, TCHAR Character ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from 1 to N.
bool Release ( TCHAR Character ) Moves focus to the element, then triggers the series of events to invoke keyboard input for releasing the specified character.
bool Release ( FKey Key ) Moves focus to the element, then triggers the series of events to invoke keyboard input for releasing the specified key.
bool Release ( EMouseButtons::Type MouseButton ) Moves the cursor over the element, then triggers the series of events to invoke mouse input for releasing the specified button.
bool ReleaseChord ( FKey Key1, FKey Key2, TCHAR Character ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from N to 1.
bool ReleaseChord ( FKey Key1, FKey Key2, FKey Key3 ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from N to 1.
bool ReleaseChord ( FKey Key1, FKey Key2 ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from N to 1.
bool ReleaseChord ( FKey Key1, TCHAR Character ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from N to 1.
bool ScrollBy ( float Delta ) Moves the cursor over the element, then triggers the series of events to invoke a mouse wheel scroll by the specified delta.
bool ScrollToBeginning () Moves the cursor over the element, then triggers the series of events to invoke a mouse wheel scroll, scrolling the element until it reaches the beginning
bool ScrollToBeginning ( float Amount ) Moves the cursor over the element, then triggers the series of events to invoke a mouse wheel scroll by the specified delta amount, scrolling the element until it reaches the beginning
bool ScrollToBeginningUntil ( const TSharedRef< IElementLocator, ... ) Moves the cursor over the element, then triggers the series of events to invoke a mouse wheel scroll until the specified locator is locates the desired element or the beginning is reached
bool ScrollToEnd () Moves the cursor over the element, then triggers the series of events to invoke a mouse wheel scroll, scrolling the element until it reaches the beginning
bool ScrollToEnd ( float Amount ) Moves the cursor over the element, then triggers the series of events to invoke a mouse wheel scroll by the specified delta amount, scrolling the element until it reaches the end
bool ScrollToEndUntil ( const TSharedRef< IElementLocator, ... ) Moves the cursor over the element, then triggers the series of events to invoke a mouse wheel scroll until the specified locator is locates the desired element or the end is reached
bool Type ( const TArray< FKey >& Keys ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each key specified.
bool Type ( const TCHAR* Text ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each character specified.
bool Type ( FString Text ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each character specified.
bool Type ( FKey Key ) Moves focus to the element, then triggers the series of events to invoke keyboard input for the specified character.
bool Type ( TCHAR Character ) Moves focus to the element, then triggers the series of events to invoke keyboard input for the specified key.
bool TypeChord ( FKey Key1, TCHAR Character ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from 1 to N and then releasing those keys in order from N to 1 Chord typing is intended to ease the to execution keyboard shortcuts, such as, CTRL + SHIFT + S
bool TypeChord ( FKey Key1, FKey Key2, FKey Key3 ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from 1 to N and then releasing those keys in order from N to 1 Chord typing is intended to ease the to execution keyboard shortcuts, such as, CTRL + SHIFT + S
bool TypeChord ( FKey Key1, FKey Key2 ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from 1 to N and then releasing those keys in order from N to 1 Chord typing is intended to ease the to execution keyboard shortcuts, such as, CTRL + SHIFT + S
bool TypeChord ( FKey Key1, FKey Key2, TCHAR Character ) Moves focus to the element, then triggers the series of events to invoke keyboard input for each argument in order from 1 to N and then releasing those keys in order from N to 1 Chord typing is intended to ease the to execution keyboard shortcuts, such as, CTRL + SHIFT + S

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library