]>
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 |
2442e62a | 5 | This program and the accompanying materials\r |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _LIB_INPUT_BAR_H_\r | |
16 | #define _LIB_INPUT_BAR_H_\r | |
17 | \r | |
18 | /**\r | |
19 | Initialize the input bar.\r | |
5563281f RN |
20 | \r |
21 | @param[in] TextInEx Pointer to SimpleTextInEx instance in System Table.\r | |
2442e62a | 22 | **/\r |
23 | VOID\r | |
2442e62a | 24 | InputBarInit (\r |
5563281f | 25 | IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *TextInEx\r |
2442e62a | 26 | );\r |
27 | \r | |
28 | /**\r | |
29 | Cleanup function for input bar.\r | |
30 | **/\r | |
31 | VOID\r | |
2442e62a | 32 | InputBarCleanup (\r |
33 | VOID\r | |
34 | );\r | |
35 | \r | |
36 | /**\r | |
37 | The refresh function for InputBar, it will wait for user input\r | |
38 | \r | |
39 | @param[in] LastRow The last printable row.\r | |
40 | @param[in] LastColumn The last printable column.\r | |
41 | \r | |
42 | @retval EFI_SUCCESS The operation was successful.\r | |
43 | **/\r | |
44 | EFI_STATUS\r | |
2442e62a | 45 | InputBarRefresh (\r |
46 | UINTN LastRow,\r | |
47 | UINTN LastColumn\r | |
48 | );\r | |
49 | \r | |
50 | /**\r | |
51 | SetPrompt and wait for input.\r | |
52 | \r | |
53 | @param[in] Str The prompt string.\r | |
54 | \r | |
55 | @retval EFI_SUCCESS The operation was successful.\r | |
56 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r | |
57 | **/\r | |
58 | EFI_STATUS\r | |
2442e62a | 59 | InputBarSetPrompt (\r |
60 | IN CONST CHAR16 *Str\r | |
61 | );\r | |
62 | \r | |
63 | /**\r | |
64 | Set the size of the string in characters.\r | |
65 | \r | |
66 | @param[in] Size The max number of characters to accept.\r | |
67 | \r | |
68 | @retval EFI_SUCCESS The operation was successful.\r | |
69 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r | |
70 | **/\r | |
71 | EFI_STATUS\r | |
2442e62a | 72 | InputBarSetStringSize (\r |
73 | UINTN Size\r | |
74 | );\r | |
75 | \r | |
76 | /**\r | |
77 | Function to retrieve the input from the user.\r | |
78 | \r | |
79 | @retval NULL No input has been received.\r | |
80 | @return The string that was input.\r | |
81 | **/\r | |
82 | CONST CHAR16*\r | |
2442e62a | 83 | InputBarGetString (\r |
84 | VOID\r | |
85 | );\r | |
86 | \r | |
87 | #endif\r |