blob: a6db2cdd7095d63cd446aa3581145e5a746fa7de (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
/** @file
Declares imputbar interface functions.
Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#ifndef _LIB_INPUT_BAR_H_
#define _LIB_INPUT_BAR_H_
/**
Initialize the input bar.
@param[in] TextInEx Pointer to SimpleTextInEx instance in System Table.
**/
VOID
InputBarInit (
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *TextInEx
);
/**
Cleanup function for input bar.
**/
VOID
InputBarCleanup (
VOID
);
/**
The refresh function for InputBar, it will wait for user input
@param[in] LastRow The last printable row.
@param[in] LastColumn The last printable column.
@retval EFI_SUCCESS The operation was successful.
**/
EFI_STATUS
InputBarRefresh (
UINTN LastRow,
UINTN LastColumn
);
/**
SetPrompt and wait for input.
@param[in] Str The prompt string.
@retval EFI_SUCCESS The operation was successful.
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.
**/
EFI_STATUS
InputBarSetPrompt (
IN CONST CHAR16 *Str
);
/**
Set the size of the string in characters.
@param[in] Size The max number of characters to accept.
@retval EFI_SUCCESS The operation was successful.
@retval EFI_OUT_OF_RESOURCES A memory allocation failed.
**/
EFI_STATUS
InputBarSetStringSize (
UINTN Size
);
/**
Function to retrieve the input from the user.
@retval NULL No input has been received.
@return The string that was input.
**/
CONST CHAR16*
InputBarGetString (
VOID
);
#endif
|
