diff options
author | Jason Molenda <jmolenda@apple.com> | 2000-02-07 00:19:28 +0000 |
---|---|---|
committer | Jason Molenda <jmolenda@apple.com> | 2000-02-07 00:19:28 +0000 |
commit | b111a96ea19bde1004ecea63c7827a1d4b0b73ef (patch) | |
tree | 2b8155215201f5224d8f68ec53f9720a89dfbdd9 /itcl/iwidgets3.0.0/doc/extfileselectiondialog.n | |
parent | b73e43e34794f4903b0bf2e0fc1298547ef01faf (diff) | |
download | gdb-b111a96ea19bde1004ecea63c7827a1d4b0b73ef.tar.gz |
import insight-2000-02-04 snapshot (2nd try)
Diffstat (limited to 'itcl/iwidgets3.0.0/doc/extfileselectiondialog.n')
-rw-r--r-- | itcl/iwidgets3.0.0/doc/extfileselectiondialog.n | 237 |
1 files changed, 237 insertions, 0 deletions
diff --git a/itcl/iwidgets3.0.0/doc/extfileselectiondialog.n b/itcl/iwidgets3.0.0/doc/extfileselectiondialog.n new file mode 100644 index 00000000000..4bfeeb1643d --- /dev/null +++ b/itcl/iwidgets3.0.0/doc/extfileselectiondialog.n @@ -0,0 +1,237 @@ +'\" +'\" Copyright (c) 1997 DSC Technologies Corporation +'\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +'\" @(#) extfileselectiondialog.n 1.21 94/12/17 16:04:44 +'\" +.so man.macros +.HS extfileselectiondialog iwid +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +extfileselectiondialog \- Create and manipulate a file selection dialog widget +.SH SYNOPSIS +\fBextfileselectiondialog\fI \fIpathName \fR?\fIoptions\fR? +.SH "INHERITANCE" +itk::Toplevel <- Shell <- Dialogshell <- Dialog <- Extfileselectiondialog +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 4c 8c 12c +\fBactiveBackground\fR \fBbackground\fR \fBborderWidth\fR \fBcursor\fR +\fBforeground\fR \fBhighlightColor\fR \fBhighlightThickness\fR \fBinsertBackground\fR +\fBinsertBorderWidth\fR \fBinsertOffTime\fR \fBinsertOnTime\fR \fBinsertWidth\fR +\fBselectBackground\fR \fBselectBorderWidth\fR \fBselectForeground\fR +.fi +.LP +See the "options" manual entry for details on the standard options. +.SH "ASSOCIATED OPTIONS" +.LP +.nf +.ta 4c 8c 12c +\fBpopupCursor\fR \fBtextBackground\fR \fBtextFont\fR +.fi +.LP +See the "combobox" widget manual entry for details on the above +associated options. +.LP +.nf +.ta 4c 8c 12c +\fBchildSitePos\fR \fBdirectory\fR \fBdirsLabel\fR \fBdirSearchCommand\fR +\fBdirsOn\fR \fBfilesLabel\fR \fBfilesLabelOn\fR \fBfileSearchCommand\fR +\fBfilesOn\fR \fBfileType\fR \fBfilterLabel\fR \fBfilterOn\fR +\fBinvalid\fR \fBmask\fR \fBnoMatchString\fR \fBselectionLabel\fR +\fBselectionOn\fR +.fi +.LP +See the "extfileselectionbox" widget manual entry for details on the above +associated options. +.LP +.nf +.ta 4c 8c 12c +\fBlabelFont\fR +.fi +.LP +See the "labeledwidget" widget manual entry for details on the above +associated options. +.LP +.nf +.ta 4c 8c 12c +\fBsashCursor\fR +.fi +.LP +See the "panedwindow" widget manual entry for details on the above +associated options. +.LP +.nf +.ta 4c 8c 12c +\fBlabelFont\fR +.fi +.LP +See the "labeledwidget" widget manual entry for details on the above +associated options. +.LP +.nf +.ta 4c 8c 12c +\fBactiveRelief\fR \fBelementBorderWidth\fR \fBjump\fR \fBtroughColor\fR +.fi +.LP +See the "scrollbar" widget class manual entry for details on the above +associated options. +.LP +.nf +.ta 4c 8c 12c +\fBtextBackground\fR \fBtextFont\fR +.fi +.LP +See the "scrolledlistbox" widget manual entry for details on the above +associated options. + +.SH "INHERITED OPTIONS" +.LP +.nf +.ta 4c 8c 12c +\fBbuttonBoxPadX\fR \fBbuttonBoxPadY\fR \fBbuttonBoxPos\fR \fBpadX\fR +\fBpadY\fR \fBseparator\fR \fBthickness\fR +.fi +.LP +See the "dialogshell" widget manual entry for details on the above +inherited options. +.LP +.nf +.ta 4c 8c 12c +\fBheight\fR \fBmaster\fR \fBmodality\fR \fBwidth\fR +.fi +.LP +See the "shell" widget manual entry for details on the above +inherited options. +.LP +.nf +.ta 4c 8c 12c +\fBtitle\fR +.fi +.LP +See the "Toplevel" widget manual entry for details on the above +inherited options. +.BE + +.SH DESCRIPTION +.PP +The \fBextfileselectiondialog\fR command creates an extended file +selection dialog which is slightly different than the +fileselectiondialog widget. +The differences are mostly cosmetic in that the listboxes are +within a panedwindow and the entryfields for the filter and selection +have been replaced by comboboxes. Other than that the interface is +practically the same. + +.SH "METHODS" +.PP +The \fBextfileselectiondialog\fR command creates a new Tcl command whose +name is \fIpathName\fR. This +command may be used to invoke various +operations on the widget. It has the following general form: +.DS C +\fIpathName option \fR?\fIarg arg ...\fR? +.DE +\fIOption\fR and the \fIarg\fRs +determine the exact behavior of the command. The following +commands are possible for extfileselectiondialog widgets: +.SH "ASSOCIATED METHODS" +.LP +.nf +.ta 4c 8c 12c +\fBget\fR \fBchildsite\fR \fBfilter\fR +.fi +.LP +See the "fileselectionbox" class manual entry for details on the +associated methods. +.SH "INHERITED METHODS" +.LP +.nf +.ta 4c 8c 12c +\fBadd\fR \fBbuttonconfigure\fR \fBdefault\fR \fBhide\fR +\fBinsert\fR \fBinvoke\fR \fBshow\fR +.fi +.LP +See the "buttonbox" widget manual entry for details on the above +inherited methods. +.LP +.nf +.ta 4c 8c 12c +\fBactivate\fR \fBcenter\fR \fBdeactivate\fR +.fi +.LP +See the "shell" widget manual entry for details on the above +inherited methods. + +.SH "WIDGET-SPECIFIC METHODS" +.TP +\fIpathName \fBcget\fR \fIoption\fR +Returns the current value of the configuration option given +by \fIoption\fR. +\fIOption\fR may have any of the values accepted by +the \fBextfileselectiondialog\fR command. +.TP +\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? +Query or modify the configuration options of the widget. +If no \fIoption\fR is specified, returns a list describing all of +the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for +information on the format of this list). If \fIoption\fR is specified +with no \fIvalue\fR, then the command returns a list describing the +one named option (this list will be identical to the corresponding +sublist of the value returned if no \fIoption\fR is specified). If +one or more \fIoption\-value\fR pairs are specified, then the command +modifies the given widget option(s) to have the given value(s); in +this case the command returns an empty string. +\fIOption\fR may have any of the values accepted by +the \fBextfileselectiondialog\fR +command. + +.SH "COMPONENTS" +.LP +.nf +Name: \fBfsb\fR +Class: \fBFileselectionbox\fR +.fi +.IP +The fsb component is the extfileselectionbox for the extfileselectiondialog. +See the "extfileselectionbox" widget manual entry for details on the fsb +component item. +.fi + +.SH EXAMPLE +.DS + # + # Non-modal example + # + proc okCallback {} { + puts "You selected [.nmfsd get]" + .nmfsd deactivate + } + + extfileselectiondialog .nmfsd -title Non-Modal + .nmfsd buttonconfigure OK -command okCallback + + .nmfsd activate + + # + # Modal example + # + extfileselectiondialog .mfsd -modality application + .mfsd center + + if {[.mfsd activate]} { + puts "You selected [.mfsd get]" + } else { + puts "You cancelled the dialog" + } +.DE +.SH AUTHOR +Mark L. Ulferts +.DE +Anthony L. Parent +.SH KEYWORDS +extfileselectiondialog, extfileselectionbox, dialog, dialogshell, shell, widget |