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