ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/MainTextEditor.h

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