\r
Abstraction of a very simple text based output device like VGA text mode or\r
a serial terminal. The Simple Text Out protocol instance can represent\r
- a single hardware device or a virtual device that is an agregation\r
+ a single hardware device or a virtual device that is an aggregation\r
of multiple physical devices.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation \r
\r
//\r
// We currently define attributes from 0 - 7F for color manipulations\r
-// To internally handle the local display characteristics for a particular character, we are defining\r
-// Bit 7 to signify the local glyph representation for a character. If turned on, glyphs will be\r
+// To internally handle the local display characteristics for a particular character, \r
+// Bit 7 signifies the local glyph representation for a character. If turned on, glyphs will be\r
// pulled from the wide glyph database and will display locally as a wide character (16 X 19 versus 8 X 19)\r
// If bit 7 is off, the narrow glyph database will be used. This does NOT affect information that is sent to\r
-// non-local displays (e.g. serial or LAN consoles).\r
+// non-local displays, such as serial or LAN consoles.\r
//\r
#define EFI_WIDE_ATTRIBUTE 0x80\r
\r
and must be zero. The valid Attributes are defined in this file.\r
\r
@retval EFI_SUCCESS The attribute was set.\r
- @retval EFI_DEVICE_ ERROR The device had an error and could not complete the request.\r
+ @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.\r
@retval EFI_UNSUPPORTED The attribute requested is not defined.\r
\r
**/\r
/**\r
@par Data Structure Description:\r
Mode Structure pointed to by Simple Text Out protocol.\r
-\r
- @param MaxMode\r
- The number of modes supported by QueryMode () and SetMode ().\r
- \r
- @param Mode\r
- The text mode of the output device(s).\r
- \r
- @param Attribute\r
- The current character output attribute\r
- \r
- @param CursorColumn\r
- The cursor's column.\r
- \r
- @param CursorRow\r
- The cursor's row.\r
- \r
- @param CursorVisible\r
- The cursor is currently visbile or not.\r
-\r
**/\r
typedef struct {\r
+///\r
+/// The number of modes supported by QueryMode () and SetMode ().\r
+///\r
INT32 MaxMode;\r
\r
//\r
// current settings\r
//\r
+\r
+///\r
+/// The text mode of the output device(s).\r
+///\r
INT32 Mode;\r
+\r
+///\r
+/// The current character output attribute\r
+///\r
INT32 Attribute;\r
+///\r
+/// The cursor's column.\r
+///\r
INT32 CursorColumn;\r
+///\r
+/// The cursor's row.\r
+///\r
INT32 CursorRow;\r
+///\r
+/// The cursor is currently visbile or not.\r
+///\r
BOOLEAN CursorVisible;\r
} EFI_SIMPLE_TEXT_OUTPUT_MODE;\r
\r
-/** \r
- @par Protocol Description:\r
- The SIMPLE_TEXT_OUTPUT protocol is used to control text-based output devices. \r
- It is the minimum required protocol for any handle supplied as the ConsoleOut \r
- or StandardError device. In addition, the minimum supported text mode of such \r
- devices is at least 80 x 25 characters.\r
-\r
- @param Reset\r
- Reset the ConsoleOut device. \r
-\r
- @param OutputString\r
- Displays the Unicode string on the device at the current cursor location. \r
-\r
- @param TestString\r
- Tests to see if the ConsoleOut device supports this Unicode string.\r
-\r
- @param QueryMode\r
- Queries information concerning the output device's supported text mode. \r
-\r
- @param SetMode\r
- Sets the current mode of the output device. \r
-\r
- @param SetAttribute\r
- Sets the foreground and background color of the text that is output. \r
-\r
- @param ClearScreen\r
- Clears the screen with the currently set background color. \r
-\r
- @param SetCursorPosition\r
- Sets the current cursor position. \r
-\r
- @param EnableCursor\r
- Turns the visibility of the cursor on/off. \r
-\r
- @param Mode\r
- Pointer to SIMPLE_TEXT_OUTPUT_MODE data. \r
-**/\r
+///\r
+/// The SIMPLE_TEXT_OUTPUT protocol is used to control text-based output devices. \r
+/// It is the minimum required protocol for any handle supplied as the ConsoleOut \r
+/// or StandardError device. In addition, the minimum supported text mode of such \r
+/// devices is at least 80 x 25 characters.\r
+///\r
struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL {\r
EFI_TEXT_RESET Reset;\r
\r
EFI_TEXT_SET_CURSOR_POSITION SetCursorPosition;\r
EFI_TEXT_ENABLE_CURSOR EnableCursor;\r
\r
- //\r
- // Current mode\r
- //\r
+ ///\r
+ /// Pointer to SIMPLE_TEXT_OUTPUT_MODE data.\r
+ ///\r
EFI_SIMPLE_TEXT_OUTPUT_MODE *Mode;\r
};\r
\r