1 /** @file 2 Declares statusbar 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_STATUS_BAR_H_ 16 #define _LIB_STATUS_BAR_H_ 17 18 /** 19 Initialization function for Status Bar. 20 21 @retval EFI_SUCCESS The operation was successful. 22 @retval EFI_OUT_OF_RESOURCES A memory allocation failed. 23 @sa StatusBarSetStatusString 24 **/ 25 EFI_STATUS 26 EFIAPI 27 StatusBarInit ( 28 VOID 29 ); 30 31 /** 32 Cleanup function for the status bar. 33 **/ 34 VOID 35 EFIAPI 36 StatusBarCleanup ( 37 VOID 38 ); 39 40 /** 41 Cause the status bar to refresh it's printing on the screen. 42 43 @param[in] EditorFirst TRUE to indicate the first launch of the editor. 44 FALSE otherwise. 45 @param[in] LastRow LastPrintable row. 46 @param[in] LastCol Last printable column. 47 @param[in] FileRow Row in the file. 48 @param[in] FileCol Column in the file. 49 @param[in] InsertMode TRUE to indicate InsertMode. FALSE otherwise. 50 51 @retval EFI_SUCCESS The operation was successful. 52 **/ 53 EFI_STATUS 54 EFIAPI 55 StatusBarRefresh ( 56 IN BOOLEAN EditorFirst, 57 IN UINTN LastRow, 58 IN UINTN LastCol, 59 IN UINTN FileRow, 60 IN UINTN FileCol, 61 IN BOOLEAN InsertMode 62 ); 63 64 /** 65 Set the status string text part. 66 67 @param[in] Str The string to use. 68 69 @retval EFI_SUCCESS The operation was successful. 70 @retval EFI_OUT_OF_RESOURCES A memory allocation failed. 71 **/ 72 EFI_STATUS 73 EFIAPI 74 StatusBarSetStatusString ( 75 IN CHAR16 *Str 76 ); 77 78 /** 79 Function to retrieve the current status string. 80 81 @return The string that is used. 82 **/ 83 CONST CHAR16* 84 EFIAPI 85 StatusBarGetString ( 86 VOID 87 ); 88 89 /** 90 Function to set the need refresh boolean to TRUE. 91 **/ 92 VOID 93 EFIAPI 94 StatusBarSetRefresh( 95 VOID 96 ); 97 98 /** 99 Function to get the need refresh boolean to TRUE. 100 101 @retval TRUE The status bar needs to be refreshed. 102 **/ 103 BOOLEAN 104 EFIAPI 105 StatusBarGetRefresh( 106 VOID 107 ); 108 109 #endif 110
