FrontPageCustomizedUiSupport.h File Reference

Go to the source code of this file.

Typedefs
typedef BOOLEAN(EFIAPI *	DRIVER_SPECIAL_HANDLER) (IN CHAR16 *DriverName, OUT CHAR16 **NewName, OUT BOOLEAN *EmptyLineAfter)

Functions
VOID	UiCreateContinueMenu (IN EFI_HII_HANDLE HiiHandle, IN VOID *StartOpCodeHandle)
VOID	UiCreateEmptyLine (IN EFI_HII_HANDLE HiiHandle, IN VOID *StartOpCodeHandle)
VOID	UiCreateLanguageMenu (IN EFI_HII_HANDLE HiiHandle, IN VOID *StartOpCodeHandle)
VOID	UiCreateResetMenu (IN EFI_HII_HANDLE HiiHandle, IN VOID *StartOpCodeHandle)
EFI_STATUS	UiListThirdPartyDrivers (IN EFI_HII_HANDLE HiiHandle, IN EFI_GUID *ClassGuid, IN DRIVER_SPECIAL_HANDLER SpecialHandlerFn, IN VOID *StartOpCodeHandle)
BOOLEAN	UiSupportLibCallbackHandler (IN EFI_HII_HANDLE HiiHandle, IN EFI_BROWSER_ACTION Action, IN EFI_QUESTION_ID QuestionId, IN UINT8 Type, IN EFI_IFR_TYPE_VALUE *Value, OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest, OUT EFI_STATUS *Status)

Detailed Description

This library class defines a set of interfaces to be used by customize Ui module

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

Definition in file FrontPageCustomizedUiSupport.h.

Typedef Documentation

DRIVER_SPECIAL_HANDLER

typedef BOOLEAN(EFIAPI * DRIVER_SPECIAL_HANDLER) (IN CHAR16 *DriverName, OUT CHAR16 **NewName, OUT BOOLEAN *EmptyLineAfter)

Rename the driver name if necessary.

Parameters

DriverName	Input the driver name.
NewDriverName	Return the new driver name.
EmptyLineAfter	Whether need to insert empty line.

Return values

New	driver name if compared, else NULL.

Definition at line 75 of file FrontPageCustomizedUiSupport.h.

Function Documentation

UiCreateContinueMenu()

VOID UiCreateContinueMenu	(	IN EFI_HII_HANDLE	HiiHandle,
		IN VOID *	StartOpCodeHandle
	)

Create continue menu in the front page.

Parameters

[in]	HiiHandle	The hii handle for the Uiapp driver.
[in]	StartOpCodeHandle	The opcode handle to save the new opcode.

Definition at line 405 of file FrontPageCustomizedUiSupport.c.

UiCreateEmptyLine()

VOID UiCreateEmptyLine	(	IN EFI_HII_HANDLE	HiiHandle,
		IN VOID *	StartOpCodeHandle
	)

Create empty line menu.

Parameters

HiiHandle	The hii handle for the Uiapp driver.
StartOpCodeHandle	The opcode handle to save the new opcode.

Create empty line menu in the front page.

Parameters

HiiHandle	The hii handle for the Uiapp driver.
StartOpCodeHandle	The opcode handle to save the new opcode.

Definition at line 428 of file FrontPageCustomizedUiSupport.c.

UiCreateLanguageMenu()

VOID UiCreateLanguageMenu	(	IN EFI_HII_HANDLE	HiiHandle,
		IN VOID *	StartOpCodeHandle
	)

Create Select language menu in the front page with oneof opcode.

Parameters

[in]	HiiHandle	The hii handle for the Uiapp driver.
[in]	StartOpCodeHandle	The opcode handle to save the new opcode.

Definition at line 253 of file FrontPageCustomizedUiSupport.c.

UiCreateResetMenu()

VOID UiCreateResetMenu	(	IN EFI_HII_HANDLE	HiiHandle,
		IN VOID *	StartOpCodeHandle
	)

Create Reset menu.

Parameters

[in]	HiiHandle	The hii handle for the Uiapp driver.
[in]	StartOpCodeHandle	The opcode handle to save the new opcode.

Create Reset menu in the front page.

Parameters

[in]	HiiHandle	The hii handle for the Uiapp driver.
[in]	StartOpCodeHandle	The opcode handle to save the new opcode.

Definition at line 444 of file FrontPageCustomizedUiSupport.c.

UiListThirdPartyDrivers()

EFI_STATUS UiListThirdPartyDrivers	(	IN EFI_HII_HANDLE	HiiHandle,
		IN EFI_GUID *	ClassGuid,
		IN DRIVER_SPECIAL_HANDLER	SpecialHandlerFn,
		IN VOID *	StartOpCodeHandle
	)

Search the drivers in the system which need to show in the front page and insert the menu to the front page.

Parameters

HiiHandle	The hii handle for the Uiapp driver.
ClassGuid	The class guid for the driver which is the target.
SpecialHandlerFn	The pointer to the special handler function, if any.
StartOpCodeHandle	The opcode handle to save the new opcode.

Return values

EFI_SUCCESS

Search the driver success

Definition at line 569 of file FrontPageCustomizedUiSupport.c.

UiSupportLibCallbackHandler()

BOOLEAN UiSupportLibCallbackHandler	(	IN EFI_HII_HANDLE	HiiHandle,
		IN EFI_BROWSER_ACTION	Action,
		IN EFI_QUESTION_ID	QuestionId,
		IN UINT8	Type,
		IN EFI_IFR_TYPE_VALUE *	Value,
		OUT EFI_BROWSER_ACTION_REQUEST *	ActionRequest,
		OUT EFI_STATUS *	Status
	)

This function processes the results of changes in configuration.

Parameters

HiiHandle	Points to the hii handle for this formset.
Action	Specifies the type of action taken by the browser.
QuestionId	A unique value which is sent to the original exporting driver so that it can identify the type of data to expect.
Type	The type of value for the question.
Value	A pointer to the data being sent to the original exporting driver.
ActionRequest	On return, points to the action requested by the callback function.
Status	Return the handle status.

Return values

TRUE	The callback successfully handled the action.
FALSE	The callback not supported in this handler.

Definition at line 175 of file FrontPageCustomizedUiSupport.c.