EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index

MdePkg/Include/Protocol/FormBrowser2.h

Go to the documentation of this file.
00001 
00018 #ifndef __EFI_FORM_BROWSER2_H__
00019 #define __EFI_FORM_BROWSER2_H__
00020 
00021 #include <Guid/HiiPlatformSetupFormset.h>
00022 
00023 #define EFI_FORM_BROWSER2_PROTOCOL_GUID \
00024   {0xb9d4c360, 0xbcfb, 0x4f9b, {0x92, 0x98, 0x53, 0xc1, 0x36, 0x98, 0x22, 0x58 }}
00025 
00026 
00027 typedef struct _EFI_FORM_BROWSER2_PROTOCOL   EFI_FORM_BROWSER2_PROTOCOL;
00028 
00029 
00030 
00049 typedef struct {
00050   UINTN   LeftColumn;
00051   UINTN   RightColumn;
00052   UINTN   TopRow;
00053   UINTN   BottomRow;
00054 } EFI_SCREEN_DESCRIPTOR;
00055 
00056 typedef UINTN EFI_BROWSER_ACTION_REQUEST;
00057 
00058 #define EFI_BROWSER_ACTION_REQUEST_NONE   0
00059 #define EFI_BROWSER_ACTION_REQUEST_RESET  1
00060 #define EFI_BROWSER_ACTION_REQUEST_SUBMIT 2
00061 #define EFI_BROWSER_ACTION_REQUEST_EXIT   3
00062 #define EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT  4
00063 #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT 5
00064 #define EFI_BROWSER_ACTION_REQUEST_FORM_APPLY        6
00065 #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD      7
00066 
00067 
00104 typedef
00105 EFI_STATUS
00106 (EFIAPI *EFI_SEND_FORM2)(
00107   IN CONST  EFI_FORM_BROWSER2_PROTOCOL  *This,
00108   IN        EFI_HII_HANDLE              *Handle,
00109   IN        UINTN                      HandleCount,
00110   IN        EFI_GUID                   *FormSetGuid, OPTIONAL
00111   IN        EFI_FORM_ID                FormId, OPTIONAL
00112   IN CONST  EFI_SCREEN_DESCRIPTOR      *ScreenDimensions, OPTIONAL
00113   OUT       EFI_BROWSER_ACTION_REQUEST *ActionRequest  OPTIONAL
00114 );
00115 
00116 
00156 typedef
00157 EFI_STATUS
00158 (EFIAPI *EFI_BROWSER_CALLBACK2)(
00159   IN CONST  EFI_FORM_BROWSER2_PROTOCOL *This,
00160   IN OUT    UINTN                     *ResultsDataSize,
00161   IN OUT    EFI_STRING                ResultsData,
00162   IN CONST  BOOLEAN                   RetrieveData,
00163   IN CONST  EFI_GUID                  *VariableGuid, OPTIONAL
00164   IN CONST  CHAR16                    *VariableName OPTIONAL
00165 );
00166 
00171 struct _EFI_FORM_BROWSER2_PROTOCOL {
00172   EFI_SEND_FORM2         SendForm;
00173   EFI_BROWSER_CALLBACK2  BrowserCallback;
00174 } ;
00175 
00176 extern EFI_GUID gEfiFormBrowser2ProtocolGuid;
00177 
00178 #endif
00179 
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines