MainTextEditor.h 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. /** @file
  2. Declares editor interface functions.
  3. Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved. <BR>
  4. SPDX-License-Identifier: BSD-2-Clause-Patent
  5. **/
  6. #ifndef _LIB_EDITOR_H_
  7. #define _LIB_EDITOR_H_
  8. #include "TextEditorTypes.h"
  9. /**
  10. The initialization function for MainEditor.
  11. @retval EFI_SUCCESS The operation was successful.
  12. @retval EFI_LOAD_ERROR A load error occurred.
  13. **/
  14. EFI_STATUS
  15. MainEditorInit (
  16. VOID
  17. );
  18. /**
  19. The cleanup function for MainEditor.
  20. @retval EFI_SUCCESS The operation was successful.
  21. @retval EFI_LOAD_ERROR A load error occurred.
  22. **/
  23. EFI_STATUS
  24. MainEditorCleanup (
  25. VOID
  26. );
  27. /**
  28. Refresh the main editor component.
  29. **/
  30. VOID
  31. MainEditorRefresh (
  32. VOID
  33. );
  34. /**
  35. Handle user key input. This routes to other functions for the actions.
  36. @retval EFI_SUCCESS The operation was successful.
  37. @retval EFI_LOAD_ERROR A load error occurred.
  38. @retval EFI_OUT_OF_RESOURCES A memory allocation failed.
  39. **/
  40. EFI_STATUS
  41. MainEditorKeyInput (
  42. VOID
  43. );
  44. /**
  45. Backup function for MainEditor
  46. @retval EFI_SUCCESS The operation was successful.
  47. **/
  48. EFI_STATUS
  49. MainEditorBackup (
  50. VOID
  51. );
  52. #endif