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