The EFI_FORM_BROWSER2_PROTOCOL is the interface to call for drivers to \r
leverage the EFI configuration driver interface.\r
\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
- 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution. \r
+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 __EFI_FORM_BROWSER2_H__\r
#define __EFI_FORM_BROWSER2_H__\r
\r
+#include <Guid/HiiPlatformSetupFormset.h>\r
+\r
#define EFI_FORM_BROWSER2_PROTOCOL_GUID \\r
{0xb9d4c360, 0xbcfb, 0x4f9b, {0x92, 0x98, 0x53, 0xc1, 0x36, 0x98, 0x22, 0x58 }}\r
\r
\r
/**\r
\r
- @param LeftColumn Value that designates the text column\r
+ @param LeftColumn The value that designates the text column\r
where the browser window will begin from\r
the left-hand side of the screen\r
\r
- @param RightColumn Value that designates the text\r
+ @param RightColumn The value that designates the text\r
column where the browser window will end\r
on the right-hand side of the screen.\r
\r
- @param TopRow Value that designates the text row from the\r
+ @param TopRow The value that designates the text row from the\r
top of the screen where the browser window\r
will start.\r
\r
- @param BottomRow Value that designates the text row from the\r
+ @param BottomRow The value that designates the text row from the\r
bottom of the screen where the browser\r
window will end. \r
**/\r
\r
\r
/**\r
+ Initialize the browser to display the specified configuration forms.\r
+\r
This function is the primary interface to the internal forms-based browser. \r
The forms browser will display forms associated with the specified Handles. \r
The browser will select all forms in packages which have the specified Type \r
@param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL instance\r
\r
@param Handles A pointer to an array of Handles. This value should correspond \r
- to the value of the HII form package that is required to be displayed. Type\r
+ to the value of the HII form package that is required to be displayed.\r
\r
@param HandleCount The number of Handles specified in Handle.\r
\r
- @param FormSetGuid This field points to the EFI_GUID which must match the Guid\r
- field in the EFI_IFR_FORM_SET op-code for the specified\r
- forms-based package. If FormSetGuid is NULL, then this\r
- function will display the first found forms package.\r
+ @param FormSetGuid This field points to the EFI_GUID which must match the Guid field or one of the\r
+ elements of the ClassId field in the EFI_IFR_FORM_SET op-code. If\r
+ FormsetGuid is NULL, then this function will display the the form set class\r
+ EFI_HII_PLATFORM_SETUP_FORMSET_GUID.\r
\r
- @param FormId This field specifies which EFI_IFR_FORM to render as the first\r
- displayable page. If this field has a value of 0x0000, then\r
- the forms browser will render the specified forms in their encoded order.\r
+ @param FormId This field specifies the identifier of the form within the form set to render as the first\r
+ displayable page. If this field has a value of 0x0000, then the Forms Browser will\r
+ render the first enabled form in the form set.\r
\r
@param ScreenDimensions Points to recommended form dimensions, including any non-content area, in \r
characters.\r
\r
\r
/**\r
- \r
+ This function is called by a callback handler to retrieve uncommitted state data from the browser.\r
+\r
This routine is called by a routine which was called by the\r
browser. This routine called this service in the browser to\r
retrieve or set certain uncommitted state information.\r
\r
@param ResultsDataSize A pointer to the size of the buffer\r
associated with ResultsData. On input, the size in\r
- bytes of ResultsData. On output, the size of data returned in ResultsData.\r
+ bytes of ResultsData. On output, the size of data \r
+ returned in ResultsData.\r
\r
@param ResultsData A string returned from an IFR browser or\r
equivalent. The results string will have\r
IN CONST CHAR16 *VariableName OPTIONAL\r
);\r
\r
-/**\r
- @par Protocol Description: \r
- This interface will allow the caller to direct the configuration \r
- driver to use either the HII database or use the passed-in packet of data.\r
-\r
- @param SendForm Browse the specified configuration forms.\r
-\r
- @param BrowserCallback Routine used to expose internal\r
- configuration state of the browser.\r
- This is primarily used by callback\r
- handler routines which were called by\r
- the browser and in-turn need to get\r
- additional information from the\r
- browser itself.\r
-\r
-**/\r
+///\r
+/// This interface will allow the caller to direct the configuration \r
+/// driver to use either the HII database or use the passed-in packet of data.\r
+///\r
struct _EFI_FORM_BROWSER2_PROTOCOL {\r
EFI_SEND_FORM2 SendForm;\r
EFI_BROWSER_CALLBACK2 BrowserCallback;\r
} ;\r
\r
-\r
extern EFI_GUID gEfiFormBrowser2ProtocolGuid;\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff