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