1. Epic GamesDeveloper
  3. IAsyncDriverElement

IAsyncDriverElement

API > API/Developer > API/Developer/AutomationDriver

Represents the async API for a potential application element

   
Name IAsyncDriverElement
Type class
Header File /Engine/Source/Developer/AutomationDriver/Public/IDriverElement.h
Include Path #include "IDriverElement.h"

Syntax

class IAsyncDriverElement : public IElementLocator

Implements Interfaces

Functions

Public

Name Remarks Include Path Unreal Specifiers

TAsyncResult< bool > CanFocus()

   IDriverElement.h  

TAsyncResult< 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 IDriverElement.h  

TAsyncResult< bool > Click ()

 Moves the cursor over the element, then triggers the series of events to invoke a click with the left mouse button IDriverElement.h  

TAsyncResult< 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 IDriverElement.h  
Moves the cursor over the element, then triggers the series of events to invoke a double click with the left mouse button IDriverElement.h  

TAsyncResult< bool > Exists()

   IDriverElement.h  

TAsyncResult< bool > Focus ( uint32 UserIndex
)

 Moves focus to the element for the specified user IDriverElement.h  

TAsyncResult< bool > Focus ()

 Moves focus to the element for the default user IDriverElement.h  

TAsyncResult< FVector2D > GetAbsolutePosition()

   IDriverElement.h  

TAsyncResult< FVector2D > GetSize()

   IDriverElement.h  

TAsyncResult< FText > GetText()

   IDriverElement.h  
  IDriverElement.h  

TAsyncResult< bool > HasFocusedDescendants ( uint32 UserIndex
) const

   IDriverElement.h  

TAsyncResult< bool > Hover()

 Moves the cursor over the element, triggering any hover cue the element may have IDriverElement.h  

TAsyncResult< bool > IsChecked()

   IDriverElement.h  

TAsyncResult< bool > IsFocused ()

   IDriverElement.h  

TAsyncResult< bool > IsFocused ( uint32 UserIndex
) const

   IDriverElement.h  

TAsyncResult< bool > IsHovered()

   IDriverElement.h  

TAsyncResult< bool > IsInteractable()

   IDriverElement.h  

TAsyncResult< bool > IsScrollable()

   IDriverElement.h  

TAsyncResult< bool > IsScrolledToBeginning()

   IDriverElement.h  

TAsyncResult< bool > IsScrolledToEnd()

   IDriverElement.h  

TAsyncResult< bool > IsVisible()

   IDriverElement.h  

TAsyncResult< bool > Press ( FKey Key
)

 Moves focus to the element, then triggers the series of events to invoke keyboard input for pressing the specified key. IDriverElement.h  

TAsyncResult< 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. IDriverElement.h  

TAsyncResult< bool > Press ( TCHAR Character
)

 Moves focus to the element, then triggers the series of events to invoke keyboard input for pressing the specified character. IDriverElement.h  

TAsyncResult< 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. IDriverElement.h  

TAsyncResult< 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. IDriverElement.h  

TAsyncResult< 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. IDriverElement.h  

TAsyncResult< 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. IDriverElement.h  

TAsyncResult< bool > Release ( TCHAR Character
)

 Moves focus to the element, then triggers the series of events to invoke keyboard input for releasing the specified character. IDriverElement.h  

TAsyncResult< bool > Release ( FKey Key
)

 Moves focus to the element, then triggers the series of events to invoke keyboard input for releasing the specified key. IDriverElement.h  

TAsyncResult< 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. IDriverElement.h  

TAsyncResult< 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. IDriverElement.h  

TAsyncResult< 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. IDriverElement.h  

TAsyncResult< 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. IDriverElement.h  

TAsyncResult< 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. IDriverElement.h  

TAsyncResult< 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. IDriverElement.h  
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 IDriverElement.h  

TAsyncResult< 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 IDriverElement.h  

TAsyncResult< bool > ScrollToBeginningUntil ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& DesiredElementLocator
)

 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 IDriverElement.h  
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 IDriverElement.h  

TAsyncResult< 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 IDriverElement.h  

TAsyncResult< bool > ScrollToEndUntil ( const TSharedRef< IElementLocator, ESPMode::ThreadSafe >& DesiredElementLocator
)

 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 IDriverElement.h  

TAsyncResult< 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. IDriverElement.h  

TAsyncResult< bool > Type ( const TCHAR* Text
)

 Moves focus to the element, then triggers the series of events to invoke keyboard input for each character specified. IDriverElement.h  

TAsyncResult< bool > Type ( FString Text
)

 Moves focus to the element, then triggers the series of events to invoke keyboard input for each character specified. IDriverElement.h  

TAsyncResult< bool > Type ( FKey Key
)

 Moves focus to the element, then triggers the series of events to invoke keyboard input for the specified character. IDriverElement.h  

TAsyncResult< bool > Type ( TCHAR Character
)

 Moves focus to the element, then triggers the series of events to invoke keyboard input for the specified key. IDriverElement.h  

TAsyncResult< 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 IDriverElement.h  

TAsyncResult< 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 IDriverElement.h  

TAsyncResult< 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 IDriverElement.h  

TAsyncResult< 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 IDriverElement.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page