FrontPageCustomizedUi.h 2.9 KB

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