Diff: TextDisplay.h

Revision:

198:9b6851107426

Parent:

182:8832d03a2a29

--- a/TextDisplay.h	Tue Feb 11 21:51:42 2020 +0000
+++ b/TextDisplay.h	Sat Mar 28 15:01:38 2020 +0000
@@ -31,7 +31,8 @@
     // functions needing implementation in derived implementation class
     /// Create a TextDisplay interface
     ///
-    /// @param name The name used in the path to access the display through 
+    /// @param name The name used in the path to access the display through
+
     ///     the stdio stream.
     ///
     TextDisplay(const char *name = NULL);
@@ -57,7 +58,8 @@
     ///
     /// @note this method may be overridden in a derived class.
     ///
-    /// @returns number of text rows for the display for the currently 
+    /// @returns number of text rows for the display for the currently
+
     ///     active font.
     ///
     virtual int rows() = 0;
@@ -86,12 +88,14 @@
     ///
     /// @note this method may be overridden in a derived class.
     ///
-    /// @param[in] layers is ignored, but supports maintaining the same 
+    /// @param[in] layers is ignored, but supports maintaining the same
+
     ///     API for the graphics layer.
     /// @returns @ref RetCode_t value.
     ///
     virtual RetCode_t cls(uint16_t layers = 0) = 0;
-    
+   
+
     /// locate the cursor at a character position.
     ///
     /// Based on the currently active font, locate the cursor on screen.
@@ -100,27 +104,28 @@
     ///
     /// @param[in] column is the horizontal offset from the left side.
     /// @param[in] row is the vertical offset from the top.
-    /// @returns @ref RetCode_t value.
+    /// @returns @ref point_t value that was the last location.
     ///
-    virtual RetCode_t locate(textloc_t column, textloc_t row) = 0;
-    
+    virtual point_t locate(textloc_t column, textloc_t row) = 0;
+   
+
     /// set the foreground color
     ///
     /// @note this method may be overridden in a derived class.
     ///
     /// @param[in] color is color to use for foreground drawing.
-    /// @returns @ref RetCode_t value.
+    /// @returns @ref color_t value that was the previous color.
     ///
-    virtual RetCode_t foreground(color_t color) = 0;
+    virtual color_t foreground(color_t color) = 0;
 
     /// set the background color
     ///
     /// @note this method may be overridden in a derived class.
     ///
     /// @param[in] color is color to use for background drawing.
-    /// @returns @ref RetCode_t value.
+    /// @returns @ref color_t value that was the previous color.
     ///
-    virtual RetCode_t background(color_t color) = 0;
+    virtual color_t background(color_t color) = 0;
     // putc (from Stream)
     // printf (from Stream)
 
@@ -131,9 +136,11 @@
     /// @returns the character that was sent.
     ///
     virtual int _putc(int value);
-    
+   
+
     /// a method to get a character from the stdin
-    /// 
+    ///
+
     /// @returns the fetched character.
     ///
     virtual int _getc();