2 This library class defines a set of interfaces to customize Display module
4 Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
9 #ifndef __CUSTOMIZED_DISPLAY_LIB_H__
10 #define __CUSTOMIZED_DISPLAY_LIB_H__
12 #include <Protocol/DisplayProtocol.h>
15 +------------------------------------------------------------------------------+
17 +------------------------------------------------------------------------------+
27 +------------------------------------------------------------------------------+
28 | F9=Reset to Defaults F10=Save |
29 | ^"=Move Highlight <Spacebar> Toggles Checkbox Esc=Exit |
30 +------------------------------------------------------------------------------+
35 This funtion defines Page Frame and Backgroud.
37 Based on the above layout, it will be responsible for HeaderHeight, FooterHeight,
38 StatusBarHeight and Backgroud. And, it will reserve Screen for Statement.
40 @param[in] FormData Form Data to be shown in Page.
41 @param[out] ScreenForStatement Screen to be used for Statement. (Prompt, Value and Help)
48 IN FORM_DISPLAY_ENGINE_FORM
*FormData
,
49 OUT EFI_SCREEN_DESCRIPTOR
*ScreenForStatement
53 Clear Screen to the initial state.
62 This function updates customized key panel's help information.
63 The library will prepare those Strings for the basic key, ESC, Enter, Up/Down/Left/Right, +/-.
64 and arrange them in Footer panel.
66 @param[in] FormData Form Data to be shown in Page. FormData has the highlighted statement.
67 @param[in] Statement The statement current selected.
68 @param[in] Selected Whether or not a tag be selected. TRUE means Enter has hit this question.
73 IN FORM_DISPLAY_ENGINE_FORM
*FormData
,
74 IN FORM_DISPLAY_ENGINE_STATEMENT
*Statement
,
81 This function updates the status bar on the bottom of menu screen. It just shows StatusBar.
82 Original logic in this function should be splitted out.
84 @param[in] MessageType The type of message to be shown. InputError or Configuration Changed.
85 @param[in] State Show or Clear Message.
97 This function draws OEM/Vendor specific pop up windows.
99 @param[out] Key User Input Key
100 @param ... String to be shown in Popup. The variable argument list is terminated by a NULL.
106 OUT EFI_INPUT_KEY
*Key
, OPTIONAL
111 Confirm how to handle the changed data.
113 @return Action BROWSER_ACTION_SUBMIT, BROWSER_ACTION_DISCARD or other values.
122 OEM specifies whether Setup exits Page by ESC key.
124 This function customized the behavior that whether Setup exits Page so that
125 system able to boot when configuration is not changed.
127 @retval TRUE Exits FrontPage
128 @retval FALSE Don't exit FrontPage.
137 Set Timeout value for a ceratain Form to get user response.
139 This function allows to set timeout value on a ceratain form if necessary.
140 If timeout is not zero, the form will exit if user has no response in timeout.
142 @param[in] FormData Form Data to be shown in Page
144 @return 0 No timeout for this form.
145 @return > 0 Timeout value in 100 ns units.
150 IN FORM_DISPLAY_ENGINE_FORM
*FormData
157 Prints a unicode string to the default console, at
158 the supplied cursor position, using L"%s" format.
160 @param Column The cursor position to print the string at. When it is -1, use current Position.
161 @param Row The cursor position to print the string at. When it is -1, use current Position.
162 @param String String pointer.
164 @return Length of string printed to the console
177 Prints a unicode string with the specified width to the default console, at
178 the supplied cursor position, using L"%s" format.
180 @param Column The cursor position to print the string at. When it is -1, use current Position.
181 @param Row The cursor position to print the string at. When it is -1, use current Position.
182 @param String String pointer.
183 @param Width Width for String to be printed. If the print length of String < Width,
184 Space char (L' ') will be used to append String.
186 @return Length of string printed to the console
191 PrintStringAtWithWidth (
199 Prints a character to the default console, at
200 the supplied cursor position, using L"%c" format.
202 @param Column The cursor position to print the string at. When it is -1, use current Position.
203 @param Row The cursor position to print the string at. When it is -1, use current Position.
204 @param Character Character to print.
206 @return Length of string printed to the console.
218 Clear retangle with specified text attribute.
220 @param LeftColumn Left column of retangle.
221 @param RightColumn Right column of retangle.
222 @param TopRow Start row of retangle.
223 @param BottomRow End row of retangle.
224 @param TextAttribute The character foreground and background.
231 IN UINTN RightColumn
,
234 IN UINTN TextAttribute
238 // Color Setting Functions
241 Get OEM/Vendor specific popup attribute colors.
243 @retval Byte code color setting for popup color.
252 Get OEM/Vendor specific popup attribute colors.
254 @retval Byte code color setting for popup inverse color.
258 GetPopupInverseColor (
263 Get OEM/Vendor specific PickList color attribute.
265 @retval Byte code color setting for pick list color.
274 Get OEM/Vendor specific arrow color attribute.
276 @retval Byte code color setting for arrow color.
285 Get OEM/Vendor specific info text color attribute.
287 @retval Byte code color setting for info text color.
296 Get OEM/Vendor specific help text color attribute.
298 @retval Byte code color setting for help text color.
307 Get OEM/Vendor specific grayed out text color attribute.
309 @retval Byte code color setting for grayed out text color.
318 Get OEM/Vendor specific highlighted text color attribute.
320 @retval Byte code color setting for highlight text color.
324 GetHighlightTextColor (
329 Get OEM/Vendor specific field text color attribute.
331 @retval Byte code color setting for field text color.
340 Get OEM/Vendor specific subtitle text color attribute.
342 @retval Byte code color setting for subtitle text color.
346 GetSubTitleTextColor (