]>
git.proxmox.com Git - mirror_edk2.git/blob - ShellPkg/Library/UefiShellDebug1CommandsLib/EditStatusBar.h
2 Declares statusbar interface functions.
4 Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
9 #ifndef _LIB_STATUS_BAR_H_
10 #define _LIB_STATUS_BAR_H_
13 Initialization function for Status Bar.
15 @retval EFI_SUCCESS The operation was successful.
16 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
17 @sa StatusBarSetStatusString
25 Cleanup function for the status bar.
33 Cause the status bar to refresh it's printing on the screen.
35 @param[in] EditorFirst TRUE to indicate the first launch of the editor.
37 @param[in] LastRow LastPrintable row.
38 @param[in] LastCol Last printable column.
39 @param[in] FileRow Row in the file.
40 @param[in] FileCol Column in the file.
41 @param[in] InsertMode TRUE to indicate InsertMode. FALSE otherwise.
43 @retval EFI_SUCCESS The operation was successful.
47 IN BOOLEAN EditorFirst
,
56 Set the status string text part.
58 @param[in] Str The string to use.
60 @retval EFI_SUCCESS The operation was successful.
61 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
64 StatusBarSetStatusString (
69 Function to retrieve the current status string.
71 @return The string that is used.
79 Function to set the need refresh boolean to TRUE.
87 Function to get the need refresh boolean to TRUE.
89 @retval TRUE The status bar needs to be refreshed.