FrontPageCustomizedUi.h File Reference

Go to the source code of this file.

Functions
VOID	UiCustomizeFrontPageBanner (IN UINTN LineIndex, IN BOOLEAN LeftOrRight, IN OUT EFI_STRING *BannerStr)
VOID	UiCustomizeFrontPage (IN EFI_HII_HANDLE HiiHandle, IN VOID *StartOpCodeHandle)
EFI_STATUS	UiFrontPageCallbackHandler (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)

Detailed Description

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

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

Definition in file FrontPageCustomizedUi.h.

Function Documentation

UiCustomizeFrontPage()

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

Customize menus in the page.

Parameters

[in]	HiiHandle	The HII Handle of the form to update.
[in]	StartOpCodeHandle	The context used to insert opcode.

Customize menus in the page.

Parameters

[in]	HiiHandle	The HII Handle of the form to update.
[in]	StartOpCodeHandle	The context used to insert opcode.
[in]	CustomizePageType	The page type need to be customized.

Definition at line 27 of file FrontPageCustomizedUi.c.

UiCustomizeFrontPageBanner()

VOID UiCustomizeFrontPageBanner	(	IN UINTN	LineIndex,
		IN BOOLEAN	LeftOrRight,
		IN OUT EFI_STRING *	BannerStr
	)

Update the banner string in the front page.

Current layout for the banner string like below: PS: Totally only 5 lines of banner supported.

Line 1: Left BannerStr RightBannerStr Line 2: Left BannerStr RightBannerStr Line 3: Left BannerStr RightBannerStr Line 4: Left BannerStr RightBannerStr Line 5: Left BannerStr RightBannerStr <EmptyLine> First menu in front page. ...

Parameters

LineIndex	The line index of the banner need to check.
LeftOrRight	The left or right banner need to check.
BannerStr	Banner string need to update. Input the current string and user can update it and return the new string.

Definition at line 123 of file FrontPageCustomizedUi.c.

UiFrontPageCallbackHandler()

EFI_STATUS UiFrontPageCallbackHandler	(	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
	)

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.

Return values

EFI_SUCCESS	The callback successfully handled the action.
EFI_OUT_OF_RESOURCES	Not enough storage is available to hold the variable and its data.
EFI_DEVICE_ERROR	The variable could not be saved.
EFI_UNSUPPORTED	The specified Action is not supported by the callback.

Definition at line 82 of file FrontPageCustomizedUi.c.