]>
Commit | Line | Data |
---|---|---|
632820d1 | 1 | /** @file\r |
2 | Declares editor interface functions.\r | |
3 | \r | |
4 | Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved. <BR>\r | |
56ba3746 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
632820d1 | 6 | \r |
7 | **/\r | |
8 | \r | |
9 | #ifndef _LIB_EDITOR_H_\r | |
10 | #define _LIB_EDITOR_H_\r | |
11 | \r | |
12 | #include "TextEditorTypes.h"\r | |
13 | \r | |
14 | /**\r | |
15 | The initialization function for MainEditor.\r | |
16 | \r | |
17 | @retval EFI_SUCCESS The operation was successful.\r | |
a048af3c | 18 | @retval EFI_LOAD_ERROR A load error occurred.\r |
632820d1 | 19 | **/\r |
20 | EFI_STATUS\r | |
632820d1 | 21 | MainEditorInit (\r |
22 | VOID\r | |
23 | );\r | |
24 | \r | |
25 | /**\r | |
26 | The cleanup function for MainEditor.\r | |
27 | \r | |
28 | @retval EFI_SUCCESS The operation was successful.\r | |
a048af3c | 29 | @retval EFI_LOAD_ERROR A load error occurred.\r |
632820d1 | 30 | **/\r |
31 | EFI_STATUS\r | |
632820d1 | 32 | MainEditorCleanup (\r |
33 | VOID\r | |
34 | );\r | |
35 | \r | |
36 | /**\r | |
37 | Refresh the main editor component.\r | |
38 | **/\r | |
39 | VOID\r | |
632820d1 | 40 | MainEditorRefresh (\r |
41 | VOID\r | |
42 | );\r | |
43 | \r | |
44 | /**\r | |
45 | Handle user key input. This routes to other functions for the actions.\r | |
46 | \r | |
47 | @retval EFI_SUCCESS The operation was successful.\r | |
a048af3c | 48 | @retval EFI_LOAD_ERROR A load error occurred.\r |
632820d1 | 49 | @retval EFI_OUT_OF_RESOURCES A memory allocation failed.\r |
50 | **/\r | |
51 | EFI_STATUS\r | |
632820d1 | 52 | MainEditorKeyInput (\r |
53 | VOID\r | |
54 | );\r | |
55 | \r | |
56 | /**\r | |
57 | Backup function for MainEditor\r | |
58 | \r | |
59 | @retval EFI_SUCCESS The operation was successful.\r | |
60 | **/\r | |
61 | EFI_STATUS\r | |
632820d1 | 62 | MainEditorBackup (\r |
63 | VOID\r | |
64 | );\r | |
65 | \r | |
66 | #endif\r |