summaryrefslogtreecommitdiffstats
path: root/doc/ttk_dialog.n
diff options
context:
space:
mode:
authorhobbs <hobbs>2006-10-31 01:42:25 (GMT)
committerhobbs <hobbs>2006-10-31 01:42:25 (GMT)
commit397a2c9832bf618f26be267501cf49ab06a562ec (patch)
tree61d5e957eccfcba57b0dd27ebc73db085385834e /doc/ttk_dialog.n
parent18d330543869e240c2bd12fc9fbb8d5027f5cad6 (diff)
downloadtk-397a2c9832bf618f26be267501cf49ab06a562ec.zip
tk-397a2c9832bf618f26be267501cf49ab06a562ec.tar.gz
tk-397a2c9832bf618f26be267501cf49ab06a562ec.tar.bz2
* doc/ttk_Geometry.3, doc/ttk_Theme.3, doc/ttk_button.n:
* doc/ttk_checkbutton.n, doc/ttk_combobox.n, doc/ttk_dialog.n: * doc/ttk_entry.n, doc/ttk_frame.n, doc/ttk_image.n: * doc/ttk_intro.n, doc/ttk_label.n, doc/ttk_labelframe.n: * doc/ttk_menubutton.n, doc/ttk_notebook.n, doc/ttk_panedwindow.n: * doc/ttk_progressbar.n, doc/ttk_radiobutton.n, doc/ttk_scrollbar.n: * doc/ttk_separator.n, doc/ttk_sizegrip.n, doc/ttk_style.n: * doc/ttk_treeview.n, doc/ttk_widget.n,: * generic/ttk/ttk.decls, generic/ttk/ttkBlink.c: * generic/ttk/ttkButton.c, generic/ttk/ttkCache.c: * generic/ttk/ttkClamTheme.c, generic/ttk/ttkClassicTheme.c: * generic/ttk/ttkDecls.h, generic/ttk/ttkDefaultTheme.c: * generic/ttk/ttkElements.c, generic/ttk/ttkEntry.c: * generic/ttk/ttkFrame.c, generic/ttk/ttkImage.c: * generic/ttk/ttkInit.c, generic/ttk/ttkLabel.c: * generic/ttk/ttkLayout.c, generic/ttk/ttkManager.c: * generic/ttk/ttkManager.h, generic/ttk/ttkNotebook.c: * generic/ttk/ttkPanedwindow.c, generic/ttk/ttkProgress.c: * generic/ttk/ttkScale.c, generic/ttk/ttkScroll.c: * generic/ttk/ttkScrollbar.c, generic/ttk/ttkSeparator.c: * generic/ttk/ttkSquare.c, generic/ttk/ttkState.c: * generic/ttk/ttkStubInit.c, generic/ttk/ttkStubLib.c: * generic/ttk/ttkTagSet.c, generic/ttk/ttkTheme.c: * generic/ttk/ttkTheme.h, generic/ttk/ttkThemeInt.h: * generic/ttk/ttkTrace.c, generic/ttk/ttkTrack.c: * generic/ttk/ttkTreeview.c, generic/ttk/ttkWidget.c: * generic/ttk/ttkWidget.h: * library/demos/ttk_demo.tcl, library/demos/ttk_iconlib.tcl: * library/demos/ttk_repeater.tcl: * library/ttk/altTheme.tcl, library/ttk/aquaTheme.tcl: * library/ttk/button.tcl, library/ttk/clamTheme.tcl: * library/ttk/classicTheme.tcl, library/ttk/combobox.tcl: * library/ttk/cursors.tcl, library/ttk/defaults.tcl: * library/ttk/dialog.tcl, library/ttk/entry.tcl: * library/ttk/fonts.tcl, library/ttk/icons.tcl: * library/ttk/keynav.tcl, library/ttk/menubutton.tcl: * library/ttk/notebook.tcl, library/ttk/panedwindow.tcl: * library/ttk/progress.tcl, library/ttk/scale.tcl: * library/ttk/scrollbar.tcl, library/ttk/sizegrip.tcl: * library/ttk/treeview.tcl, library/ttk/ttk.tcl: * library/ttk/utils.tcl, library/ttk/winTheme.tcl: * library/ttk/xpTheme.tcl: * macosx/ttkMacOSXTheme.c: * tests/ttk/all.tcl, tests/ttk/bwidget.test, tests/ttk/combobox.test: * tests/ttk/entry.test, tests/ttk/image.test: * tests/ttk/labelframe.test, tests/ttk/layout.test: * tests/ttk/misc.test, tests/ttk/notebook.test: * tests/ttk/panedwindow.test, tests/ttk/progressbar.test: * tests/ttk/scrollbar.test, tests/ttk/treetags.test: * tests/ttk/treeview.test, tests/ttk/ttk.test, tests/ttk/validate.test: * win/ttkWinMonitor.c, win/ttkWinTheme.c, win/ttkWinXPTheme.c: First import of Ttk themed Tk widgets as branched from tile 0.7.8 * generic/tkInt.h, generic/tkWindow.c: add Ttk_Init call, copy tk classic widgets to ::tk namespace. * library/tk.tcl: add source of ttk/ttk.tcl, define $::ttk::library. * unix/Makefile.in, win/Makefile.in: add Ttk build bits * win/configure, win/configure.in: check for uxtheme.h (XP theme).
Diffstat (limited to 'doc/ttk_dialog.n')
-rw-r--r--doc/ttk_dialog.n120
1 files changed, 120 insertions, 0 deletions
diff --git a/doc/ttk_dialog.n b/doc/ttk_dialog.n
new file mode 100644
index 0000000..3fdeb24
--- /dev/null
+++ b/doc/ttk_dialog.n
@@ -0,0 +1,120 @@
+'\"
+'\" Copyright (c) 2005 Joe English
+'\"
+.so man.macros
+.TH ttk_dialog n 8.5 Tk "Tk Themed Widget"
+.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"
+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.
+When the user presses any of the buttons,
+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.
+.OP \-message undefined undefined
+Specifies the message to display in this dialog.
+.OP \-detail undefined undefined
+Specifies a longer auxilliary message.
+.OP \-command undefined undefined
+Specifies a command prefix to be invoked when the user presses
+one of the command buttons.
+The symbolic name of the button is passed as an additional argument
+to the command.
+The dialog is dismissed after invoking the command.
+.OP \-parent undefined undefined
+Specifies a toplevel window for which the dialog is transient.
+If omitted, the default is the nearest ancestor toplevel.
+If set to the empty string, the dialog will not be a transient window.
+.OP \-type undefined undefined
+Specifies a built-in or user-defined dialog type.
+See \fBPREDEFINED DIALOG TYPES\fP, below.
+.OP \-icon undefined undefined
+Specifies one of the stock dialog icons,
+\fBinfo\fP, \fBquestion\fP, \fBwarning\fP, \fBerror\fP,
+\fBauth\fP, or \fBbusy\fP.
+If set to the empty string (the defalt), no icon is displayed.
+.OP \-buttons undefined undefined
+A list of symbolic button names.
+.OP \-labels undefined undefined
+A dictionary mapping symbolic button names to textual labels.
+May be omitted if all the buttons are predefined.
+.OP \-default undefined undefined
+The symbolic name of the default button.
+.OP \-cancel undefined undefined
+The symbolic name of the "cancel" button.
+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\fP 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\fP option, if present, specifies default values
+for other options. \fBttk::dialog::define \fItype options...\fR
+specifies a new stock dialog \fItype\fP.
+The following stock dialog types are predefined:
+.CS
+ttk::dialog::define ok \e
+ -icon info -buttons {ok} -default ok
+ttk::dialog::define okcancel \e
+ -icon info -buttons {ok cancel} -default ok -cancel cancel
+ttk::dialog::define yesno \e
+ -icon question -buttons {yes no}
+ttk::dialog::define yesnocancel \e
+ -icon question -buttons {yes no cancel} -cancel cancel
+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\fP, \fBno\fP, \fBok\fP, \fBcancel\fP, and \fBretry\fP.
+.PP
+It is not necessary to list these in the \fB-labels\fP dictionary.
+.\" .SH "DIFFERENCES FROM MESSAGE BOXES"
+.\" The \fBttk::dialog\fR constructor is similar to
+.\" the Tk library procedure \fBtk_messageBox\fP,
+.\" but with the following notable differences:
+.\" .IP \(bu
+.\" The first argument to \fBttk::dialog\fP is the name of
+.\" the widget to create; \fBtk_messageBox\fP has
+.\" .IP \(bu
+.\" Ttk dialog boxes are non-modal by default.
+.\" .IP \(bu
+.\" The \fBtk_messageBox\fP command is blocking:
+.\" it does not return until the user presses one of the command buttons.
+.\" \fBttk::dialog\fP returns immediately after creating the dialog box.
+.SH EXAMPLE
+.CS
+proc saveFileComplete {button} {
+ switch -- $button {
+ yes { # save file ... }
+ no { exit }
+ cancel { # no-op }
+ }
+}
+
+ttk::dialog .saveFileDialog \e
+ -title "Save file?" \e
+ -icon question \e
+ -message "Save file before closing?" \e
+ -detail "If you do not save the file, your work will be lost" \e
+ -buttons [list yes no cancel] \e
+ -labels [list yes "Save file" no "Don't save"] \e
+ -command saveFileComplete \e
+ ;
+.CE
+.SH "SEE ALSO"
+\fBtk_messageBox(n)\fR, \fBwm(n)\fR, \fBtoplevel(n)\fP