]> git.proxmox.com Git - mirror_edk2.git/blame_incremental - ShellPkg/Library/UefiShellDebug1CommandsLib/EditTitleBar.h
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / EditTitleBar.h
... / ...
CommitLineData
1/** @file\r
2 Declares titlebar interface functions.\r
3\r
4 Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved. <BR>\r
5 SPDX-License-Identifier: BSD-2-Clause-Patent\r
6\r
7**/\r
8\r
9#ifndef _LIB_TITLE_BAR_H_\r
10#define _LIB_TITLE_BAR_H_\r
11\r
12/**\r
13 Initialize a title bar.\r
14\r
15 @param[in] Prompt The prompt to print in the title bar.\r
16\r
17 @retval EFI_SUCCESS The initialization was successful.\r
18 @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r
19**/\r
20EFI_STATUS\r
21MainTitleBarInit (\r
22 CONST CHAR16 *Prompt\r
23 );\r
24\r
25/**\r
26 Clean up the memory used.\r
27**/\r
28VOID\r
29MainTitleBarCleanup (\r
30 VOID\r
31 );\r
32\r
33typedef enum {\r
34 FileTypeNone,\r
35 FileTypeAscii,\r
36 FileTypeUnicode,\r
37 FileTypeDiskBuffer,\r
38 FileTypeMemBuffer,\r
39 FileTypeFileBuffer\r
40} EDIT_FILE_TYPE;\r
41\r
42/**\r
43 Refresh function for MainTitleBar\r
44\r
45 @param[in] FileName The open file's name (or NULL).\r
46 @param[in] FileType The type fo the file.\r
47 @param[in] ReadOnly TRUE if the file is read only. FALSE otherwise.\r
48 @param[in] Modified TRUE if the file was modified. FALSE otherwise.\r
49 @param[in] LastCol The last printable column.\r
50 @param[in] LastRow The last printable row.\r
51 @param[in] Offset The offset into the file. (only for mem/disk)\r
52 @param[in] Size The file's size. (only for mem/disk)\r
53\r
54 @retval EFI_SUCCESS The operation was successful.\r
55**/\r
56EFI_STATUS\r
57MainTitleBarRefresh (\r
58 IN CONST CHAR16 *FileName OPTIONAL,\r
59 IN CONST EDIT_FILE_TYPE FileType,\r
60 IN CONST BOOLEAN ReadOnly,\r
61 IN CONST BOOLEAN Modified,\r
62 IN CONST UINTN LastCol,\r
63 IN CONST UINTN LastRow,\r
64 IN CONST UINTN Offset,\r
65 IN CONST UINTN Size\r
66 );\r
67\r
68#endif\r