ShellPkg/Library/UefiShellDebug1CommandsLib/EditTitleBar.h

   1 /** @file
   2   Declares titlebar 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_TITLE_BAR_H_
  10 #define _LIB_TITLE_BAR_H_
  11
  12 /**
  13   Initialize a title bar.
  14
  15   @param[in] Prompt             The prompt to print in the title bar.
  16
  17   @retval EFI_SUCCESS           The initialization was successful.
  18   @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.
  19 **/
  20 EFI_STATUS
  21 MainTitleBarInit (
  22   CONST CHAR16  *Prompt
  23   );
  24
  25 /**
  26   Clean up the memory used.
  27 **/
  28 VOID
  29 MainTitleBarCleanup (
  30   VOID
  31   );
  32
  33 typedef enum {
  34   FileTypeNone,
  35   FileTypeAscii,
  36   FileTypeUnicode,
  37   FileTypeDiskBuffer,
  38   FileTypeMemBuffer,
  39   FileTypeFileBuffer
  40 } EDIT_FILE_TYPE;
  41
  42 /**
  43   Refresh function for MainTitleBar
  44
  45   @param[in] FileName           The open file's name (or NULL).
  46   @param[in] FileType           The type fo the file.
  47   @param[in] ReadOnly           TRUE if the file is read only.  FALSE otherwise.
  48   @param[in] Modified           TRUE if the file was modified.  FALSE otherwise.
  49   @param[in] LastCol            The last printable column.
  50   @param[in] LastRow            The last printable row.
  51   @param[in] Offset             The offset into the file. (only for mem/disk)
  52   @param[in] Size               The file's size. (only for mem/disk)
  53
  54   @retval EFI_SUCCESS           The operation was successful.
  55 **/
  56 EFI_STATUS
  57 MainTitleBarRefresh (
  58   IN CONST CHAR16          *FileName OPTIONAL,
  59   IN CONST EDIT_FILE_TYPE  FileType,
  60   IN CONST BOOLEAN         ReadOnly,
  61   IN CONST BOOLEAN         Modified,
  62   IN CONST UINTN           LastCol,
  63   IN CONST UINTN           LastRow,
  64   IN CONST UINTN           Offset,
  65   IN CONST UINTN           Size
  66   );
  67
  68 #endif