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   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _LIB_EDITOR_H_
  16 #define _LIB_EDITOR_H_
  17
  18 #include "TextEditorTypes.h"
  19
  20 /**
  21   The initialization function for MainEditor.
  22
  23   @retval EFI_SUCCESS             The operation was successful.
  24   @retval EFI_LOAD_ERROR          A load error occured.
  25 **/
  26 EFI_STATUS
  27 MainEditorInit (
  28   VOID
  29   );
  30
  31 /**
  32   The cleanup function for MainEditor.
  33
  34   @retval EFI_SUCCESS             The operation was successful.
  35   @retval EFI_LOAD_ERROR          A load error occured.
  36 **/
  37 EFI_STATUS
  38 MainEditorCleanup (
  39   VOID
  40   );
  41
  42 /**
  43   Refresh the main editor component.
  44 **/
  45 VOID
  46 MainEditorRefresh (
  47   VOID
  48   );
  49
  50 /**
  51   Handle user key input. This routes to other functions for the actions.
  52
  53   @retval EFI_SUCCESS             The operation was successful.
  54   @retval EFI_LOAD_ERROR          A load error occured.
  55   @retval EFI_OUT_OF_RESOURCES    A memory allocation failed.
  56 **/
  57 EFI_STATUS
  58 MainEditorKeyInput (
  59   VOID
  60   );
  61
  62 /**
  63   Backup function for MainEditor
  64
  65   @retval EFI_SUCCESS The operation was successful.
  66 **/
  67 EFI_STATUS
  68 MainEditorBackup (
  69   VOID
  70   );
  71
  72 #endif