Console - Revision history

Tectu: /* API reference */

2016-02-04T15:46:33Z

‎API reference

Tectu at 15:46, 4 February 2016

2016-02-04T15:46:05Z

Tectu at 15:45, 4 February 2016

2016-02-04T15:45:49Z

Tectu at 21:27, 5 July 2015

2015-07-05T21:27:43Z

Tectu: /* API reference */

2015-02-14T00:08:49Z

‎API reference

Inmarket: /* Float */

2014-08-16T05:34:05Z

‎Float

Inmarket: /* Scrolling */

2014-08-16T05:32:38Z

‎Scrolling

Tectu at 11:22, 5 July 2014

2014-07-05T11:22:46Z

Tectu: /* Escape sequences */

2014-07-01T19:21:58Z

‎Escape sequences

Tectu: /* Escape sequences */

2014-07-01T19:20:30Z

‎Escape sequences

@@ Line 2: / Line 2: @@
 == API reference ==
-The API reference of the console window can be found [http://api.ugfx.org/master/group___console.html here].
+The API reference of the console window can be found [http://api.ugfx.org/group___console.html here].
 == Scrolling ==

@@ Line 1: / Line 1: @@
 The console widget is a rectangular window with a fore- and background color. The console widget currently doesn't accept any input and can only output text using <code>gwinPrintf()</code>. The widget is capable of handling line breaks when the text reaches the end of the window and it can also handle text scrolling when you insert new lines at the bottom when the window is already filled.
 == Scrolling ==
@@ Line 47: / Line 50: @@
   |}
 An escape sequence is introduced by '''\033'''. Please refer to the example below to see how to use the escape sequences properly.
 == Example ==

← Older revision		Revision as of 15:45, 4 February 2016
Line 1:		Line 1:
−	The console widget is a rectangular window with a fore- and background color. The widget ~~does~~ currently ~~not~~ accept any input and can only output text using <code>gwinPrintf()</code>. The widget is capable of handling line breaks when the text reaches the end of the window and it can also handle text scrolling when you insert new lines at the bottom when the window is already filled.	+	The console widget is a rectangular window with a fore- and background color. The console widget currently doesn't accept any input and can only output text using <code>gwinPrintf()</code>. The widget is capable of handling line breaks when the text reaches the end of the window and it can also handle text scrolling when you insert new lines at the bottom when the window is already filled.

	== Scrolling ==		== Scrolling ==

@@ Line 16: / Line 16: @@
 == Buffer size ==
 The buffer size will be automatically allocated by the console widget once <code>gwinConsoleSetBuffer()</code> is being called to enable the history. It's crucial to get the correct buffer size (enough to hold the correct content but not too much in order to save memory) to prevent false behavior. Therefore, it's not possible to submit a customs sized buffer.
 == Escape sequences ==

@@ Line 50: / Line 50: @@
 == API reference ==
-The API reference of the console window can be found [http://ugfx.org/images/resources/doxygen/master/group___console.html here].
+The API reference of the console window can be found [http://api.ugfx.org/master/group___console.html here].
 == Example ==

@@ Line 6: / Line 6: @@
 == Float ==
-The console is capable of printing float values through <code>gwinPrintf()</code> when <code>GWIN_CONSOLE_USE_FLOAT</code> is set to ''TRUE'' in your [[gfxconf.h]]. Note that this feature requires a lot of memory and CPU time.
+The console is capable of printing float values through <code>gwinPrintf()</code> when <code>GWIN_CONSOLE_USE_FLOAT</code> is set to ''TRUE'' in your [[gfxconf.h]]. Note float operations may be slow if your CPU does not support floating arithmetic.
 == History ==

@@ Line 9: / Line 9: @@
 == History ==
 In its bare state, the console does not keep track of its content. This means that making the console invisible using <code>gwinSetVisible()</code> will lose all the content that has previously written to it - it will simply be empty once it becomes visible again. Everything that gets written to the console during the invisible state is also lost.
-To enable the history feature which prevents this behaviour, set <code>GWIN_CONSOLE_USE_HISTORY</code> to ''TRUE'' in your [[gfxconf.h]]. The API call <code>gwinConsoleSetBuffer()</code> is now available to enable or disable the history at any time. The console will automatically allocate the required buffer depending on it's window size. Once the history is disabled again, the buffer will be deallocated.
+To enable the history feature which prevents this behavior, set <code>GWIN_CONSOLE_USE_HISTORY</code> to ''TRUE'' in your [[gfxconf.h]]. The API call <code>gwinConsoleSetBuffer()</code> is now available to enable or disable the history at any time. The console will automatically allocate the required buffer depending on it's window size. Once the history is disabled again, the buffer will be deallocated.
 Alternatively, you can also set <code>GWIN_CONSOLE_HISTORY_ATCREATE</code> to ''TRUE''. Every console widget will then automatically turn on the history feature when it's being created.
 == Buffer size ==
-The buffer size will be automatically allocated by the console widget once <code>gwinConsoleSetBuffer()</code> is being called to enable the history. It's crucial to get the correct buffer size (enough to hold the correct content but not too much in order to save memory) to prevent false behaviour. Therefore, it's not possible to submit a customs sized buffer.
+The buffer size will be automatically allocated by the console widget once <code>gwinConsoleSetBuffer()</code> is being called to enable the history. It's crucial to get the correct buffer size (enough to hold the correct content but not too much in order to save memory) to prevent false behavior. Therefore, it's not possible to submit a customs sized buffer.

@@ Line 25: / Line 25: @@
   |-
   |ESC color
-  |Change subsequent text color
+  |Change subsequent text color <br/>color: 0 = black, 1 = red, 2 = green, 3 = yellow, 4 = blue, 5 = magenta, 6 = cyan, 7 = white
- |color: 0 = black, 1 = red, 2 = green, 3 = yellow, 4 = blue, 5 = magenta, 6 = cyan, 7 = white
   |-
   |ESC C

@@ Line 20: / Line 20: @@
 One major problem that comes with the history buffer is that the font color does not get stored. As we have to use as little RAM as possible, we cannot add a color attribute to each character. Setting a color per line would also be a very limiting feature. To workaround the problem, escape sequences have been introduced to the console widget. These capabilities can be enabled by setting <code>GWIN_CONSOLE_ESCSEQ</code> to ''TRUE''. There are escape sequences to control the color and the format of the text:
-Escape	Description
+{| class="wikitable"
-ESC color
+ ! scope="col"|Escape
-Change subsequent text color
+ ! scope="col"|Description"
-color: 0 = black, 1 = red, 2 = green, 3 = yellow, 4 = blue, 5 = magenta, 6 = cyan, 7 = white
+ |-
+ |ESC color
-ESC C	Revert subsequent text color to the window default
+ |Change subsequent text color
-ESC u	Turn on underline
+ |color: 0 = black, 1 = red, 2 = green, 3 = yellow, 4 = blue, 5 = magenta, 6 = cyan, 7 = white
-ESC U	Turn off underline
+ |-
-ESC b	Turn on bold
+ |ESC C
-ESC B	Turn off bold
+ |Revert subsequent text color to the window default
-ESC J	Clear the window
+ |-
-  An escape sequence is introduced by \033. Please refer to the example below to see how to use the escape sequences properly.
+ |ESC u
 == API reference ==