diff options
author | Kevin Walzer <kw@codebykevin.com> | 2020-10-13 00:33:31 (GMT) |
---|---|---|
committer | Kevin Walzer <kw@codebykevin.com> | 2020-10-13 00:33:31 (GMT) |
commit | a07afff2454b8d612cbd0691430ed92fed82048d (patch) | |
tree | ccbfdb6bfc652d73894c8b18205c6a370bba83d4 /doc/systray.n | |
parent | e72f81da0ea9797c272f2cf6e65af3a7d6d076e2 (diff) | |
parent | cb3a0ab0484b6747c2055c04530979b75363ca54 (diff) | |
download | tk-a07afff2454b8d612cbd0691430ed92fed82048d.zip tk-a07afff2454b8d612cbd0691430ed92fed82048d.tar.gz tk-a07afff2454b8d612cbd0691430ed92fed82048d.tar.bz2 |
Successful integration of systray and sysnotify commands with tk ensemble; thanks to Christian Gollwitzer for the guidance here
Diffstat (limited to 'doc/systray.n')
-rw-r--r-- | doc/systray.n | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/systray.n b/doc/systray.n index f18d3e7..192cf2d 100644 --- a/doc/systray.n +++ b/doc/systray.n @@ -5,47 +5,47 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -.TH systray n "" Tk "Tk Built-In Commands" +.TH tk systray n "" Tk "Tk Built-In Commands" .so man.macros .SH NAME systray \- Creates an icon display in the platform-specific system tray. .SH SYNOPSIS -\fBsystray create\fP \fIimage\fP? \fItext\fP? \fIcallback\fR? +\fBtk systray create\fP \fIimage\fP? \fItext\fP? \fIcallback\fR? .sp -\fBsystray modify image\fI image\fR? +\fBtk systray modify image\fI image\fR? .sp -\fBsystray modify text \fI text\fR? +\fBtk systray modify text \fI text\fR? .sp -\fBsystray modify callback \fIcallback\fR? +\fBtk systray modify callback \fIcallback\fR? .sp -\fBsystray destroy\fR +\fBtk systray destroy\fR .BE .BE .SH DESCRIPTION .PP -The \fBsystray\fP command creates an icon in the platform-specific tray. +The \fBtk systray\fP command creates an icon in the platform-specific tray. The widget is configured with a Tk image for the icon display, a string for display in a tooltip, and a callback is bound to <Button-1>. .SH EXAMPLE .PP -Here is an example of the \fBsystray\fP code: +Here is an example of the \fBtk systray\fP code: .CS image create photo book -data R0lGODlhDwAPAKIAAP//////AP8AAMDAwICAgAAAAAAAAAAAACwAAAAADwAPAAADSQhA2u5ksPeKABKSCaya29d4WKgERFF0l1IMQCAKatvBJ0OTdzzXI1xMB3TBZAvATtB6NSLKleXi3OBoLqrVgc0yv+DVSEUuFxIAOw== - systray create book "Systray sample" {puts "Here is the systray output"} + tk systray create book "tk systray sample" {puts "Here is the tk systray output"} .CE .PP -Here is an example of modifying the \fBsystray\fP icon: +Here is an example of modifying the \fBtk systray\fP icon: .CS image create book_page -data R0lGODlhCwAPAKIAAP//////AMDAwICAgAAA/wAAAAAAAAAAACwAAAAACwAPAAADMzi6CzAugiAgDGE68aB0RXgRJBFVX0SNpQlUWfahQOvSsgrX7eZJMlQMWBEYj8iQchlKAAA7 - systray modify image book_page - systray modify text "Updated sample" - systray modify callback {puts "Different output from the systray"} + tk systray modify image book_page + tk systray modify text "Updated sample" + tk systray modify callback {puts "Different output from the tk systray"} .CE .PP - The \fBsystray\fP destroy command removes the icon from display and + The \fBtk systray\fP destroy command removes the icon from display and deallocates it. .PP -From a user-interface standpoint, only one systray icon per interpreter +From a user-interface standpoint, only one icon per interpreter should be displayed, although it can be modified with different images and strings to indicate app state. Loading additional interpreters into a running instance of Wish will allow additional icons to be displayed. |