summaryrefslogtreecommitdiffstats
path: root/doc/ttk_labelframe.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_labelframe.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_labelframe.n')
-rw-r--r--doc/ttk_labelframe.n29
1 files changed, 21 insertions, 8 deletions
diff --git a/doc/ttk_labelframe.n b/doc/ttk_labelframe.n
index 8771f19..7e13941 100644
--- a/doc/ttk_labelframe.n
+++ b/doc/ttk_labelframe.n
@@ -1,18 +1,29 @@
+'\"
'\" Copyright (c) 2005 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_labelframe.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $
+'\"
.so man.macros
.TH ttk_labelframe n 8.5 Tk "Tk Themed Widget"
.BS
+.\" Use _ instead of :: as the name becomes a filename on install
.SH NAME
-ttk::labelframe \- Container widget with optional label
+ttk_labelframe \- Container widget with optional label
.SH SYNOPSIS
\fBttk::labelframe\fR \fIpathName \fR?\fIoptions\fR?
.BE
+
.SH DESCRIPTION
-A \fBlabelframe\fR widget is a container used to group other widgets together.
-It has an optional label, which may be a plain text string or another widget.
+A \fBttk::labelframe\fR widget is a container used to group other widgets
+together. It has an optional label, which may be a plain text string or
+another widget.
.SO
\-class \-cursor \-takefocus \-style
.SE
+
.SH "WIDGET-SPECIFIC OPTIONS"
'\" XXX: Currently included, but may go away:
'\" XXX: .OP -borderwidth borderWidth BorderWidth
@@ -37,8 +48,7 @@ Specifies the text of the label.
.OP -underline underline Underline
If set, specifies the integer index (0-based) of a character to
underline in the text string.
-The underlined character is used for mnemonic activation
-(see \fIkeynav(n)\fR).
+The underlined character is used for mnemonic activation.
Mnemonic activation for a \fBttk::labelframe\fR
sets the keyboard focus to the first child of the \fBttk::labelframe\fR widget.
.OP -padding padding Padding
@@ -53,12 +63,15 @@ same top-level widget as the \fBlabelframe\fR.
If specified, the widget's requested width in pixels.
.OP -height height Height
If specified, the widget's requested height in pixels.
-(See \fIttk::frame\fR for further notes on \fB-width\fR and \fB-height\fR).
+(See \fIttk_frame(n)\fR for further notes on \fB-width\fR and \fB-height\fR).
+
.SH "WIDGET COMMAND"
Supports the standard widget commands
\fBconfigure\fR, \fBcget\fR, \fBinstate\fR, and \fBstate\fR;
-see \fIwidget(n)\fR.
+see \fIttk_widget(n)\fR.
+
.SH "SEE ALSO"
-widget(n), frame(n)
+ttk_widget(n), ttk_frame(n), labelframe(n)
+
.SH "KEYWORDS"
widget, frame, container, label, groupbox