1 /** @file
2     Defines the Main Editor data type -
3      - Global variables
4      - Instances of the other objects of the editor
5      - Main Interfaces
6 
7   Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>
8   SPDX-License-Identifier: BSD-2-Clause-Patent
9 
10 **/
11 
12 #ifndef _LIB_EDITOR_H_
13 #define _LIB_EDITOR_H_
14 
15 #include "HexEditor.h"
16 
17 /**
18   Init function for MainEditor
19 
20   @retval EFI_SUCCESS             The operation was successful.
21   @retval EFI_LOAD_ERROR          A load error occured.
22 **/
23 EFI_STATUS
24 HMainEditorInit (
25   VOID
26   );
27 
28 /**
29   Cleanup function for MainEditor.
30 
31   @retval EFI_SUCCESS             The operation was successful.
32   @retval EFI_LOAD_ERROR          A load error occured.
33 **/
34 EFI_STATUS
35 HMainEditorCleanup (
36   VOID
37   );
38 
39 /**
40   Refresh function for MainEditor.
41 
42   @retval EFI_SUCCESS             The operation was successful.
43 **/
44 EFI_STATUS
45 HMainEditorRefresh (
46   VOID
47   );
48 
49 /**
50   Handle user key input. will route it to other components handle function.
51 
52   @retval EFI_SUCCESS             The operation was successful.
53   @retval EFI_OUT_OF_RESOURCES    A memory allocation occured.
54   @retval EFI_LOAD_ERROR          A load error occured.
55 **/
56 EFI_STATUS
57 HMainEditorKeyInput (
58   VOID
59   );
60 
61 /**
62   Backup function for MainEditor.
63 **/
64 VOID
65 HMainEditorBackup (
66   VOID
67   );
68 
69 #endif
70