OpenTAP 9.25
API Reference
Static Public Member Functions | Properties | List of all members
OpenTap.UserInput Class Reference

Class for getting user input without using GUI. More...

Static Public Member Functions

static void Request (object dataObject, TimeSpan Timeout, bool modal=false)
 Request user input from the GUI. Waits an amount of time specified by Timeout. If the timeout occurs a TimeoutException will be thrown. More...
 
static void Request (object dataObject, bool modal=false)
 Request user input from the GUI. Waits indefinitely. More...
 
static void SetInterface (IUserInputInterface inputInterface)
 Sets the current user input interface. This should almost never be called from user code. More...
 
static void NotifyChanged (object obj, string property)
 Call to notify the user interface that an object property has changed. More...
 
static IUserInputInterface GetInterface ()
 Gets the current user input interface. More...
 

Properties

static object Interface [get]
 Currently selected interface.
 

Detailed Description

Class for getting user input without using GUI.

Member Function Documentation

◆ GetInterface()

static IUserInputInterface OpenTap.UserInput.GetInterface ( )
static

Gets the current user input interface.

Returns

◆ NotifyChanged()

static void OpenTap.UserInput.NotifyChanged ( object  obj,
string  property 
)
inlinestatic

Call to notify the user interface that an object property has changed.

Parameters
obj
property

◆ Request() [1/2]

static void OpenTap.UserInput.Request ( object  dataObject,
bool  modal = false 
)
inlinestatic

Request user input from the GUI. Waits indefinitely.

Parameters
dataObjectThe object the user should fill out with data.
modalset to True if a modal request is wanted. This means the user will have to answer before doing anything else.

◆ Request() [2/2]

static void OpenTap.UserInput.Request ( object  dataObject,
TimeSpan  Timeout,
bool  modal = false 
)
inlinestatic

Request user input from the GUI. Waits an amount of time specified by Timeout. If the timeout occurs a TimeoutException will be thrown.

Parameters
dataObjectThe object the user should fill out with data.
TimeoutHow long to wait before timing out.
modalset to True if a modal request is wanted. This means the user will have to answer before doing anything else.

◆ SetInterface()

static void OpenTap.UserInput.SetInterface ( IUserInputInterface  inputInterface)
inlinestatic

Sets the current user input interface. This should almost never be called from user code.

Parameters
inputInterface

OpenTAP 9.25 API built Tue Aug 6 2024 07:49:25