summaryrefslogtreecommitdiffstats
path: root/doc/ttk_sizegrip.n
diff options
context:
space:
mode:
authorhobbs <hobbs>2006-12-13 23:04:32 (GMT)
committerhobbs <hobbs>2006-12-13 23:04:32 (GMT)
commitd4a63ee0259256e40eba77a360b9902afc472bc4 (patch)
tree128697b7c80828f4a3d31417bb432bc8eec88b00 /doc/ttk_sizegrip.n
parent318393c4af319ed15ef4a5d6e3f5b12259fe695d (diff)
downloadtk-d4a63ee0259256e40eba77a360b9902afc472bc4.zip
tk-d4a63ee0259256e40eba77a360b9902afc472bc4.tar.gz
tk-d4a63ee0259256e40eba77a360b9902afc472bc4.tar.bz2
* unix/Makefile.in (install-doc): intentionally skip ttk_dialog.n
installation (not for public consumption) * doc/scrollbar.n, doc/button.n, doc/checkbutton.n: * doc/entry.n, doc/frame.n, doc/label.n, doc/labelframe.n: * doc/menu.n, doc/menubutton.n, doc/panedwindow.n: * doc/radiobutton.n, doc/scrollbar.n, doc/ttk_*: revamp ttk docs to use consist nroff format (not 100% consistent with classic widget docs). Add more man page cross-linking "SEE ALSO".
Diffstat (limited to 'doc/ttk_sizegrip.n')
-rw-r--r--doc/ttk_sizegrip.n19
1 files changed, 15 insertions, 4 deletions
diff --git a/doc/ttk_sizegrip.n b/doc/ttk_sizegrip.n
index 505013c..41e9565 100644
--- a/doc/ttk_sizegrip.n
+++ b/doc/ttk_sizegrip.n
@@ -1,27 +1,35 @@
-'\" $Id: ttk_sizegrip.n,v 1.2 2006/11/15 13:29:17 dkf Exp $
'\"
'\" Copyright (c) 2006 Joe English
'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" RCS: @(#) $Id: ttk_sizegrip.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $
+'\"
.so man.macros
.TH ttk_sizegrip n 8.5 Tk "Tk Themed Widget"
.BS
+.\" Use _ instead of :: as the name becomes a filename on install
.SH NAME
-ttk::sizegrip \- A silly widget
+ttk_sizegrip \- Bottom-right corner resize widget
.SH SYNOPSIS
\fBttk::sizegrip\fR \fIpathName \fR?\fIoptions\fR?
.BE
+
.SH DESCRIPTION
-A \fBsizegrip\fR widget (also known as a \fIgrow box\fR)
+A \fBttk::sizegrip\fR widget (also known as a \fIgrow box\fR)
allows the user to resize the containing toplevel window
by pressing and dragging the grip.
.SO
\-class \-cursor \-state \-style
\-takefocus
.SE
+
.SH "WIDGET COMMAND"
Sizegrip widgets support the standard
\fBcget\fR, \fBconfigure\fR, \fBinstate\fR, and \fBstate\fR
methods. No other widget methods are used.
+
.SH "PLATFORM-SPECIFIC NOTES"
On Mac OSX, toplevel windows automatically include a built-in
size grip by default.
@@ -39,6 +47,7 @@ grid [ttk::sizegrip $top.statusbar.grip] \
# ... optional: add vertical scrollbar in $lastColumn,
# ... optional: add horizontal scrollbar in $lastRow
.CE
+
.SH "BUGS"
If the containing toplevel's position was specified
relative to the right or bottom of the sceen
@@ -47,7 +56,9 @@ instead of \fB[wm geometry ... \fIw\fBx\fIh\fB+\fIx\fB+\fIy\fB]\fR),
the sizegrip widget will not resize the window.
.PP
ttk::sizegrip widgets only support "southeast" resizing.
+
.SH "SEE ALSO"
-widget(n)
+ttk_widget(n)
+
.SH "KEYWORDS"
widget, sizegrip, grow box