ShellPkg/Library/UefiShellDebug1CommandsLib/EditStatusBar.h

   1 /** @file
   2   Declares statusbar interface functions.
   3
   4   Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved. <BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #ifndef _LIB_STATUS_BAR_H_
  10 #define _LIB_STATUS_BAR_H_
  11
  12 /**
  13   Initialization function for Status Bar.
  14
  15   @retval EFI_SUCCESS           The operation was successful.
  16   @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.
  17   @sa StatusBarSetStatusString
  18 **/
  19 EFI_STATUS
  20 StatusBarInit (
  21   VOID
  22   );
  23
  24 /**
  25   Cleanup function for the status bar.
  26 **/
  27 VOID
  28 StatusBarCleanup (
  29   VOID
  30   );
  31
  32 /**
  33   Cause the status bar to refresh it's printing on the screen.
  34
  35   @param[in] EditorFirst      TRUE to indicate the first launch of the editor.
  36                               FALSE otherwise.
  37   @param[in] LastRow          LastPrintable row.
  38   @param[in] LastCol          Last printable column.
  39   @param[in] FileRow          Row in the file.
  40   @param[in] FileCol          Column in the file.
  41   @param[in] InsertMode       TRUE to indicate InsertMode.  FALSE otherwise.
  42
  43   @retval EFI_SUCCESS         The operation was successful.
  44 **/
  45 EFI_STATUS
  46 StatusBarRefresh (
  47   IN BOOLEAN  EditorFirst,
  48   IN UINTN    LastRow,
  49   IN UINTN    LastCol,
  50   IN UINTN    FileRow,
  51   IN UINTN    FileCol,
  52   IN BOOLEAN  InsertMode
  53   );
  54
  55 /**
  56   Set the status string text part.
  57
  58   @param[in] Str                The string to use.
  59
  60   @retval EFI_SUCCESS           The operation was successful.
  61   @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.
  62 **/
  63 EFI_STATUS
  64 StatusBarSetStatusString (
  65   IN CHAR16  *Str
  66   );
  67
  68 /**
  69   Function to retrieve the current status string.
  70
  71   @return The string that is used.
  72 **/
  73 CONST CHAR16 *
  74 StatusBarGetString (
  75   VOID
  76   );
  77
  78 /**
  79   Function to set the need refresh boolean to TRUE.
  80 **/
  81 VOID
  82 StatusBarSetRefresh (
  83   VOID
  84   );
  85
  86 /**
  87   Function to get the need refresh boolean to TRUE.
  88
  89   @retval TRUE    The status bar needs to be refreshed.
  90 **/
  91 BOOLEAN
  92 StatusBarGetRefresh (
  93   VOID
  94   );
  95
  96 #endif