1. Epic GamesDeveloper
  3. IAsyncDriverElement

IAsyncDriverElement

Copyright Epic Games, Inc. All Rights Reserved.

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 IAsyncDriverElement : public IElementLocator

Remarks

Represents the async API for a potential application element

Functions

  Type Name Description
Public function Const TAsyncResult< bool >  
Public function 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
Public function TAsyncResult< bool >

Click ()

 Moves the cursor over the element, then triggers the series of events to invoke a click with the left mouse button
Public function TAsyncResult< bool > Moves the cursor over the element, then triggers the series of events to invoke a double click with the specified mouse button
Public function TAsyncResult< bool > Moves the cursor over the element, then triggers the series of events to invoke a double click with the left mouse button
Public function Const TAsyncResult< bool >

Exists ()

  
Public function TAsyncResult< bool >

Focus ( uint32 UserIndex
)

 Moves focus to the element for the specified user
Public function TAsyncResult< bool >

Focus ()

 Moves focus to the element for the default user
Public function Const TAsyncResult< FVector2D >  
Public function Const TAsyncResult< FVector2D >

GetSize ()

  
Public function Const TAsyncResult< FText >

GetText ()

  
Public function Const TAsyncResult< bool >  
Public function Const TAsyncResult< bool >

HasFocusedDescendants ( uint32 UserIndex
)

  
Public function TAsyncResult< bool >

Hover ()

 Moves the cursor over the element, triggering any hover cue the element may have
Public function Const TAsyncResult< bool >  
Public function Const TAsyncResult< bool >  
Public function Const TAsyncResult< bool >

IsFocused ( uint32 UserIndex
)

  
Public function Const TAsyncResult< bool >  
Public function Const TAsyncResult< bool >  
Public function Const TAsyncResult< bool >  
Public function Const TAsyncResult< bool >  
Public function Const TAsyncResult< bool >  
Public function Const TAsyncResult< bool >  
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function TAsyncResult< bool > 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
Public function 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
Public function 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
Public function TAsyncResult< bool > 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
Public function 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
Public function 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
Public function 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.
Public function 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.
Public function TAsyncResult< bool >

Type ( FString Text
)

 Moves focus to the element, then triggers the series of events to invoke keyboard input for each character specified.
Public function TAsyncResult< bool >

Type ( FKey Key
)

 Moves focus to the element, then triggers the series of events to invoke keyboard input for the specified character.
Public function TAsyncResult< bool >

Type ( TCHAR Character
)

 Moves focus to the element, then triggers the series of events to invoke keyboard input for the specified key.
Public function 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
Public function 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
Public function 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
Public function 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page