aboutsummaryrefslogtreecommitdiff
path: root/gdb/doc/python.texi
diff options
context:
space:
mode:
authorHannes Domani <ssbssa@yahoo.de>2020-11-22 16:51:30 +0100
committerHannes Domani <ssbssa@yahoo.de>2021-05-27 20:42:42 +0200
commitbdef5723041368f3e264ac641360950c936b7ce4 (patch)
tree4fc4cc2d4b9acad73aed736b358a1c350b027fd4 /gdb/doc/python.texi
parentd5a6313e1c4c748a7e744514dbabfa001636f09a (diff)
downloadgdb-bdef5723041368f3e264ac641360950c936b7ce4.zip
gdb-bdef5723041368f3e264ac641360950c936b7ce4.tar.gz
gdb-bdef5723041368f3e264ac641360950c936b7ce4.tar.bz2
Add optional full_window argument to TuiWindow.write
To prevent flickering when first calling erase, then write, this new argument indicates that the passed string contains the full contents of the window. This fills every unused cell of the window with a space, so it's not necessary to call erase beforehand. gdb/ChangeLog: 2021-05-27 Hannes Domani <ssbssa@yahoo.de> * python/py-tui.c (tui_py_window::output): Add full_window argument. (gdbpy_tui_write): Parse "full_window" argument. gdb/doc/ChangeLog: 2021-05-27 Hannes Domani <ssbssa@yahoo.de> * python.texi (TUI Windows In Python): Document "full_window" argument.
Diffstat (limited to 'gdb/doc/python.texi')
-rw-r--r--gdb/doc/python.texi6
1 files changed, 5 insertions, 1 deletions
diff --git a/gdb/doc/python.texi b/gdb/doc/python.texi
index 9127b96..23e6ac6 100644
--- a/gdb/doc/python.texi
+++ b/gdb/doc/python.texi
@@ -5959,10 +5959,14 @@ displayed above the window. This attribute can be modified.
Remove all the contents of the window.
@end defun
-@defun TuiWindow.write (@var{string})
+@defun TuiWindow.write (@var{string} @r{[}, @var{full_window}@r{]})
Write @var{string} to the window. @var{string} can contain ANSI
terminal escape styling sequences; @value{GDBN} will translate these
as appropriate for the terminal.
+
+If the @var{full_window} parameter is @code{True}, then @var{string}
+contains the full contents of the window. This is similar to calling
+@code{erase} before @code{write}, but avoids the flickering.
@end defun
The factory function that you supply should return an object