ShellPkg/Library/UefiShellDebug1CommandsLib/EditStatusBar.h

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