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