]>
Commit | Line | Data |
---|---|---|
2442e62a | 1 | /** @file\r |
2 | Declares statusbar interface functions.\r | |
3 | \r | |
ba0014b9 | 4 | Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>\r |
56ba3746 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
2442e62a | 6 | \r |
7 | **/\r | |
8 | \r | |
9 | #ifndef _LIB_STATUS_BAR_H_\r | |
10 | #define _LIB_STATUS_BAR_H_\r | |
11 | \r | |
12 | /**\r | |
13 | Initialization function for Status Bar.\r | |
14 | \r | |
15 | @retval EFI_SUCCESS The operation was successful.\r | |
16 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r | |
17 | @sa StatusBarSetStatusString\r | |
18 | **/\r | |
19 | EFI_STATUS\r | |
2442e62a | 20 | StatusBarInit (\r |
21 | VOID\r | |
22 | );\r | |
23 | \r | |
24 | /**\r | |
25 | Cleanup function for the status bar.\r | |
26 | **/\r | |
27 | VOID\r | |
2442e62a | 28 | StatusBarCleanup (\r |
29 | VOID\r | |
30 | );\r | |
31 | \r | |
32 | /**\r | |
33 | Cause the status bar to refresh it's printing on the screen.\r | |
34 | \r | |
ba0014b9 | 35 | @param[in] EditorFirst TRUE to indicate the first launch of the editor.\r |
2442e62a | 36 | FALSE otherwise.\r |
37 | @param[in] LastRow LastPrintable row.\r | |
38 | @param[in] LastCol Last printable column.\r | |
39 | @param[in] FileRow Row in the file.\r | |
40 | @param[in] FileCol Column in the file.\r | |
41 | @param[in] InsertMode TRUE to indicate InsertMode. FALSE otherwise.\r | |
42 | \r | |
43 | @retval EFI_SUCCESS The operation was successful.\r | |
44 | **/\r | |
45 | EFI_STATUS\r | |
2442e62a | 46 | StatusBarRefresh (\r |
47 | IN BOOLEAN EditorFirst,\r | |
48 | IN UINTN LastRow,\r | |
49 | IN UINTN LastCol,\r | |
50 | IN UINTN FileRow,\r | |
51 | IN UINTN FileCol,\r | |
52 | IN BOOLEAN InsertMode\r | |
53 | );\r | |
54 | \r | |
55 | /**\r | |
56 | Set the status string text part.\r | |
57 | \r | |
58 | @param[in] Str The string to use.\r | |
59 | \r | |
60 | @retval EFI_SUCCESS The operation was successful.\r | |
61 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r | |
62 | **/\r | |
63 | EFI_STATUS\r | |
2442e62a | 64 | StatusBarSetStatusString (\r |
47d20b54 | 65 | IN CHAR16 *Str\r |
2442e62a | 66 | );\r |
67 | \r | |
68 | /**\r | |
69 | Function to retrieve the current status string.\r | |
70 | \r | |
71 | @return The string that is used.\r | |
72 | **/\r | |
47d20b54 | 73 | CONST CHAR16 *\r |
2442e62a | 74 | StatusBarGetString (\r |
75 | VOID\r | |
76 | );\r | |
77 | \r | |
78 | /**\r | |
79 | Function to set the need refresh boolean to TRUE.\r | |
80 | **/\r | |
81 | VOID\r | |
47d20b54 | 82 | StatusBarSetRefresh (\r |
2442e62a | 83 | VOID\r |
84 | );\r | |
85 | \r | |
86 | /**\r | |
87 | Function to get the need refresh boolean to TRUE.\r | |
88 | \r | |
89 | @retval TRUE The status bar needs to be refreshed.\r | |
90 | **/\r | |
91 | BOOLEAN\r | |
47d20b54 | 92 | StatusBarGetRefresh (\r |
2442e62a | 93 | VOID\r |
94 | );\r | |
95 | \r | |
96 | #endif\r |