MainHexEditor.h 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. /** @file
  2. Defines the Main Editor data type -
  3. - Global variables
  4. - Instances of the other objects of the editor
  5. - Main Interfaces
  6. Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>
  7. SPDX-License-Identifier: BSD-2-Clause-Patent
  8. **/
  9. #ifndef _LIB_EDITOR_H_
  10. #define _LIB_EDITOR_H_
  11. #include "HexEditor.h"
  12. /**
  13. Init function for MainEditor
  14. @retval EFI_SUCCESS The operation was successful.
  15. @retval EFI_LOAD_ERROR A load error occurred.
  16. **/
  17. EFI_STATUS
  18. HMainEditorInit (
  19. VOID
  20. );
  21. /**
  22. Cleanup function for MainEditor.
  23. @retval EFI_SUCCESS The operation was successful.
  24. @retval EFI_LOAD_ERROR A load error occurred.
  25. **/
  26. EFI_STATUS
  27. HMainEditorCleanup (
  28. VOID
  29. );
  30. /**
  31. Refresh function for MainEditor.
  32. @retval EFI_SUCCESS The operation was successful.
  33. **/
  34. EFI_STATUS
  35. HMainEditorRefresh (
  36. VOID
  37. );
  38. /**
  39. Handle user key input. will route it to other components handle function.
  40. @retval EFI_SUCCESS The operation was successful.
  41. @retval EFI_OUT_OF_RESOURCES A memory allocation occurred.
  42. @retval EFI_LOAD_ERROR A load error occurred.
  43. **/
  44. EFI_STATUS
  45. HMainEditorKeyInput (
  46. VOID
  47. );
  48. /**
  49. Backup function for MainEditor.
  50. **/
  51. VOID
  52. HMainEditorBackup (
  53. VOID
  54. );
  55. #endif