Commit | Line | Data |
---|---|---|
b9feb4bd ED |
1 | /** @file\r |
2 | Extension Form Browser Protocol provides the services that can be used to \r | |
3 | register the different hot keys for the standard Browser actions described in UEFI specification.\r | |
4 | \r | |
5 | Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>\r | |
6 | This program and the accompanying materials are licensed and made available under \r | |
7 | the terms and conditions of the BSD License that accompanies this distribution. \r | |
8 | The full text of the license may be found at\r | |
9 | http://opensource.org/licenses/bsd-license.php. \r | |
10 | \r | |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
14 | **/\r | |
15 | \r | |
16 | #ifndef __FORM_BROWSER_EXTENSION2_H__\r | |
17 | #define __FORM_BROWSER_EXTENSION2_H__\r | |
18 | \r | |
9b141c52 | 19 | #include <Protocol/FormBrowserEx.h>\r |
b9feb4bd ED |
20 | \r |
21 | #define EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL_GUID \\r | |
22 | { 0xa770c357, 0xb693, 0x4e6d, { 0xa6, 0xcf, 0xd2, 0x1c, 0x72, 0x8e, 0x55, 0xb }}\r | |
23 | \r | |
24 | typedef struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL;\r | |
25 | \r | |
26 | #define BROWSER_EXTENSION2_VERSION_1 0x10000\r | |
27 | \r | |
28 | /**\r | |
29 | Check whether the browser data has been modified.\r | |
30 | \r | |
31 | @retval TRUE Browser data is modified.\r | |
32 | @retval FALSE No browser data is modified.\r | |
33 | \r | |
34 | **/\r | |
35 | typedef\r | |
36 | BOOLEAN\r | |
37 | (EFIAPI *IS_BROWSER_DATA_MODIFIED) (\r | |
38 | VOID\r | |
39 | );\r | |
40 | \r | |
41 | /**\r | |
42 | Execute the action requested by the Action parameter.\r | |
43 | \r | |
44 | @param[in] Action Execute the request action.\r | |
45 | @param[in] DefaultId The default Id info when need to load default value.\r | |
46 | \r | |
47 | @retval EFI_SUCCESS Execute the request action succss.\r | |
48 | \r | |
49 | **/\r | |
50 | typedef \r | |
51 | EFI_STATUS \r | |
52 | (EFIAPI *EXECUTE_ACTION) (\r | |
53 | IN UINT32 Action,\r | |
54 | IN UINT16 DefaultId\r | |
55 | );\r | |
56 | \r | |
57 | #define FORM_ENTRY_INFO_SIGNATURE SIGNATURE_32 ('f', 'e', 'i', 's')\r | |
58 | \r | |
59 | typedef struct {\r | |
60 | UINTN Signature;\r | |
61 | LIST_ENTRY Link;\r | |
62 | \r | |
63 | EFI_HII_HANDLE HiiHandle;\r | |
64 | EFI_GUID FormSetGuid;\r | |
65 | EFI_FORM_ID FormId;\r | |
66 | EFI_QUESTION_ID QuestionId;\r | |
67 | } FORM_ENTRY_INFO;\r | |
68 | \r | |
69 | #define FORM_ENTRY_INFO_FROM_LINK(a) CR (a, FORM_ENTRY_INFO, Link, FORM_ENTRY_INFO_SIGNATURE)\r | |
70 | \r | |
71 | struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL {\r | |
72 | ///\r | |
73 | /// Version for protocol future extension.\r | |
74 | ///\r | |
75 | UINT32 Version;\r | |
76 | SET_SCOPE SetScope;\r | |
77 | REGISTER_HOT_KEY RegisterHotKey;\r | |
78 | REGISTER_EXIT_HANDLER RegiserExitHandler;\r | |
79 | IS_BROWSER_DATA_MODIFIED IsBrowserDataModified;\r | |
80 | EXECUTE_ACTION ExecuteAction;\r | |
81 | ///\r | |
82 | /// A list of type FORMID_INFO is Browser View Form History List.\r | |
83 | ///\r | |
84 | LIST_ENTRY FormViewHistoryHead;\r | |
85 | };\r | |
86 | \r | |
87 | extern EFI_GUID gEdkiiFormBrowserEx2ProtocolGuid;\r | |
88 | \r | |
89 | #endif\r | |
90 | \r |