FormBrowserEx2.h File Reference

#include <Protocol/FormBrowserEx.h>

Go to the source code of this file.

Data Structures
struct	FORM_ENTRY_INFO
struct	QUESTION_ATTRIBUTE_OVERRIDE
struct	_EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL

Macros
#define	EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL_GUID    { 0xa770c357, 0xb693, 0x4e6d, { 0xa6, 0xcf, 0xd2, 0x1c, 0x72, 0x8e, 0x55, 0xb }}
#define	BROWSER_EXTENSION2_VERSION_1   0x10000
#define	BROWSER_EXTENSION2_VERSION_1_1   0x10001
#define	FORM_ENTRY_INFO_SIGNATURE   SIGNATURE_32 ('f', 'e', 'i', 's')
#define	FORM_ENTRY_INFO_FROM_LINK(a)   CR (a, FORM_ENTRY_INFO, Link, FORM_ENTRY_INFO_SIGNATURE)
#define	FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE   SIGNATURE_32 ('f', 'q', 'o', 's')
#define	FORM_QUESTION_ATTRIBUTE_OVERRIDE_FROM_LINK(a)   CR (a, QUESTION_ATTRIBUTE_OVERRIDE, Link, FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE)

Typedefs
typedef struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL	EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL
typedef BOOLEAN(EFIAPI *	IS_BROWSER_DATA_MODIFIED) (VOID)
typedef EFI_STATUS(EFIAPI *	EXECUTE_ACTION) (IN UINT32 Action, IN UINT16 DefaultId)
typedef BOOLEAN(EFIAPI *	IS_RESET_REQUIRED) (VOID)

Variables
EFI_GUID	gEdkiiFormBrowserEx2ProtocolGuid

Detailed Description

Extension Form Browser Protocol provides the services that can be used to register the different hot keys for the standard Browser actions described in UEFI specification.

Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file FormBrowserEx2.h.

Macro Definition Documentation

BROWSER_EXTENSION2_VERSION_1

#define BROWSER_EXTENSION2_VERSION_1   0x10000

Definition at line 20 of file FormBrowserEx2.h.

BROWSER_EXTENSION2_VERSION_1_1

#define BROWSER_EXTENSION2_VERSION_1_1   0x10001

Definition at line 21 of file FormBrowserEx2.h.

EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL_GUID

#define EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL_GUID    { 0xa770c357, 0xb693, 0x4e6d, { 0xa6, 0xcf, 0xd2, 0x1c, 0x72, 0x8e, 0x55, 0xb }}

Definition at line 15 of file FormBrowserEx2.h.

FORM_ENTRY_INFO_FROM_LINK

#define FORM_ENTRY_INFO_FROM_LINK

(

a

)

CR (a, FORM_ENTRY_INFO, Link, FORM_ENTRY_INFO_SIGNATURE)

Definition at line 77 of file FormBrowserEx2.h.

FORM_ENTRY_INFO_SIGNATURE

#define FORM_ENTRY_INFO_SIGNATURE   SIGNATURE_32 ('f', 'e', 'i', 's')

Definition at line 65 of file FormBrowserEx2.h.

FORM_QUESTION_ATTRIBUTE_OVERRIDE_FROM_LINK

#define FORM_QUESTION_ATTRIBUTE_OVERRIDE_FROM_LINK

(

a

)

CR (a, QUESTION_ATTRIBUTE_OVERRIDE, Link, FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE)

Definition at line 92 of file FormBrowserEx2.h.

FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE

#define FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE   SIGNATURE_32 ('f', 'q', 'o', 's')

Definition at line 79 of file FormBrowserEx2.h.

Typedef Documentation

EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL

typedef struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL

Definition at line 18 of file FormBrowserEx2.h.

EXECUTE_ACTION

typedef EFI_STATUS(EFIAPI * EXECUTE_ACTION) (IN UINT32 Action, IN UINT16 DefaultId)

Execute the action requested by the Action parameter.

Parameters

[in]	Action	Execute the request action.
[in]	DefaultId	The default Id info when need to load default value.

Return values

EFI_SUCCESS

Execute the request action succss.

Definition at line 46 of file FormBrowserEx2.h.

IS_BROWSER_DATA_MODIFIED

typedef BOOLEAN(EFIAPI * IS_BROWSER_DATA_MODIFIED) (VOID)

Check whether the browser data has been modified.

Return values

TRUE	Browser data is modified.
FALSE	No browser data is modified.

Definition at line 31 of file FormBrowserEx2.h.

IS_RESET_REQUIRED

typedef BOOLEAN(EFIAPI * IS_RESET_REQUIRED) (VOID)

Check whether required reset when exit the browser

Return values

TRUE	Browser required to reset after exit.
FALSE	Browser not need to reset after exit.

Definition at line 60 of file FormBrowserEx2.h.