2 This library class defines a set of interfaces to customize Display module
4 Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available under
6 the terms and conditions of the BSD License that accompanies this distribution.
7 The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php.
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef __CUSTOMIZED_DISPLAY_LIB_H__
16 #define __CUSTOMIZED_DISPLAY_LIB_H__
18 #include <Protocol/DisplayProtocol.h>
21 +------------------------------------------------------------------------------+
23 +------------------------------------------------------------------------------+
33 +------------------------------------------------------------------------------+
34 | F9=Reset to Defaults F10=Save |
35 | ^"=Move Highlight <Spacebar> Toggles Checkbox Esc=Exit |
36 +------------------------------------------------------------------------------+
41 This funtion defines Page Frame and Backgroud.
43 Based on the above layout, it will be responsible for HeaderHeight, FooterHeight,
44 StatusBarHeight and Backgroud. And, it will reserve Screen for Statement.
46 @param[in] FormData Form Data to be shown in Page.
47 @param[out] ScreenForStatement Screen to be used for Statement. (Prompt, Value and Help)
54 IN FORM_DISPLAY_ENGINE_FORM
*FormData
,
55 OUT EFI_SCREEN_DESCRIPTOR
*ScreenForStatement
59 Clear Screen to the initial state.
68 This function updates customized key panel's help information.
69 The library will prepare those Strings for the basic key, ESC, Enter, Up/Down/Left/Right, +/-.
70 and arrange them in Footer panel.
72 @param[in] FormData Form Data to be shown in Page. FormData has the highlighted statement.
73 @param[in] Statement The statement current selected.
74 @param[in] Selected Whether or not a tag be selected. TRUE means Enter has hit this question.
79 IN FORM_DISPLAY_ENGINE_FORM
*FormData
,
80 IN FORM_DISPLAY_ENGINE_STATEMENT
*Statement
,
87 This function updates the status bar on the bottom of menu screen. It just shows StatusBar.
88 Original logic in this function should be splitted out.
90 @param[in] MessageType The type of message to be shown. InputError or Configuration Changed.
91 @param[in] State Show or Clear Message.
103 This function draws OEM/Vendor specific pop up windows.
105 @param[out] Key User Input Key
106 @param ... String to be shown in Popup. The variable argument list is terminated by a NULL.
112 OUT EFI_INPUT_KEY
*Key
, OPTIONAL
117 Confirm how to handle the changed data.
119 @return Action BROWSER_ACTION_SUBMIT, BROWSER_ACTION_DISCARD or other values.
128 OEM specifies whether Setup exits Page by ESC key.
130 This function customized the behavior that whether Setup exits Page so that
131 system able to boot when configuration is not changed.
133 @retval TRUE Exits FrontPage
134 @retval FALSE Don't exit FrontPage.
143 Set Timeout value for a ceratain Form to get user response.
145 This function allows to set timeout value on a ceratain form if necessary.
146 If timeout is not zero, the form will exit if user has no response in timeout.
148 @param[in] FormData Form Data to be shown in Page
150 @return 0 No timeout for this form.
151 @return > 0 Timeout value in 100 ns units.
156 IN FORM_DISPLAY_ENGINE_FORM
*FormData
163 Prints a unicode string to the default console, at
164 the supplied cursor position, using L"%s" format.
166 @param Column The cursor position to print the string at. When it is -1, use current Position.
167 @param Row The cursor position to print the string at. When it is -1, use current Position.
168 @param String String pointer.
170 @return Length of string printed to the console
183 Prints a unicode string with the specified width to the default console, at
184 the supplied cursor position, using L"%s" format.
186 @param Column The cursor position to print the string at. When it is -1, use current Position.
187 @param Row The cursor position to print the string at. When it is -1, use current Position.
188 @param String String pointer.
189 @param Width Width for String to be printed. If the print length of String < Width,
190 Space char (L' ') will be used to append String.
192 @return Length of string printed to the console
197 PrintStringAtWithWidth (
205 Prints a character to the default console, at
206 the supplied cursor position, using L"%c" format.
208 @param Column The cursor position to print the string at. When it is -1, use current Position.
209 @param Row The cursor position to print the string at. When it is -1, use current Position.
210 @param Character Character to print.
212 @return Length of string printed to the console.
224 Clear retangle with specified text attribute.
226 @param LeftColumn Left column of retangle.
227 @param RightColumn Right column of retangle.
228 @param TopRow Start row of retangle.
229 @param BottomRow End row of retangle.
230 @param TextAttribute The character foreground and background.
237 IN UINTN RightColumn
,
240 IN UINTN TextAttribute
244 // Color Setting Functions
247 Get OEM/Vendor specific popup attribute colors.
249 @retval Byte code color setting for popup color.
258 Get OEM/Vendor specific popup attribute colors.
260 @retval Byte code color setting for popup inverse color.
264 GetPopupInverseColor (
269 Get OEM/Vendor specific PickList color attribute.
271 @retval Byte code color setting for pick list color.
280 Get OEM/Vendor specific arrow color attribute.
282 @retval Byte code color setting for arrow color.
291 Get OEM/Vendor specific info text color attribute.
293 @retval Byte code color setting for info text color.
302 Get OEM/Vendor specific help text color attribute.
304 @retval Byte code color setting for help text color.
313 Get OEM/Vendor specific grayed out text color attribute.
315 @retval Byte code color setting for grayed out text color.
324 Get OEM/Vendor specific highlighted text color attribute.
326 @retval Byte code color setting for highlight text color.
330 GetHighlightTextColor (
335 Get OEM/Vendor specific field text color attribute.
337 @retval Byte code color setting for field text color.
346 Get OEM/Vendor specific subtitle text color attribute.
348 @retval Byte code color setting for subtitle text color.
352 GetSubTitleTextColor (