diff options
| author | hobbs <hobbs> | 2006-12-13 23:04:32 (GMT) |
|---|---|---|
| committer | hobbs <hobbs> | 2006-12-13 23:04:32 (GMT) |
| commit | d4a63ee0259256e40eba77a360b9902afc472bc4 (patch) | |
| tree | 128697b7c80828f4a3d31417bb432bc8eec88b00 /doc/ttk_dialog.n | |
| parent | 318393c4af319ed15ef4a5d6e3f5b12259fe695d (diff) | |
| download | tk-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_dialog.n')
| -rw-r--r-- | doc/ttk_dialog.n | 22 |
1 files changed, 18 insertions, 4 deletions
diff --git a/doc/ttk_dialog.n b/doc/ttk_dialog.n index 8bcea18..41a30c6 100644 --- a/doc/ttk_dialog.n +++ b/doc/ttk_dialog.n @@ -1,14 +1,23 @@ '\" '\" 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_dialog.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ +'\" .so man.macros .TH ttk_dialog n 8.5 Tk "Tk Themed Widget" -.SH "NAME" -ttk::dialog \- create a dialog box +.BS +.\" Use _ instead of :: as the name becomes a filename on install +.SH NAME +ttk_dialog \- create a dialog box .SH "SYNOPSIS" \fBttk::dialog\fR \fIpathname\fR ?\fIoptions...\fR? \fBttk::dialog::define\fR \fIdialogType\fR ?\fIoptions...\fR? -.SH "DESCRIPTION" +.BE + +.SH DESCRIPTION A dialog box is a transient top-level window containing an icon, a short message, an optional, longer, detail message, and a row of command buttons. @@ -17,6 +26,7 @@ a callback function is invoked and then the dialog is destroyed. .PP Additional widgets may be added in the dialog \fIclient frame\fR. + .SH "WIDGET-SPECIFIC OPTIONS" .OP \-title undefined undefined Specifies a string to use as the window manager title. @@ -55,12 +65,14 @@ The cancel button is invoked if the user presses the Escape key and when the dialog is closed from the window manager. If \fB-cancel\fR is not specified, the dialog ignores window manager close commands (WM_DELETE_WINDOW). + .SH "WIDGET COMMANDS" .TP \fBttk::dialog::clientframe \fIdlg\fR Returns the widget path of the client frame. Other widgets may be added to the client frame. The client frame appears between the detail message and the command buttons. + .SH "PREDEFINED DIALOG TYPES" The \fB-type\fR option, if present, specifies default values for other options. \fBttk::dialog::define \fItype options...\fR @@ -78,6 +90,7 @@ ttk::dialog::define yesnocancel \e ttk::dialog::define retrycancel \e -icon question -buttons {retry cancel} -cancel cancel .CE + .SH "STOCK BUTTONS" The following ``stock'' symbolic button names have predefined labels: \fByes\fR, \fBno\fR, \fBok\fR, \fBcancel\fR, and \fBretry\fR. @@ -116,5 +129,6 @@ ttk::dialog .saveFileDialog \e -command saveFileComplete \e ; .CE + .SH "SEE ALSO" -\fBtk_messageBox(n)\fR, \fBwm(n)\fR, \fBtoplevel(n)\fR +tk_messageBox(n), wm(n), toplevel(n) |