add Edit and Hexedit shared features.

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / EditInputBar.h

diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/EditInputBar.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/EditInputBar.h
new file mode 100644 (file)
index 0000000..c8557a8
--- /dev/null
+++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/EditInputBar.h
@@ -0,0 +1,91 @@
+/** @file\r
+  Declares imputbar interface functions.\r
+\r
+  Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved. <BR>\r
+  This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
+\r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#ifndef _LIB_INPUT_BAR_H_\r
+#define _LIB_INPUT_BAR_H_\r
+\r
+/**\r
+  Initialize the input bar.\r
+**/\r
+VOID\r
+EFIAPI\r
+InputBarInit (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  Cleanup function for input bar.\r
+**/\r
+VOID\r
+EFIAPI\r
+InputBarCleanup (\r
+  VOID\r
+  );\r
+\r
+/**\r
+  The refresh function for InputBar, it will wait for user input\r
+\r
+  @param[in] LastRow            The last printable row.\r
+  @param[in] LastColumn         The last printable column.\r
+\r
+  @retval EFI_SUCCESS           The operation was successful.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InputBarRefresh (\r
+  UINTN LastRow,\r
+  UINTN LastColumn\r
+  );\r
+\r
+/**\r
+  SetPrompt and wait for input.\r
+\r
+  @param[in] Str                The prompt string.\r
+\r
+  @retval EFI_SUCCESS           The operation was successful.\r
+  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InputBarSetPrompt (\r
+  IN CONST CHAR16 *Str\r
+  );\r
+\r
+/**\r
+  Set the size of the string in characters.\r
+\r
+  @param[in] Size               The max number of characters to accept.\r
+\r
+  @retval EFI_SUCCESS           The operation was successful.\r
+  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InputBarSetStringSize (\r
+  UINTN   Size\r
+  );\r
+\r
+/**\r
+  Function to retrieve the input from the user.\r
+\r
+  @retval NULL                  No input has been received.\r
+  @return The string that was input.\r
+**/\r
+CONST CHAR16*\r
+EFIAPI\r
+InputBarGetString (\r
+  VOID\r
+  );\r
+\r
+#endif\r