summaryrefslogtreecommitdiffstats
path: root/doc/wm.n
diff options
context:
space:
mode:
authorhobbs <hobbs>2004-10-05 22:04:42 (GMT)
committerhobbs <hobbs>2004-10-05 22:04:42 (GMT)
commitf2f61eac6e4030eb8c326fb3f24e9a78d57dc22a (patch)
tree711905ead95768432f1777f0620b4b4b9b9a029d /doc/wm.n
parentbdbbd44f5ecfdef44242a059886d3ee31a840af3 (diff)
downloadtk-f2f61eac6e4030eb8c326fb3f24e9a78d57dc22a.zip
tk-f2f61eac6e4030eb8c326fb3f24e9a78d57dc22a.tar.gz
tk-f2f61eac6e4030eb8c326fb3f24e9a78d57dc22a.tar.bz2
* doc/wm.n (iconphoto): added support for Tk photo
* generic/tkInt.h (TkDisplay): images as titlebar icons. TIP #159 * win/tkWinWm.c (WmIconphotoCmd): wm iconphoto ?-default? image1 ... * macosx/tkMacOSXWm.c (WmIconphotoCmd): Implemented for Win/Unix, * unix/tkUnixWm.c (WmIconphotoCmd): stubbed out for OS X. * tests/wm.test, tests/unixWm.test, tests/winWm.test: [Bug 815751]
Diffstat (limited to 'doc/wm.n')
-rw-r--r--doc/wm.n24
1 files changed, 23 insertions, 1 deletions
diff --git a/doc/wm.n b/doc/wm.n
index f31e95d..e479679 100644
--- a/doc/wm.n
+++ b/doc/wm.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: wm.n,v 1.16 2004/09/28 18:54:37 hobbs Exp $
+'\" RCS: @(#) $Id: wm.n,v 1.17 2004/10/05 22:04:44 hobbs Exp $
'\"
.so man.macros
.TH wm n 8.5 Tk "Tk Built-In Commands"
@@ -279,6 +279,28 @@ then the command returns the current icon name for \fIwindow\fR,
or an empty string if no icon name has been specified (in this
case the window manager will normally display the window's title,
as specified with the \fBwm title\fR command).
+.VS 8.5
+.TP
+\fBwm iconphoto \fIwindow\fR ?\fI-default\fR? \fIimage1\fR ?\fIimage2 ...\fR?
+.RS
+Sets the titlebar icon for \fIwindow\fR based on the named photo images.
+If \fI-default\fR is specified, this is applied to all future created
+toplevels as well. The data in the images is taken as a snapshot at the
+time of invocation. If the images are later changed, this is not
+reflected to the titlebar icons. Multiple images are accepted to allow
+different images sizes (eg, 16x16 and 32x32) to be provided.
+.PP
+On Windows, the images are packed into a Windows icon structure.
+This will override an ico specified to \fBwm iconbitmap\fR, and
+vice versa.
+.PP
+On X, the images are arranged into the _NET_WM_ICON X property, which
+most modern window managers support. A \fBwm iconbitmap\fR may exist
+simultaneously.
+.PP
+On Macintosh, this is currently does nothing.
+.VE 8.5
+.RE
.TP
\fBwm iconposition \fIwindow\fR ?\fIx y\fR?
If \fIx\fR and \fIy\fR are specified, they are passed to the window