[mirror_edk2.git] / MdeModulePkg / Library / BootMaintenanceManagerUiLib / BootMaintenanceManagerCustomizedUi.h

/** @file\r
  This library class defines a set of interfaces to customize Ui module\r
\r
Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __CUSTOMIZED_UI_H__\r
#define __CUSTOMIZED_UI_H__\r
\r
/**\r
  Customize menus in the page.\r
\r
  @param[in]  HiiHandle             The HII Handle of the form to update.\r
  @param[in]  StartOpCodeHandle     The context used to insert opcode.\r
\r
**/\r
VOID\r
UiCustomizeBMMPage (\r
  IN EFI_HII_HANDLE  HiiHandle,\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
\r
  @retval  EFI_SUCCESS           The callback successfully handled the action.\r
  @retval  EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the variable and its data.\r
  @retval  EFI_DEVICE_ERROR      The variable could not be saved.\r
  @retval  EFI_UNSUPPORTED       The specified Action is not supported by the callback.\r
\r
**/\r
EFI_STATUS\r
UiBMMCallbackHandler (\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
  );\r
\r
#endif\r
Commit	Line	Data
a85be3ae 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
a85be3ae ED	6	\r
	7	**/\r
	8	\r
	9	#ifndef __CUSTOMIZED_UI_H__\r
	10	#define __CUSTOMIZED_UI_H__\r
	11	\r
a85be3ae ED	12	/**\r
	13	Customize menus in the page.\r
	14	\r
	15	@param[in] HiiHandle The HII Handle of the form to update.\r
	16	@param[in] StartOpCodeHandle The context used to insert opcode.\r
	17	\r
	18	**/\r
	19	VOID\r
	20	UiCustomizeBMMPage (\r
	21	IN EFI_HII_HANDLE HiiHandle,\r
	22	IN VOID *StartOpCodeHandle\r
	23	);\r
	24	\r
	25	/**\r
	26	This function processes the results of changes in configuration.\r
	27	\r
	28	\r
	29	@param HiiHandle Points to the hii handle for this formset.\r
	30	@param Action Specifies the type of action taken by the browser.\r
	31	@param QuestionId A unique value which is sent to the original exporting driver\r
	32	so that it can identify the type of data to expect.\r
	33	@param Type The type of value for the question.\r
	34	@param Value A pointer to the data being sent to the original exporting driver.\r
	35	@param ActionRequest On return, points to the action requested by the callback function.\r
	36	\r
	37	@retval EFI_SUCCESS The callback successfully handled the action.\r
	38	@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r
	39	@retval EFI_DEVICE_ERROR The variable could not be saved.\r
	40	@retval EFI_UNSUPPORTED The specified Action is not supported by the callback.\r
	41	\r
	42	**/\r
	43	EFI_STATUS\r
	44	UiBMMCallbackHandler (\r
1436aea4 MK	45	IN EFI_HII_HANDLE HiiHandle,\r
	46	IN EFI_BROWSER_ACTION Action,\r
	47	IN EFI_QUESTION_ID QuestionId,\r
	48	IN UINT8 Type,\r
	49	IN EFI_IFR_TYPE_VALUE *Value,\r
	50	OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r
a85be3ae ED	51	);\r
	52	\r
	53	#endif\r