Merged in the following trackers from EDK:

[mirror_edk2.git] / MdePkg / Include / Protocol / HiiFont.h

diff --git a/MdePkg/Include/Protocol/HiiFont.h b/MdePkg/Include/Protocol/HiiFont.h
index df9bbac93fc82192bb78486d7fd6997ebb50418a..a4e56b278aa616dfababd75bdc425c731e4213d8 100644 (file)
--- a/MdePkg/Include/Protocol/HiiFont.h
+++ b/MdePkg/Include/Protocol/HiiFont.h
@@ -1,7 +1,7 @@
 /** @file\r
   The file provides services to retrieve font information.\r
   \r
-  Copyright (c) 2006 - 2007, Intel Corporation\r
+  Copyright (c) 2006 - 2008, Intel Corporation\r
   All rights reserved. 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
@@ -31,8 +31,8 @@ typedef VOID    *EFI_FONT_HANDLE;
 typedef UINT32  EFI_HII_OUT_FLAGS;\r
 #define EFI_HII_OUT_FLAG_CLIP         0x00000001\r
 #define EFI_HII_OUT_FLAG_WRAP         0x00000002\r
-#define EFI_HII_OUT_FLAG_CLEAN_Y      0x00000004\r
-#define EFI_HII_OUT_FLAG_CLEAN_X      0x00000008\r
+#define EFI_HII_OUT_FLAG_CLIP_CLEAN_Y 0x00000004\r
+#define EFI_HII_OUT_FLAG_CLIP_CLEAN_X 0x00000008\r
 #define EFI_HII_OUT_FLAG_TRANSPARENT  0x00000010\r
 #define EFI_HII_IGNORE_IF_NO_GLYPH    0x00000020\r
 #define EFI_HII_IGNORE_LINE_BREAK     0x00000040\r
@@ -87,9 +87,9 @@ typedef UINT32  EFI_FONT_INFO_MASK;
 // EFI_FONT_INFO\r
 // \r
 typedef struct {\r
-  UINT32  FontStyle;\r
-  UINT16  FontSize;\r
-  CHAR16  FontName[1];\r
+  EFI_HII_FONT_STYLE FontStyle;\r
+  UINT16             FontSize; // character cell height in pixels\r
+  CHAR16             FontName[1];\r
 } EFI_FONT_INFO;\r
 \r
 /**\r
@@ -253,10 +253,9 @@ typedef struct _EFI_FONT_DISPLAY_INFO {
   @retval EFI_OUT_OF_RESOURCES  Unable to allocate an output\r
                                 buffer for RowInfoArray or Blt.\r
   \r
-  @retval EFI_INVALID_PARAMETER The String or Blt or Height or\r
-                                Width was NULL.\r
+  @retval EFI_INVALID_PARAMETER The String or Blt.\r
+  @retval EFI_INVALID_PARAMETER Flags were invalid combination..\r
 \r
-  \r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -388,6 +387,10 @@ EFI_STATUS
 \r
   @retval EFI_INVALID_PARAMETER The String or Blt or Height or\r
                                 Width was NULL.\r
+  @retval EFI_INVALID_PARAMETER The Blt or PackageList was NULL.\r
+  @retval EFI_INVALID_PARAMETER  Flags were invalid combination.\r
+  @retval EFI_NOT_FOUND   The specified PackageList is not in the Database or the stringid is not \r
+                        in the specified PackageList. \r
 \r
 **/\r
 typedef\r
@@ -469,7 +472,8 @@ EFI_STATUS
                     to NULL if there are no more matching fonts.\r
 \r
   @param StringInfoIn Upon entry, points to the font to return\r
-                      information about.\r
+                      information about. If NULL, then the information about the system default \r
+                      font will be returned.\r
 \r
   @param StringInfoOut  Upon return, contains the matching\r
                         font's information. If NULL, then no\r
@@ -483,8 +487,9 @@ EFI_STATUS
   \r
   @retval EFI_NOT_FOUND No matching font was found.\r
   \r
-  @retval EFI_INVALID_PARAMETER FontHandle is NULL or\r
-                                StringInfoIn is NULL\r
+  @retval EFI_INVALID_PARAMETER  StringInfoIn->FontInfoMask is an invalid combination.\r
+\r
+  @retval EFI_OUT_OF_RESOURCES   There were insufficient resources to complete the request.\r
   \r
 **/\r
 typedef\r
@@ -492,7 +497,7 @@ EFI_STATUS
 (EFIAPI *EFI_HII_GET_FONT_INFO) (\r
   IN CONST  EFI_HII_FONT_PROTOCOL *This,\r
   IN OUT    EFI_FONT_HANDLE       *FontHandle,\r
-  IN CONST  EFI_FONT_DISPLAY_INFO *StringInfoIn,\r
+  IN CONST  EFI_FONT_DISPLAY_INFO *StringInfoIn, OPTIONAL\r
   OUT       EFI_FONT_DISPLAY_INFO **StringInfoOut,\r
   IN CONST  EFI_STRING            String OPTIONAL\r
 );\r