FormBrowserEx.h

Go to the documentation of this file.

 
#ifndef __FORM_BROWSER_EXTENSION_H__
#define __FORM_BROWSER_EXTENSION_H__
 
#define FORM_BROWSER_EXTENSION_PROTOCOL_GUID  \
  { 0x1f73b18d, 0x4630, 0x43c1, { 0xa1, 0xde, 0x6f, 0x80, 0x85, 0x5d, 0x7d, 0xa4 } }
 
typedef struct _EDKII_FORM_BROWSER_EXTENSION_PROTOCOL EDKII_FORM_BROWSER_EXTENSION_PROTOCOL;
 
//
// To be compatible, keep EFI_FORM_BROWSER_EXTENSION_PROTOCOL definition
//
typedef EDKII_FORM_BROWSER_EXTENSION_PROTOCOL EFI_FORM_BROWSER_EXTENSION_PROTOCOL;
 
//
// Return value of SAVE_REMINDER() that describes whether the changed data is saved or discarded.
//
#define BROWSER_NO_CHANGES       0
#define BROWSER_SAVE_CHANGES     1
#define BROWSER_DISCARD_CHANGES  2
#define BROWSER_KEEP_CURRENT     3
 
//
// Browser actions. They can be cominbed together.
// If more than one actions are specified, the action with low bit will be executed first.
//
#define BROWSER_ACTION_UNREGISTER  0
#define BROWSER_ACTION_DISCARD     BIT0
#define BROWSER_ACTION_DEFAULT     BIT1
#define BROWSER_ACTION_SUBMIT      BIT2
#define BROWSER_ACTION_RESET       BIT3
#define BROWSER_ACTION_EXIT        BIT4
#define BROWSER_ACTION_GOTO        BIT5
 
//
// Scope for Browser action. It may be Form, FormSet or System level.
//
typedef enum {
  FormLevel,
  FormSetLevel,
  SystemLevel,
  MaxLevel
} BROWSER_SETTING_SCOPE;
 
typedef
EFI_STATUS
(EFIAPI *SET_SCOPE)(
  IN BROWSER_SETTING_SCOPE Scope
  );
 
typedef
EFI_STATUS
(EFIAPI *REGISTER_HOT_KEY)(
  IN EFI_INPUT_KEY *KeyData,
  IN UINT32        Action,
  IN UINT16        DefaultId,
  IN EFI_STRING    HelpString OPTIONAL
  );
 
typedef
VOID
(EFIAPI *EXIT_HANDLER)(
  VOID
  );
 
typedef
VOID
(EFIAPI *REGISTER_EXIT_HANDLER)(
  IN EXIT_HANDLER Handler
  );
 
typedef
UINT32
(EFIAPI *SAVE_REMINDER)(
  VOID
  );
 
struct _EDKII_FORM_BROWSER_EXTENSION_PROTOCOL {
  SET_SCOPE                SetScope;
  REGISTER_HOT_KEY         RegisterHotKey;
  REGISTER_EXIT_HANDLER    RegiserExitHandler;
  SAVE_REMINDER            SaveReminder;
};
 
extern EFI_GUID  gEdkiiFormBrowserExProtocolGuid;
 
#endif