MdeModulePkg UiApp: change code for easy customization.

[mirror_edk2.git] / MdeModulePkg / Application / UiApp / FrontPageCustomizedUiSupport.h

/** @file\r
  This library class defines a set of interfaces to be used by customize Ui module\r
\r
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under\r
the terms and conditions of the BSD License that accompanies this distribution.\r
The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php.\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __FRONTPAGE_CUSTOMIZE_UI_SUPPORT_UI_H__\r
#define __FRONTPAGE_CUSTOMIZE_UI_SUPPORT_UI_H__\r
\r
/**\r
  Create continue menu in the front page.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
  @retval   EFI_SUCCESS         Search the driver success\r
\r
**/\r
VOID\r
UiCreateContinueMenu (\r
  IN EFI_HII_HANDLE              HiiHandle,\r
  IN VOID                        *StartOpCodeHandle\r
  );\r
\r
/**\r
  Create empty line menu.\r
\r
  @param    HiiHandle           The hii handle for the Uiapp driver.\r
  @param    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
  @retval   EFI_SUCCESS         Search the driver success\r
\r
**/\r
VOID\r
UiCreateEmptyLine (\r
  IN EFI_HII_HANDLE              HiiHandle,\r
  IN VOID                        *StartOpCodeHandle\r
  );\r
\r
/**\r
  Create Select language menu in the front page with oneof opcode.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
  @retval   EFI_SUCCESS         Search the driver success\r
\r
**/\r
VOID\r
UiCreateLanguageMenu (\r
  IN EFI_HII_HANDLE              HiiHandle,\r
  IN VOID                        *StartOpCodeHandle\r
  );\r
\r
/**\r
  Create Reset menu.\r
\r
  @param[in]    HiiHandle           The hii handle for the Uiapp driver.\r
  @param[in]    StartOpCodeHandle   The opcode handle to save the new opcode.\r
\r
  @retval   EFI_SUCCESS         Search the driver success\r
\r
**/\r
VOID\r
UiCreateResetMenu (\r
  IN EFI_HII_HANDLE              HiiHandle,\r
  IN VOID                        *StartOpCodeHandle\r
  );\r
\r
/**\r
  Rename the driver name if necessary.\r
\r
  @param    DriverName          Input the driver name.\r
  @param    NewDriverName       Return the new driver name.\r
  @param    EmptyLineAfter      Whether need to insert empty line.\r
\r
  @retval   New driver name if compared, else NULL.\r
\r
**/\r
typedef\r
BOOLEAN\r
(EFIAPI *DRIVER_SPECIAL_HANDLER)(\r
  IN  CHAR16                   *DriverName,\r
  OUT CHAR16                   **NewName,\r
  OUT BOOLEAN                  *EmptyLineAfter\r
);\r
\r
/**\r
  Search the drivers in the system which need to show in the front page\r
  and insert the menu to the front page.\r
\r
  @param    HiiHandle           The hii handle for the Uiapp driver.\r
  @param    ClassGuid           The class guid for the driver which is the target.\r
  @param    StartOpCodeHandle   The opcode handle to save the new opcode.\r
  @param    SpecialHandler      The pointer to the specail handler function, if any.\r
\r
  @retval   EFI_SUCCESS         Search the driver success\r
\r
**/\r
EFI_STATUS\r
UiListThirdPartyDrivers (\r
  IN EFI_HII_HANDLE              HiiHandle,\r
  IN EFI_GUID                    *ClassGuid,\r
  IN DRIVER_SPECIAL_HANDLER      SpecialHandlerFn,\r
  IN VOID                        *StartOpCodeHandle\r
  );\r
\r
/**\r
  This function processes the results of changes in configuration.\r
\r
\r
  @param HiiHandle       Points to the hii handle for this formset.\r
  @param Action          Specifies the type of action taken by the browser.\r
  @param QuestionId      A unique value which is sent to the original exporting driver\r
                         so that it can identify the type of data to expect.\r
  @param Type            The type of value for the question.\r
  @param Value           A pointer to the data being sent to the original exporting driver.\r
  @param ActionRequest   On return, points to the action requested by the callback function.\r
  @param Status          Return the handle status.\r
\r
  @retval  TRUE          The callback successfully handled the action.\r
  @retval  FALSE         The callback not supported in this handler.\r
\r
**/\r
BOOLEAN\r
UiSupportLibCallbackHandler (\r
  IN  EFI_HII_HANDLE                         HiiHandle,\r
  IN  EFI_BROWSER_ACTION                     Action,\r
  IN  EFI_QUESTION_ID                        QuestionId,\r
  IN  UINT8                                  Type,\r
  IN  EFI_IFR_TYPE_VALUE                     *Value,\r
  OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest,\r
  OUT EFI_STATUS                             *Status\r
  );\r
\r
#endif\r