diff options
| author | Joel Bodenmann <joel@unormal.org> | 2012-12-21 15:21:25 +0100 |
|---|---|---|
| committer | Joel Bodenmann <joel@unormal.org> | 2012-12-21 15:21:25 +0100 |
| commit | b75f69d7a0640948b7d1e588ae2c041073a17b97 (patch) | |
| tree | e63e65ce7f9a75a4155ab297807de67261365e71 /include | |
| parent | b6a8a15536b450049a4985d36825317b633af6b1 (diff) | |
| download | uGFX-b75f69d7a0640948b7d1e588ae2c041073a17b97.tar.gz uGFX-b75f69d7a0640948b7d1e588ae2c041073a17b97.tar.bz2 uGFX-b75f69d7a0640948b7d1e588ae2c041073a17b97.zip | |
more update
Diffstat (limited to 'include')
| -rw-r--r-- | include/gwin/console.h | 68 |
1 files changed, 63 insertions, 5 deletions
diff --git a/include/gwin/console.h b/include/gwin/console.h index 9fa867c8..30058b2b 100644 --- a/include/gwin/console.h +++ b/include/gwin/console.h @@ -70,11 +70,69 @@ typedef struct GConsoleObject_t { extern "C" {
#endif
- GHandle gwinCreateConsole(GConsoleObject *gc, coord_t x, coord_t y, coord_t width, coord_t height, font_t font);
- BaseSequentialStream *gwinGetConsoleStream(GHandle gh);
- void gwinPutChar(GHandle gh, char c);
- void gwinPutString(GHandle gh, const char *str);
- void gwinPutCharArray(GHandle gh, const char *str, size_t n);
+/**
+ * @brief Create a console window.
+ * @details A console window allows text to be written using chprintf() (and the console functions defined here).
+ * @brief Text in a console window supports newlines and will wrap text as required.
+ * @return NULL if there is no resultant drawing area, otherwise a window handle.
+ *
+ * @param[in] gc The GConsoleObject structure to initialise. If this is NULL the structure is dynamically allocated.
+ * @param[in] x,y The screen co-ordinates for the bottom left corner of the window
+ * @param[in] width The width of the window
+ * @param[in] height The height of the window
+ * @param[in] font The font to use
+ * @note The console is not automatically cleared on creation. You must do that by calling gwinClear() (possibly after changing your background color)
+ * @note If the dispay does not support scrolling, the window will be cleared when the bottom line is reached.
+ * @note The default drawing color gets set to White and the background drawing color to Black.
+ * @note The dimensions and position may be changed to fit on the real screen.
+ *
+ * @api
+ */
+GHandle gwinCreateConsole(GConsoleObject *gc, coord_t x, coord_t y, coord_t width, coord_t height, font_t font);
+
+/**
+ * @brief Get a stream from a console window suitable for use with chprintf().
+ * @return The stream handle or NULL if this is not a console window.
+ *
+ * @param[in] gh The window handle (must be a console window)
+ *
+ * @api
+ */
+BaseSequentialStream *gwinGetConsoleStream(GHandle gh);
+
+/**
+ * @brief Put a character at the cursor position in the window.
+ * @note Uses the current foreground color to draw the character and fills the background using the background drawing color
+ *
+ * @param[in] gh The window handle (must be a console window)
+ * @param[in] c The character to draw
+ *
+ * @api
+ */
+void gwinPutChar(GHandle gh, char c);
+
+/**
+ * @brief Put a string at the cursor position in the window. It will wrap lines as required.
+ * @note Uses the current foreground color to draw the string and fills the background using the background drawing color
+ *
+ * @param[in] gh The window handle (must be a console window)
+ * @param[in] str The string to draw
+ *
+ * @api
+ */
+void gwinPutString(GHandle gh, const char *str);
+
+/**
+ * @brief Put the character array at the cursor position in the window. It will wrap lines as required.
+ * @note Uses the current foreground color to draw the string and fills the background using the background drawing color
+ *
+ * @param[in] gh The window handle (must be a console window)
+ * @param[in] str The string to draw
+ * @param[in] n The number of characters to draw
+ *
+ * @api
+ */
+void gwinPutCharArray(GHandle gh, const char *str, size_t n);
#ifdef __cplusplus
}
|