2 Extension Form Browser Protocol provides the services that can be used to
3 register the different hot keys for the standard Browser actions described in UEFI specification.
5 Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials are licensed and made available under
7 the terms and conditions of the BSD License that accompanies this distribution.
8 The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php.
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef __FORM_BROWSER_EXTENSION2_H__
17 #define __FORM_BROWSER_EXTENSION2_H__
19 #include <Protocol/FormBrowserEx.h>
21 #define EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL_GUID \
22 { 0xa770c357, 0xb693, 0x4e6d, { 0xa6, 0xcf, 0xd2, 0x1c, 0x72, 0x8e, 0x55, 0xb }}
24 typedef struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL
;
26 #define BROWSER_EXTENSION2_VERSION_1 0x10000
27 #define BROWSER_EXTENSION2_VERSION_1_1 0x10001
30 Check whether the browser data has been modified.
32 @retval TRUE Browser data is modified.
33 @retval FALSE No browser data is modified.
38 (EFIAPI
*IS_BROWSER_DATA_MODIFIED
) (
43 Execute the action requested by the Action parameter.
45 @param[in] Action Execute the request action.
46 @param[in] DefaultId The default Id info when need to load default value.
48 @retval EFI_SUCCESS Execute the request action succss.
53 (EFIAPI
*EXECUTE_ACTION
) (
59 Check whether required reset when exit the browser
61 @retval TRUE Browser required to reset after exit.
62 @retval FALSE Browser not need to reset after exit.
67 (EFIAPI
*IS_RESET_REQUIRED
) (
71 #define FORM_ENTRY_INFO_SIGNATURE SIGNATURE_32 ('f', 'e', 'i', 's')
77 EFI_HII_HANDLE HiiHandle
;
80 EFI_QUESTION_ID QuestionId
;
83 #define FORM_ENTRY_INFO_FROM_LINK(a) CR (a, FORM_ENTRY_INFO, Link, FORM_ENTRY_INFO_SIGNATURE)
85 #define FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE SIGNATURE_32 ('f', 'q', 'o', 's')
91 EFI_QUESTION_ID QuestionId
; // Find the question
92 EFI_FORM_ID FormId
; // Find the form
93 EFI_GUID FormSetGuid
; // Find the formset.
94 EFI_HII_HANDLE HiiHandle
; // Find the HII handle
95 UINT32 Attribute
; // Hide or grayout ...
96 } QUESTION_ATTRIBUTE_OVERRIDE
;
98 #define FORM_QUESTION_ATTRIBUTE_OVERRIDE_FROM_LINK(a) CR (a, QUESTION_ATTRIBUTE_OVERRIDE, Link, FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE)
100 struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL
{
102 /// Version for protocol future extension.
106 REGISTER_HOT_KEY RegisterHotKey
;
107 REGISTER_EXIT_HANDLER RegiserExitHandler
;
108 IS_BROWSER_DATA_MODIFIED IsBrowserDataModified
;
109 EXECUTE_ACTION ExecuteAction
;
111 /// A list of type FORMID_INFO is Browser View Form History List.
113 LIST_ENTRY FormViewHistoryHead
;
115 /// A list of type QUESTION_ATTRIBUTE_OVERRIDE.
117 LIST_ENTRY OverrideQestListHead
;
119 IS_RESET_REQUIRED IsResetRequired
;
122 extern EFI_GUID gEdkiiFormBrowserEx2ProtocolGuid
;