summaryrefslogtreecommitdiffstats
path: root/tcllib/modules/virtchannel_base/textwindow.man
diff options
context:
space:
mode:
Diffstat (limited to 'tcllib/modules/virtchannel_base/textwindow.man')
-rw-r--r--tcllib/modules/virtchannel_base/textwindow.man39
1 files changed, 39 insertions, 0 deletions
diff --git a/tcllib/modules/virtchannel_base/textwindow.man b/tcllib/modules/virtchannel_base/textwindow.man
new file mode 100644
index 0000000..f3c3084
--- /dev/null
+++ b/tcllib/modules/virtchannel_base/textwindow.man
@@ -0,0 +1,39 @@
+[comment {-*- tcl -*- doctools manpage}]
+[manpage_begin tcl::chan::textwindow n 1]
+[keywords {reflected channel}]
+[keywords {text widget}]
+[keywords {tip 219}]
+[keywords Tk]
+[keywords {virtual channel}]
+[copyright {2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
+[moddesc {Reflected/virtual channel support}]
+[category Channels]
+[titledesc {Textwindow channel}]
+[require Tcl 8.5]
+[require TclOO]
+[require tcl::chan::events [opt 1]]
+[require tcl::chan::textwindow [opt 1]]
+[description]
+[para]
+
+The [package tcl::chan::textwindow] package provides a command creating
+write-only channels connected to text widgets. Anything written to the
+channel is printed into the associated widget.
+
+[para] The internal [package TclOO] class implementing the channel
+handler is a sub-class of the [package tcl::chan::events] framework.
+
+[section API]
+
+[list_begin definitions]
+
+[call [cmd ::tcl::chan::textwindow] [arg widget]]
+
+This command creates a new textwindow channel and returns its handle.
+Data written to this channel will appear in the associated [arg widget].
+
+[list_end]
+
+[vset CATEGORY virtchannel]
+[include ../doctools2base/include/feedback.inc]
+[manpage_end]