ShellPkg: Update header file including style

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

/** @file\r
  Declares titlebar 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_TITLE_BAR_H_\r
#define _LIB_TITLE_BAR_H_\r
\r
/**\r
  Initialize a title bar.\r
\r
  @param[in] Prompt             The prompt to print in the title bar.\r
\r
  @retval EFI_SUCCESS           The initialization was successful.\r
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.\r
**/\r
EFI_STATUS\r
MainTitleBarInit (\r
  CONST CHAR16 *Prompt\r
  );\r
\r
/**\r
  Clean up the memory used.\r
**/\r
VOID\r
MainTitleBarCleanup (\r
  VOID\r
  );\r
\r
typedef enum {\r
  FileTypeNone,\r
  FileTypeAscii,\r
  FileTypeUnicode,\r
  FileTypeDiskBuffer,\r
  FileTypeMemBuffer,\r
  FileTypeFileBuffer\r
} EDIT_FILE_TYPE;\r
\r
/**\r
  Refresh function for MainTitleBar\r
\r
  @param[in] FileName           The open file's name (or NULL).\r
  @param[in] FileType           The type fo the file.\r
  @param[in] ReadOnly           TRUE if the file is read only.  FALSE otherwise.\r
  @param[in] Modified           TRUE if the file was modified.  FALSE otherwise.\r
  @param[in] LastCol            The last printable column.\r
  @param[in] LastRow            The last printable row.\r
  @param[in] Offset             The offset into the file. (only for mem/disk)\r
  @param[in] Size               The file's size. (only for mem/disk)\r
\r
  @retval EFI_SUCCESS           The operation was successful.\r
**/\r
EFI_STATUS\r
MainTitleBarRefresh (\r
  IN CONST CHAR16                 *FileName OPTIONAL,\r
  IN CONST EDIT_FILE_TYPE         FileType,\r
  IN CONST BOOLEAN                ReadOnly,\r
  IN CONST BOOLEAN                Modified,\r
  IN CONST UINTN                  LastCol,\r
  IN CONST UINTN                  LastRow,\r
  IN CONST UINTN                  Offset,\r
  IN CONST UINTN                  Size\r
  );\r
\r
#endif\r