• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 - 2011, Intel Corporation. All rights reserved. <BR>
8   This program and the accompanying materials
9   are licensed and made available under the terms and conditions of the BSD License
10   which accompanies this distribution.  The full text of the license may be found at
11   http://opensource.org/licenses/bsd-license.php
12 
13   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 
16 **/
17 
18 #ifndef _LIB_EDITOR_H_
19 #define _LIB_EDITOR_H_
20 
21 #include "HexEditor.h"
22 
23 /**
24   Init function for MainEditor
25 
26   @retval EFI_SUCCESS             The operation was successful.
27   @retval EFI_LOAD_ERROR          A load error occured.
28 **/
29 EFI_STATUS
30 HMainEditorInit (
31   VOID
32   );
33 
34 /**
35   Cleanup function for MainEditor.
36 
37   @retval EFI_SUCCESS             The operation was successful.
38   @retval EFI_LOAD_ERROR          A load error occured.
39 **/
40 EFI_STATUS
41 HMainEditorCleanup (
42   VOID
43   );
44 
45 /**
46   Refresh function for MainEditor.
47 
48   @retval EFI_SUCCESS             The operation was successful.
49 **/
50 EFI_STATUS
51 HMainEditorRefresh (
52   VOID
53   );
54 
55 /**
56   Handle user key input. will route it to other components handle function.
57 
58   @retval EFI_SUCCESS             The operation was successful.
59   @retval EFI_OUT_OF_RESOURCES    A memory allocation occured.
60   @retval EFI_LOAD_ERROR          A load error occured.
61 **/
62 EFI_STATUS
63 HMainEditorKeyInput (
64   VOID
65   );
66 
67 /**
68   Backup function for MainEditor.
69 **/
70 VOID
71 HMainEditorBackup (
72   VOID
73   );
74 
75 #endif
76