1 /** @file
2   Declares editor interface functions.
3 
4   Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved. <BR>
5   This program and the accompanying materials
6   are licensed and made available under the terms and conditions of the BSD License
7   which accompanies this distribution.  The full text of the license may be found at
8   http://opensource.org/licenses/bsd-license.php
9 
10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12 
13 **/
14 
15 #ifndef _LIB_EDITOR_H_
16 #define _LIB_EDITOR_H_
17 
18 #include "TextEditorTypes.h"
19 
20 /**
21   The initialization function for MainEditor.
22 
23   @retval EFI_SUCCESS             The operation was successful.
24   @retval EFI_LOAD_ERROR          A load error occured.
25 **/
26 EFI_STATUS
27 EFIAPI
28 MainEditorInit (
29   VOID
30   );
31 
32 /**
33   The cleanup function for MainEditor.
34 
35   @retval EFI_SUCCESS             The operation was successful.
36   @retval EFI_LOAD_ERROR          A load error occured.
37 **/
38 EFI_STATUS
39 EFIAPI
40 MainEditorCleanup (
41   VOID
42   );
43 
44 /**
45   Refresh the main editor component.
46 **/
47 VOID
48 EFIAPI
49 MainEditorRefresh (
50   VOID
51   );
52 
53 /**
54   Handle user key input. This routes to other functions for the actions.
55 
56   @retval EFI_SUCCESS             The operation was successful.
57   @retval EFI_LOAD_ERROR          A load error occured.
58   @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.
59 **/
60 EFI_STATUS
61 EFIAPI
62 MainEditorKeyInput (
63   VOID
64   );
65 
66 /**
67   Backup function for MainEditor
68 
69   @retval EFI_SUCCESS The operation was successful.
70 **/
71 EFI_STATUS
72 EFIAPI
73 MainEditorBackup (
74   VOID
75   );
76 
77 #endif
78