HiiPopup.h File Reference

Go to the source code of this file.

Classes
struct	_EFI_HII_POPUP_PROTOCOL

Macros
#define	EFI_HII_POPUP_PROTOCOL_GUID    {0x4311edc0, 0x6054, 0x46d4, {0x9e, 0x40, 0x89, 0x3e, 0xa9, 0x52, 0xfc, 0xcc}}
#define	EFI_HII_POPUP_PROTOCOL_REVISION   1

Typedefs
typedef struct _EFI_HII_POPUP_PROTOCOL	EFI_HII_POPUP_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_HII_CREATE_POPUP) (IN EFI_HII_POPUP_PROTOCOL *This, IN EFI_HII_POPUP_STYLE PopupStyle, IN EFI_HII_POPUP_TYPE PopupType, IN EFI_HII_HANDLE HiiHandle, IN EFI_STRING_ID Message, OUT EFI_HII_POPUP_SELECTION *UserSelection OPTIONAL)

Enumerations
enum	EFI_HII_POPUP_STYLE { EfiHiiPopupStyleInfo , EfiHiiPopupStyleWarning , EfiHiiPopupStyleError }
enum	EFI_HII_POPUP_TYPE { EfiHiiPopupTypeOk , EfiHiiPopupTypeOkCancel , EfiHiiPopupTypeYesNo , EfiHiiPopupTypeYesNoCancel }
enum	EFI_HII_POPUP_SELECTION { EfiHiiPopupSelectionOk , EfiHiiPopupSelectionCancel , EfiHiiPopupSelectionYes , EfiHiiPopupSelectionNo }

Variables
EFI_GUID	gEfiHiiPopupProtocolGuid

Detailed Description

This protocol provides services to display a popup window. The protocol is typically produced by the forms browser and consumed by a driver callback handler.

Copyright (c) 2017-2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:

This Protocol was introduced in UEFI Specification 2.7.

Macro Definition Documentation

EFI_HII_POPUP_PROTOCOL_GUID

#define EFI_HII_POPUP_PROTOCOL_GUID    {0x4311edc0, 0x6054, 0x46d4, {0x9e, 0x40, 0x89, 0x3e, 0xa9, 0x52, 0xfc, 0xcc}}

EFI_HII_POPUP_PROTOCOL_REVISION

#define EFI_HII_POPUP_PROTOCOL_REVISION   1

Typedef Documentation

EFI_HII_CREATE_POPUP

typedef EFI_STATUS(EFIAPI * EFI_HII_CREATE_POPUP) (IN EFI_HII_POPUP_PROTOCOL *This, IN EFI_HII_POPUP_STYLE PopupStyle, IN EFI_HII_POPUP_TYPE PopupType, IN EFI_HII_HANDLE HiiHandle, IN EFI_STRING_ID Message, OUT EFI_HII_POPUP_SELECTION *UserSelection OPTIONAL)

Displays a popup window.

Parameters

This	A pointer to the EFI_HII_POPUP_PROTOCOL instance.
PopupStyle	Popup style to use.
PopupType	Type of the popup to display.
HiiHandle	HII handle of the string pack containing Message
Message	A message to display in the popup box.
UserSelection	User selection.

Return values

EFI_SUCCESS	The popup box was successfully displayed.
EFI_INVALID_PARAMETER	HiiHandle and Message do not define a valid HII string.
EFI_INVALID_PARAMETER	PopupType is not one of the values defined by this specification.
EFI_OUT_OF_RESOURCES	There are not enough resources available to display the popup box.

EFI_HII_POPUP_PROTOCOL

typedef struct _EFI_HII_POPUP_PROTOCOL EFI_HII_POPUP_PROTOCOL

Enumeration Type Documentation

EFI_HII_POPUP_SELECTION

enum EFI_HII_POPUP_SELECTION

Enumerator
EfiHiiPopupSelectionOk
EfiHiiPopupSelectionCancel
EfiHiiPopupSelectionYes
EfiHiiPopupSelectionNo

EFI_HII_POPUP_STYLE

enum EFI_HII_POPUP_STYLE

Enumerator
EfiHiiPopupStyleInfo
EfiHiiPopupStyleWarning
EfiHiiPopupStyleError

EFI_HII_POPUP_TYPE

enum EFI_HII_POPUP_TYPE

Enumerator
EfiHiiPopupTypeOk
EfiHiiPopupTypeOkCancel
EfiHiiPopupTypeYesNo
EfiHiiPopupTypeYesNoCancel

Variable Documentation

gEfiHiiPopupProtocolGuid

EFI_GUID gEfiHiiPopupProtocolGuid

extern