1. Epic GamesDeveloper
  3. IDriverElement

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

Remarks

Represents the API for a potential application element

Functions

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

Exists ()

  
Public function bool

Focus ( uint32 UserIndex
)

 Moves focus to the element for the specified user
Public function bool

Focus ()

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

GetSize ()

  
Public function Const FText

GetText ()

  
Public function Const bool  
Public function Const bool

HasFocusedDescendants ( uint32 UserIndex
)

  
Public function bool

Hover ()

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

IsFocused ( uint32 UserIndex
)

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