]>
Commit | Line | Data |
---|---|---|
c9802c45 ED |
1 | /** @file\r |
2 | This library class defines a set of interfaces to customize Ui module\r | |
3 | \r | |
4 | Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r | |
5 | This program and the accompanying materials are licensed and made available under\r | |
6 | the terms and conditions of the BSD License that accompanies this distribution.\r | |
7 | The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php.\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef __FRONTPAGE_CUSTOMIZED_UI_H__\r | |
16 | #define __FRONTPAGE_CUSTOMIZED_UI_H__\r | |
17 | \r | |
18 | /**\r | |
19 | Update the banner string in the front page.\r | |
20 | \r | |
21 | Current layout for the banner string like below:\r | |
22 | PS: Totally only 5 lines of banner supported.\r | |
23 | \r | |
24 | Line 1: Left BannerStr RightBannerStr\r | |
25 | Line 2: Left BannerStr RightBannerStr\r | |
26 | Line 3: Left BannerStr RightBannerStr\r | |
27 | Line 4: Left BannerStr RightBannerStr\r | |
28 | Line 5: Left BannerStr RightBannerStr\r | |
29 | <EmptyLine>\r | |
30 | First menu in front page.\r | |
31 | ...\r | |
32 | \r | |
33 | @param LineIndex The line index of the banner need to check.\r | |
34 | @param LeftOrRight The left or right banner need to check.\r | |
35 | @param BannerStr Banner string need to update.\r | |
36 | Input the current string and user can update\r | |
37 | it and return the new string.\r | |
38 | \r | |
39 | **/\r | |
40 | VOID\r | |
41 | UiCustomizeFrontPageBanner (\r | |
42 | IN UINTN LineIndex,\r | |
43 | IN BOOLEAN LeftOrRight,\r | |
44 | IN OUT EFI_STRING *BannerStr\r | |
45 | );\r | |
46 | \r | |
47 | /**\r | |
48 | Customize menus in the page.\r | |
49 | \r | |
50 | @param[in] HiiHandle The HII Handle of the form to update.\r | |
51 | @param[in] StartOpCodeHandle The context used to insert opcode.\r | |
52 | \r | |
53 | **/\r | |
54 | VOID\r | |
55 | UiCustomizeFrontPage (\r | |
56 | IN EFI_HII_HANDLE HiiHandle,\r | |
57 | IN VOID *StartOpCodeHandle\r | |
58 | );\r | |
59 | \r | |
60 | /**\r | |
61 | This function processes the results of changes in configuration.\r | |
62 | \r | |
63 | \r | |
64 | @param HiiHandle Points to the hii handle for this formset.\r | |
65 | @param Action Specifies the type of action taken by the browser.\r | |
66 | @param QuestionId A unique value which is sent to the original exporting driver\r | |
67 | so that it can identify the type of data to expect.\r | |
68 | @param Type The type of value for the question.\r | |
69 | @param Value A pointer to the data being sent to the original exporting driver.\r | |
70 | @param ActionRequest On return, points to the action requested by the callback function.\r | |
71 | \r | |
72 | @retval EFI_SUCCESS The callback successfully handled the action.\r | |
73 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
74 | @retval EFI_DEVICE_ERROR The variable could not be saved.\r | |
75 | @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.\r | |
76 | \r | |
77 | **/\r | |
78 | EFI_STATUS\r | |
79 | UiFrontPageCallbackHandler (\r | |
80 | IN EFI_HII_HANDLE HiiHandle,\r | |
81 | IN EFI_BROWSER_ACTION Action,\r | |
82 | IN EFI_QUESTION_ID QuestionId,\r | |
83 | IN UINT8 Type,\r | |
84 | IN EFI_IFR_TYPE_VALUE *Value,\r | |
85 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r | |
86 | );\r | |
87 | \r | |
88 | #endif\r |