projects / mirror_edk2.git / blame
| 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 | |
| 9d510e61 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
| c9802c45 ED |
6 | \r |
| 7 | **/\r | |
| 8 | \r | |
| 9 | #ifndef __FRONTPAGE_CUSTOMIZED_UI_H__\r | |
| 10 | #define __FRONTPAGE_CUSTOMIZED_UI_H__\r | |
| 11 | \r | |
| 12 | /**\r | |
| 13 | Update the banner string in the front page.\r | |
| 14 | \r | |
| 15 | Current layout for the banner string like below:\r | |
| 16 | PS: Totally only 5 lines of banner supported.\r | |
| 17 | \r | |
| 18 | Line 1: Left BannerStr RightBannerStr\r | |
| 19 | Line 2: Left BannerStr RightBannerStr\r | |
| 20 | Line 3: Left BannerStr RightBannerStr\r | |
| 21 | Line 4: Left BannerStr RightBannerStr\r | |
| 22 | Line 5: Left BannerStr RightBannerStr\r | |
| 23 | <EmptyLine>\r | |
| 24 | First menu in front page.\r | |
| 25 | ...\r | |
| 26 | \r | |
| 27 | @param LineIndex The line index of the banner need to check.\r | |
| 28 | @param LeftOrRight The left or right banner need to check.\r | |
| 29 | @param BannerStr Banner string need to update.\r | |
| 30 | Input the current string and user can update\r | |
| 31 | it and return the new string.\r | |
| 32 | \r | |
| 33 | **/\r | |
| 34 | VOID\r | |
| 35 | UiCustomizeFrontPageBanner (\r | |
| 36 | IN UINTN LineIndex,\r | |
| 37 | IN BOOLEAN LeftOrRight,\r | |
| 38 | IN OUT EFI_STRING *BannerStr\r | |
| 39 | );\r | |
| 40 | \r | |
| 41 | /**\r | |
| 42 | Customize menus in the page.\r | |
| 43 | \r | |
| 44 | @param[in] HiiHandle The HII Handle of the form to update.\r | |
| 45 | @param[in] StartOpCodeHandle The context used to insert opcode.\r | |
| 46 | \r | |
| 47 | **/\r | |
| 48 | VOID\r | |
| 49 | UiCustomizeFrontPage (\r | |
| 50 | IN EFI_HII_HANDLE HiiHandle,\r | |
| 51 | IN VOID *StartOpCodeHandle\r | |
| 52 | );\r | |
| 53 | \r | |
| 54 | /**\r | |
| 55 | This function processes the results of changes in configuration.\r | |
| 56 | \r | |
| 57 | \r | |
| 58 | @param HiiHandle Points to the hii handle for this formset.\r | |
| 59 | @param Action Specifies the type of action taken by the browser.\r | |
| 60 | @param QuestionId A unique value which is sent to the original exporting driver\r | |
| 61 | so that it can identify the type of data to expect.\r | |
| 62 | @param Type The type of value for the question.\r | |
| 63 | @param Value A pointer to the data being sent to the original exporting driver.\r | |
| 64 | @param ActionRequest On return, points to the action requested by the callback function.\r | |
| 65 | \r | |
| 66 | @retval EFI_SUCCESS The callback successfully handled the action.\r | |
| 67 | @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r | |
| 68 | @retval EFI_DEVICE_ERROR The variable could not be saved.\r | |
| 69 | @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.\r | |
| 70 | \r | |
| 71 | **/\r | |
| 72 | EFI_STATUS\r | |
| 73 | UiFrontPageCallbackHandler (\r | |
| 74 | IN EFI_HII_HANDLE HiiHandle,\r | |
| 75 | IN EFI_BROWSER_ACTION Action,\r | |
| 76 | IN EFI_QUESTION_ID QuestionId,\r | |
| 77 | IN UINT8 Type,\r | |
| 78 | IN EFI_IFR_TYPE_VALUE *Value,\r | |
| 79 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r | |
| 80 | );\r | |
| 81 | \r | |
| 82 | #endif\r |