CustomizedDisplayLib.h File Reference

Functions
EFI_STATUS EFIAPI	DisplayPageFrame (IN FORM_DISPLAY_ENGINE_FORM *FormData, OUT EFI_SCREEN_DESCRIPTOR *ScreenForStatement)
VOID EFIAPI	ClearDisplayPage (VOID)
VOID EFIAPI	RefreshKeyHelp (IN FORM_DISPLAY_ENGINE_FORM *FormData, IN FORM_DISPLAY_ENGINE_STATEMENT *Statement, IN BOOLEAN Selected)
VOID EFIAPI	UpdateStatusBar (IN UINTN MessageType, IN BOOLEAN State)
VOID EFIAPI	CreateDialog (OUT EFI_INPUT_KEY *Key,...)
UINTN EFIAPI	ConfirmDataChange (VOID)
BOOLEAN EFIAPI	FormExitPolicy (VOID)
UINT64 EFIAPI	FormExitTimeout (IN FORM_DISPLAY_ENGINE_FORM *FormData)
UINTN EFIAPI	PrintStringAt (IN UINTN Column, IN UINTN Row, IN CHAR16 *String)
UINTN EFIAPI	PrintStringAtWithWidth (IN UINTN Column, IN UINTN Row, IN CHAR16 *String, IN UINTN Width)
UINTN EFIAPI	PrintCharAt (IN UINTN Column, IN UINTN Row, CHAR16 Character)
VOID EFIAPI	ClearLines (IN UINTN LeftColumn, IN UINTN RightColumn, IN UINTN TopRow, IN UINTN BottomRow, IN UINTN TextAttribute)
UINT8 EFIAPI	GetPopupColor (VOID)
UINT8 EFIAPI	GetPopupInverseColor (VOID)
UINT8 EFIAPI	GetPickListColor (VOID)
UINT8 EFIAPI	GetArrowColor (VOID)
UINT8 EFIAPI	GetInfoTextColor (VOID)
UINT8 EFIAPI	GetHelpTextColor (VOID)
UINT8 EFIAPI	GetGrayedTextColor (VOID)
UINT8 EFIAPI	GetHighlightTextColor (VOID)
UINT8 EFIAPI	GetFieldTextColor (VOID)
UINT8 EFIAPI	GetSubTitleTextColor (VOID)

Detailed Description

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

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

Function Documentation

VOID EFIAPI ClearDisplayPage

(

VOID

)

Clear Screen to the initial state.

VOID EFIAPI ClearLines	(	IN UINTN	LeftColumn,
		IN UINTN	RightColumn,
		IN UINTN	TopRow,
		IN UINTN	BottomRow,
		IN UINTN	TextAttribute
	)

Clear retangle with specified text attribute.

Parameters

LeftColumn	Left column of retangle.
RightColumn	Right column of retangle.
TopRow	Start row of retangle.
BottomRow	End row of retangle.
TextAttribute	The character foreground and background.

UINTN EFIAPI ConfirmDataChange

(

VOID

)

Confirm how to handle the changed data.

Returns

Action BROWSER_ACTION_SUBMIT, BROWSER_ACTION_DISCARD or other values.

VOID EFIAPI CreateDialog	(	OUT EFI_INPUT_KEY *	Key,
			...
	)

Create popup window.

This function draws OEM/Vendor specific pop up windows.

Parameters

[out]	Key	User Input Key
	...	String to be shown in Popup. The variable argument list is terminated by a NULL.

EFI_STATUS EFIAPI DisplayPageFrame	(	IN FORM_DISPLAY_ENGINE_FORM *	FormData,
		OUT EFI_SCREEN_DESCRIPTOR *	ScreenForStatement
	)

+------------------------------------------------------------------------——+ | Setup Page | +------------------------------------------------------------------------——+

Statement Statement Statement

+------------------------------------------------------------------------——+ | F9=Reset to Defaults F10=Save | | ^"=Move Highlight <Spacebar> Toggles Checkbox Esc=Exit | +------------------------------------------------------------------------——+ StatusBar This funtion defines Page Frame and Backgroud.

Based on the above layout, it will be responsible for HeaderHeight, FooterHeight, StatusBarHeight and Backgroud. And, it will reserve Screen for Statement.

Parameters

[in]	FormData	Form Data to be shown in Page.
[out]	ScreenForStatement	Screen to be used for Statement. (Prompt, Value and Help)

Returns

Status

BOOLEAN EFIAPI FormExitPolicy

(

VOID

)

OEM specifies whether Setup exits Page by ESC key.

This function customized the behavior that whether Setup exits Page so that system able to boot when configuration is not changed.

Return values

TRUE	Exits FrontPage
FALSE	Don't exit FrontPage.

UINT64 EFIAPI FormExitTimeout

(

IN FORM_DISPLAY_ENGINE_FORM *

FormData

)

Set Timeout value for a ceratain Form to get user response.

This function allows to set timeout value on a ceratain form if necessary. If timeout is not zero, the form will exit if user has no response in timeout.

Parameters

[in]

FormData

Form Data to be shown in Page

Returns

0 No timeout for this form.

> 0 Timeout value in 100 ns units.

UINT8 EFIAPI GetArrowColor

(

VOID

)

Get OEM/Vendor specific arrow color attribute.

Return values

Byte	code color setting for arrow color.

UINT8 EFIAPI GetFieldTextColor

(

VOID

)

Get OEM/Vendor specific field text color attribute.

Return values

Byte	code color setting for field text color.

UINT8 EFIAPI GetGrayedTextColor

(

VOID

)

Get OEM/Vendor specific grayed out text color attribute.

Return values

Byte	code color setting for grayed out text color.

UINT8 EFIAPI GetHelpTextColor

(

VOID

)

Get OEM/Vendor specific help text color attribute.

Return values

Byte	code color setting for help text color.

UINT8 EFIAPI GetHighlightTextColor

(

VOID

)

Get OEM/Vendor specific highlighted text color attribute.

Return values

Byte	code color setting for highlight text color.

UINT8 EFIAPI GetInfoTextColor

(

VOID

)

Get OEM/Vendor specific info text color attribute.

Return values

Byte	code color setting for info text color.

UINT8 EFIAPI GetPickListColor

(

VOID

)

Get OEM/Vendor specific PickList color attribute.

Return values

Byte	code color setting for pick list color.

UINT8 EFIAPI GetPopupColor

(

VOID

)

Get OEM/Vendor specific popup attribute colors.

Return values

Byte	code color setting for popup color.

UINT8 EFIAPI GetPopupInverseColor

(

VOID

)

Get OEM/Vendor specific popup attribute colors.

Return values

Byte	code color setting for popup inverse color.

UINT8 EFIAPI GetSubTitleTextColor

(

VOID

)

Get OEM/Vendor specific subtitle text color attribute.

Return values

Byte	code color setting for subtitle text color.

UINTN EFIAPI PrintCharAt	(	IN UINTN	Column,
		IN UINTN	Row,
		CHAR16	Character
	)

Prints a character to the default console, at the supplied cursor position, using L"%c" format.

Parameters

Column	The cursor position to print the string at. When it is -1, use current Position.
Row	The cursor position to print the string at. When it is -1, use current Position.
Character	Character to print.

Returns

Length of string printed to the console.

UINTN EFIAPI PrintStringAt	(	IN UINTN	Column,
		IN UINTN	Row,
		IN CHAR16 *	String
	)

Prints a unicode string to the default console, at the supplied cursor position, using L"%s" format.

Parameters

Column	The cursor position to print the string at. When it is -1, use current Position.
Row	The cursor position to print the string at. When it is -1, use current Position.
String	String pointer.

Returns

Length of string printed to the console

UINTN EFIAPI PrintStringAtWithWidth	(	IN UINTN	Column,
		IN UINTN	Row,
		IN CHAR16 *	String,
		IN UINTN	Width
	)

Prints a unicode string with the specified width to the default console, at the supplied cursor position, using L"%s" format.

Parameters

Column	The cursor position to print the string at. When it is -1, use current Position.
Row	The cursor position to print the string at. When it is -1, use current Position.
String	String pointer.
Width	Width for String to be printed. If the print length of String < Width, Space char (L' ') will be used to append String.

Returns

Length of string printed to the console

VOID EFIAPI RefreshKeyHelp	(	IN FORM_DISPLAY_ENGINE_FORM *	FormData,
		IN FORM_DISPLAY_ENGINE_STATEMENT *	Statement,
		IN BOOLEAN	Selected
	)

This function updates customized key panel's help information. The library will prepare those Strings for the basic key, ESC, Enter, Up/Down/Left/Right, +/-. and arrange them in Footer panel.

Parameters

[in]	FormData	Form Data to be shown in Page. FormData has the highlighted statement.
[in]	Statement	The statement current selected.
[in]	Selected	Whether or not a tag be selected. TRUE means Enter has hit this question.

VOID EFIAPI UpdateStatusBar	(	IN UINTN	MessageType,
		IN BOOLEAN	State
	)

Update status bar.

This function updates the status bar on the bottom of menu screen. It just shows StatusBar. Original logic in this function should be splitted out.

Parameters

[in]	MessageType	The type of message to be shown. InputError or Configuration Changed.
[in]	State	Show or Clear Message.