| 2442e62a |
1 | /** @file\r |
| 2 | Declares imputbar interface functions.\r |
| 3 | \r |
| 4 | Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved. <BR>\r |
| 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 |
| 20 | **/\r |
| 21 | VOID\r |
| 2442e62a |
22 | InputBarInit (\r |
| 23 | VOID\r |
| 24 | );\r |
| 25 | \r |
| 26 | /**\r |
| 27 | Cleanup function for input bar.\r |
| 28 | **/\r |
| 29 | VOID\r |
| 2442e62a |
30 | InputBarCleanup (\r |
| 31 | VOID\r |
| 32 | );\r |
| 33 | \r |
| 34 | /**\r |
| 35 | The refresh function for InputBar, it will wait for user input\r |
| 36 | \r |
| 37 | @param[in] LastRow The last printable row.\r |
| 38 | @param[in] LastColumn The last printable column.\r |
| 39 | \r |
| 40 | @retval EFI_SUCCESS The operation was successful.\r |
| 41 | **/\r |
| 42 | EFI_STATUS\r |
| 2442e62a |
43 | InputBarRefresh (\r |
| 44 | UINTN LastRow,\r |
| 45 | UINTN LastColumn\r |
| 46 | );\r |
| 47 | \r |
| 48 | /**\r |
| 49 | SetPrompt and wait for input.\r |
| 50 | \r |
| 51 | @param[in] Str The prompt string.\r |
| 52 | \r |
| 53 | @retval EFI_SUCCESS The operation was successful.\r |
| 54 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r |
| 55 | **/\r |
| 56 | EFI_STATUS\r |
| 2442e62a |
57 | InputBarSetPrompt (\r |
| 58 | IN CONST CHAR16 *Str\r |
| 59 | );\r |
| 60 | \r |
| 61 | /**\r |
| 62 | Set the size of the string in characters.\r |
| 63 | \r |
| 64 | @param[in] Size The max number of characters to accept.\r |
| 65 | \r |
| 66 | @retval EFI_SUCCESS The operation was successful.\r |
| 67 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r |
| 68 | **/\r |
| 69 | EFI_STATUS\r |
| 2442e62a |
70 | InputBarSetStringSize (\r |
| 71 | UINTN Size\r |
| 72 | );\r |
| 73 | \r |
| 74 | /**\r |
| 75 | Function to retrieve the input from the user.\r |
| 76 | \r |
| 77 | @retval NULL No input has been received.\r |
| 78 | @return The string that was input.\r |
| 79 | **/\r |
| 80 | CONST CHAR16*\r |
| 2442e62a |
81 | InputBarGetString (\r |
| 82 | VOID\r |
| 83 | );\r |
| 84 | \r |
| 85 | #endif\r |
projects / mirror_edk2.git / blame