OpenCores
URL https://opencores.org/ocsvn/or1k/or1k/trunk

Subversion Repositories or1k

[/] [or1k/] [trunk/] [insight/] [itcl/] [iwidgets3.0.0/] [doc/] [extfileselectionbox.n] - Diff between revs 578 and 1765

Only display areas with differences | Details | Blame | View Log

Rev 578 Rev 1765
'\"
'\"
'\" Copyright (c) 1995 DSC Technologies Corporation
'\" Copyright (c) 1995 DSC Technologies Corporation
'\"
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\"
'\" @(#) extfileselectionbox.n 1.21 94/12/17 16:04:44
'\" @(#) extfileselectionbox.n 1.21 94/12/17 16:04:44
'/"
'/"
.so man.macros
.so man.macros
.HS extfileselectionbox iwid
.HS extfileselectionbox iwid
.BS
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
.SH NAME
extfileselectionbox \- Create and manipulate a file selection box widget
extfileselectionbox \- Create and manipulate a file selection box widget
.SH SYNOPSIS
.SH SYNOPSIS
\fBextfileselectionbox\fI \fIpathName \fR?\fIoptions\fR?
\fBextfileselectionbox\fI \fIpathName \fR?\fIoptions\fR?
.SH "INHERITANCE"
.SH "INHERITANCE"
itk::Widget <- Extfileselectionbox
itk::Widget <- Extfileselectionbox
.SH "STANDARD OPTIONS"
.SH "STANDARD OPTIONS"
.LP
.LP
.nf
.nf
.ta 4c 8c 12c
.ta 4c 8c 12c
\fBactiveBackground\fR  \fBbackground\fR        \fBborderWidth\fR       \fBcursor\fR
\fBactiveBackground\fR  \fBbackground\fR        \fBborderWidth\fR       \fBcursor\fR
\fBforeground\fR        \fBhighlightColor\fR    \fBhighlightThickness\fR        \fBinsertBackground\fR
\fBforeground\fR        \fBhighlightColor\fR    \fBhighlightThickness\fR        \fBinsertBackground\fR
\fBinsertBorderWidth\fR \fBinsertOffTime\fR     \fBinsertOnTime\fR      \fBinsertWidth\fR
\fBinsertBorderWidth\fR \fBinsertOffTime\fR     \fBinsertOnTime\fR      \fBinsertWidth\fR
\fBselectBackground\fR  \fBselectBorderWidth\fR \fBselectForeground\fR
\fBselectBackground\fR  \fBselectBorderWidth\fR \fBselectForeground\fR
.fi
.fi
.LP
.LP
See the "options" manual entry for details on the standard options.
See the "options" manual entry for details on the standard options.
.SH "ASSOCIATED OPTIONS"
.SH "ASSOCIATED OPTIONS"
.LP
.LP
.nf
.nf
.ta 4c 8c 12c
.ta 4c 8c 12c
\fBpopupCursor\fR       \fBtextBackground\fR    \fBtextFont\fR
\fBpopupCursor\fR       \fBtextBackground\fR    \fBtextFont\fR
.fi
.fi
.LP
.LP
See the "combobox" widget manual entry for details on the above
See the "combobox" widget manual entry for details on the above
associated options.
associated options.
.LP
.LP
.nf
.nf
.ta 4c 8c 12c
.ta 4c 8c 12c
\fBlabelFont\fR
\fBlabelFont\fR
.fi
.fi
.LP
.LP
See the "labeledwidget" widget manual entry for details on the above
See the "labeledwidget" widget manual entry for details on the above
associated options.
associated options.
.LP
.LP
.nf
.nf
.ta 4c 8c 12c
.ta 4c 8c 12c
\fBsashCursor\fR
\fBsashCursor\fR
.fi
.fi
.LP
.LP
See the "panedwindow" widget manual entry for details on the above
See the "panedwindow" widget manual entry for details on the above
associated options.
associated options.
.LP
.LP
.nf
.nf
.ta 4c 8c 12c
.ta 4c 8c 12c
\fBactiveRelief\fR      \fBelementBorderWidth\fR        \fBjump\fR      \fBtroughColor\fR
\fBactiveRelief\fR      \fBelementBorderWidth\fR        \fBjump\fR      \fBtroughColor\fR
.fi
.fi
.LP
.LP
See the "scrollbar" widget class manual entry for details on the above
See the "scrollbar" widget class manual entry for details on the above
associated options.
associated options.
.LP
.LP
.nf
.nf
.ta 4c 8c 12c
.ta 4c 8c 12c
\fBtextBackground\fR    \fBtextFont\fR
\fBtextBackground\fR    \fBtextFont\fR
.fi
.fi
.LP
.LP
See the "scrolledlistbox" widget manual entry for details on the above
See the "scrolledlistbox" widget manual entry for details on the above
associated options.
associated options.
.SH "WIDGET-SPECIFIC OPTIONS"
.SH "WIDGET-SPECIFIC OPTIONS"
.LP
.LP
.nf
.nf
Name:   \fBchildSitePos\fR
Name:   \fBchildSitePos\fR
Class:  \fBPosition\fR
Class:  \fBPosition\fR
Command-Line Switch:    \fB-childsitepos\fR
Command-Line Switch:    \fB-childsitepos\fR
.fi
.fi
.IP
.IP
Specifies the position of the child site in the extended fileselection
Specifies the position of the child site in the extended fileselection
box: \fBn\fR, \fBs\fR, \fBe\fR, \fBw\fR, \fBtop\fR, or \fBbottom\fR.
box: \fBn\fR, \fBs\fR, \fBe\fR, \fBw\fR, \fBtop\fR, or \fBbottom\fR.
The default is s.
The default is s.
.LP
.LP
.nf
.nf
Name:   \fBdirectory\fR
Name:   \fBdirectory\fR
Class:  \fBDirectory\fR
Class:  \fBDirectory\fR
Command-Line Switch:    \fB-directory\fR
Command-Line Switch:    \fB-directory\fR
.fi
.fi
.IP
.IP
Specifies the initial default directory.  The default is the present
Specifies the initial default directory.  The default is the present
working directory.
working directory.
.LP
.LP
.nf
.nf
Name:   \fBdirSearchCommand\fR
Name:   \fBdirSearchCommand\fR
Class:  \fBCommand\fR
Class:  \fBCommand\fR
Command-Line Switch:    \fB-dirsearchcommand\fR
Command-Line Switch:    \fB-dirsearchcommand\fR
.fi
.fi
.IP
.IP
Specifies a Tcl command to be executed to perform a directory search.
Specifies a Tcl command to be executed to perform a directory search.
The command will receive the current working directory and filter
The command will receive the current working directory and filter
mask as arguments.  The command should return a list of files which
mask as arguments.  The command should return a list of files which
will be placed into the directory list.
will be placed into the directory list.
.LP
.LP
.nf
.nf
Name:   \fBdirsLabel\fR
Name:   \fBdirsLabel\fR
Class:  \fBText\fR
Class:  \fBText\fR
Command-Line Switch:    \fB-dirslabel\fR
Command-Line Switch:    \fB-dirslabel\fR
.fi
.fi
.IP
.IP
Specifies the text of the label for the directory list.  The default is
Specifies the text of the label for the directory list.  The default is
"Directories".
"Directories".
.LP
.LP
.nf
.nf
Name:   \fBdirsOn\fR
Name:   \fBdirsOn\fR
Class:  \fBDirsOn\fR
Class:  \fBDirsOn\fR
Command-Line Switch:    \fB-dirson\fR
Command-Line Switch:    \fB-dirson\fR
.fi
.fi
.IP
.IP
Specifies whether or not to display the directory list.  The
Specifies whether or not to display the directory list.  The
value may be given in any of the forms acceptable to \fBTcl_GetBoolean\fR.
value may be given in any of the forms acceptable to \fBTcl_GetBoolean\fR.
The default is true.
The default is true.
.LP
.LP
.nf
.nf
Name:   \fBfileSearchCommand\fR
Name:   \fBfileSearchCommand\fR
Class:  \fBCommand\fR
Class:  \fBCommand\fR
Command-Line Switch:    \fB-filesearchcommand\fR
Command-Line Switch:    \fB-filesearchcommand\fR
.fi
.fi
.IP
.IP
Specifies a Tcl command to be executed to perform a file search.
Specifies a Tcl command to be executed to perform a file search.
The command will receive the current working directory and filter
The command will receive the current working directory and filter
mask as arguments.  The command should return a list of files which
mask as arguments.  The command should return a list of files which
will be placed into the file list.
will be placed into the file list.
.LP
.LP
.nf
.nf
Name:   \fBfilesLabel\fR
Name:   \fBfilesLabel\fR
Class:  \fBText\fR
Class:  \fBText\fR
Command-Line Switch:    \fB-fileslabel\fR
Command-Line Switch:    \fB-fileslabel\fR
.fi
.fi
.IP
.IP
Specifies the text of the label for the files list.  The default is "Files".
Specifies the text of the label for the files list.  The default is "Files".
.LP
.LP
.nf
.nf
Name:   \fBfilesOn\fR
Name:   \fBfilesOn\fR
Class:  \fBFilesOn\fR
Class:  \fBFilesOn\fR
Command-Line Switch:    \fB-fileson\fR
Command-Line Switch:    \fB-fileson\fR
.fi
.fi
.IP
.IP
Specifies whether or not to display the files list.  The
Specifies whether or not to display the files list.  The
value may be given in any of the forms acceptable to \fBTcl_GetBoolean\fR.
value may be given in any of the forms acceptable to \fBTcl_GetBoolean\fR.
The default is true.
The default is true.
.LP
.LP
.nf
.nf
Name:   \fBfileType\fR
Name:   \fBfileType\fR
Class:  \fBFileType\fR
Class:  \fBFileType\fR
Command-Line Switch:    \fB-filetype\fR
Command-Line Switch:    \fB-filetype\fR
.fi
.fi
.IP
.IP
Specify the type of files which may appear in the file list: \fBregular\fR,
Specify the type of files which may appear in the file list: \fBregular\fR,
\fBdirectory\fR, or \fBany\fR.  The default is regular.
\fBdirectory\fR, or \fBany\fR.  The default is regular.
.LP
.LP
.nf
.nf
Name:   \fBfilterCommand\fR
Name:   \fBfilterCommand\fR
Class:  \fBCommand\fR
Class:  \fBCommand\fR
Command-Line Switch:    \fB-filtercommand\fR
Command-Line Switch:    \fB-filtercommand\fR
.fi
.fi
.IP
.IP
Specifies a Tcl command to be executed upon hitting the Return key
Specifies a Tcl command to be executed upon hitting the Return key
in the filter combobox widget.
in the filter combobox widget.
.LP
.LP
.nf
.nf
Name:   \fBfilterLabel\fR
Name:   \fBfilterLabel\fR
Class:  \fBText\fR
Class:  \fBText\fR
Command-Line Switch:    \fB-filterlabel\fR
Command-Line Switch:    \fB-filterlabel\fR
.fi
.fi
.IP
.IP
Specifies the text of the label for the filter combobox.  The default is
Specifies the text of the label for the filter combobox.  The default is
"Filter".
"Filter".
.LP
.LP
.nf
.nf
Name:   \fBfilterOn\fR
Name:   \fBfilterOn\fR
Class:  \fBFilterOn\fR
Class:  \fBFilterOn\fR
Command-Line Switch:    \fB-filteron\fR
Command-Line Switch:    \fB-filteron\fR
.fi
.fi
.IP
.IP
Specifies whether or not to display the filter combobox.  The
Specifies whether or not to display the filter combobox.  The
value may be given in any of the forms acceptable to \fBTcl_GetBoolean\fR.
value may be given in any of the forms acceptable to \fBTcl_GetBoolean\fR.
The default is true.
The default is true.
.LP
.LP
.nf
.nf
Name:   \fBheight\fR
Name:   \fBheight\fR
Class:  \fBHeight\fR
Class:  \fBHeight\fR
Command-Line Switch:    \fB-height\fR
Command-Line Switch:    \fB-height\fR
.fi
.fi
.IP
.IP
Specifies the height of the selection box.  The value may be specified in
Specifies the height of the selection box.  The value may be specified in
any of the forms acceptable to Tk_GetPixels.  The default is 300 pixels.
any of the forms acceptable to Tk_GetPixels.  The default is 300 pixels.
.LP
.LP
.nf
.nf
Name:   \fBinvalid\fR
Name:   \fBinvalid\fR
Class:  \fBCommand\fR
Class:  \fBCommand\fR
Command-Line Switch:    \fB-invalid\fR
Command-Line Switch:    \fB-invalid\fR
.fi
.fi
.IP
.IP
Command to be executed should the filter contents be proven
Command to be executed should the filter contents be proven
invalid.  The default is {bell}.
invalid.  The default is {bell}.
.LP
.LP
.nf
.nf
Name:   \fBmask\fR
Name:   \fBmask\fR
Class:  \fBMask\fR
Class:  \fBMask\fR
Command-Line Switch:    \fB-mask\fR
Command-Line Switch:    \fB-mask\fR
.fi
.fi
.IP
.IP
Specifies the initial file mask string.  The default is "*".
Specifies the initial file mask string.  The default is "*".
.LP
.LP
.nf
.nf
Name:   \fBnoMatchString\fR
Name:   \fBnoMatchString\fR
Class:  \fBNoMatchString\fR
Class:  \fBNoMatchString\fR
Command-Line Switch:    \fB-nomatchstring\fR
Command-Line Switch:    \fB-nomatchstring\fR
.fi
.fi
.IP
.IP
Specifies the string to be displayed in the files list should no files
Specifies the string to be displayed in the files list should no files
match the mask.  The default is "".
match the mask.  The default is "".
.LP
.LP
.nf
.nf
Name:   \fBselectDirCommand\fR
Name:   \fBselectDirCommand\fR
Class:  \fBCommand\fR
Class:  \fBCommand\fR
Command-Line Switch:    \fB-selectdirommand\fR
Command-Line Switch:    \fB-selectdirommand\fR
.fi
.fi
.IP
.IP
Specifies a Tcl command to be executed following selection of a
Specifies a Tcl command to be executed following selection of a
directory in the directory list.
directory in the directory list.
.LP
.LP
.nf
.nf
Name:   \fBselectFileCommand\fR
Name:   \fBselectFileCommand\fR
Class:  \fBCommand\fR
Class:  \fBCommand\fR
Command-Line Switch:    \fB-selectfileommand\fR
Command-Line Switch:    \fB-selectfileommand\fR
.fi
.fi
.IP
.IP
Specifies a Tcl command to be executed following selection of a
Specifies a Tcl command to be executed following selection of a
file in the files list.
file in the files list.
.LP
.LP
.nf
.nf
Name:   \fBselectionCommand\fR
Name:   \fBselectionCommand\fR
Class:  \fBCommand\fR
Class:  \fBCommand\fR
Command-Line Switch:    \fB-selectioncommand\fR
Command-Line Switch:    \fB-selectioncommand\fR
.fi
.fi
.IP
.IP
Specifies a Tcl command to be executed upon hitting the Return key
Specifies a Tcl command to be executed upon hitting the Return key
in the selection combobox widget.
in the selection combobox widget.
.LP
.LP
.nf
.nf
Name:   \fBselectionLabel\fR
Name:   \fBselectionLabel\fR
Class:  \fBText\fR
Class:  \fBText\fR
Command-Line Switch:    \fB-selectionlabel\fR
Command-Line Switch:    \fB-selectionlabel\fR
.fi
.fi
.IP
.IP
Specifies the text of the label for the selection combobox.  The default
Specifies the text of the label for the selection combobox.  The default
is "Selection".
is "Selection".
.LP
.LP
.nf
.nf
Name:   \fBselectionOn\fR
Name:   \fBselectionOn\fR
Class:  \fBSelectionOn\fR
Class:  \fBSelectionOn\fR
Command-Line Switch:    \fB-selectionon\fR
Command-Line Switch:    \fB-selectionon\fR
.fi
.fi
.IP
.IP
Specifies whether or not to display the selection combobox.  The
Specifies whether or not to display the selection combobox.  The
value may be given in any of the forms acceptable to \fBTcl_GetBoolean\fR.
value may be given in any of the forms acceptable to \fBTcl_GetBoolean\fR.
The default is true.
The default is true.
.LP
.LP
.nf
.nf
Name:   \fBwidth\fR
Name:   \fBwidth\fR
Class:  \fBWidth\fR
Class:  \fBWidth\fR
Command-Line Switch:    \fB-width\fR
Command-Line Switch:    \fB-width\fR
.fi
.fi
.IP
.IP
Specifies the width of the selection box.  The value may be specified in
Specifies the width of the selection box.  The value may be specified in
any of the forms acceptable to Tk_GetPixels.  The default is 350 pixels.
any of the forms acceptable to Tk_GetPixels.  The default is 350 pixels.
.LP
.LP
.BE
.BE
.SH DESCRIPTION
.SH DESCRIPTION
.PP
.PP
The \fBextfileselectionbox\fR command creates an extended file
The \fBextfileselectionbox\fR command creates an extended file
selection box which is slightly different than the fileselectionbox widget.
selection box which is slightly different than the fileselectionbox widget.
The differences are mostly cosmetic in that the listboxes are
The differences are mostly cosmetic in that the listboxes are
within a panedwindow and the entryfields for the filter and selection
within a panedwindow and the entryfields for the filter and selection
have been replaced by comboboxes.  Other than that the interface is
have been replaced by comboboxes.  Other than that the interface is
practically the same.
practically the same.
.SH "METHODS"
.SH "METHODS"
.PP
.PP
The \fBextfileselectionbox\fR command creates a new Tcl command whose
The \fBextfileselectionbox\fR command creates a new Tcl command whose
name is \fIpathName\fR.  This
name is \fIpathName\fR.  This
command may be used to invoke various
command may be used to invoke various
operations on the widget.  It has the following general form:
operations on the widget.  It has the following general form:
.DS C
.DS C
\fIpathName option \fR?\fIarg arg ...\fR?
\fIpathName option \fR?\fIarg arg ...\fR?
.DE
.DE
\fIOption\fR and the \fIarg\fRs
\fIOption\fR and the \fIarg\fRs
determine the exact behavior of the command.  The following
determine the exact behavior of the command.  The following
commands are possible for extfileselectionbox widgets:
commands are possible for extfileselectionbox widgets:
.SH "WIDGET-SPECIFIC METHODS"
.SH "WIDGET-SPECIFIC METHODS"
.TP
.TP
\fIpathName \fBcget\fR \fIoption\fR
\fIpathName \fBcget\fR \fIoption\fR
Returns the current value of the configuration option given
Returns the current value of the configuration option given
by \fIoption\fR.
by \fIoption\fR.
\fIOption\fR may have any of the values accepted by the \fBextfileselectionbox\fR
\fIOption\fR may have any of the values accepted by the \fBextfileselectionbox\fR
command.
command.
.TP
.TP
\fIpathName \fBchildsite\fR
\fIpathName \fBchildsite\fR
Returns the child site widget path name.
Returns the child site widget path name.
.TP
.TP
\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
Query or modify the configuration options of the widget.
Query or modify the configuration options of the widget.
If no \fIoption\fR is specified, returns a list describing all of
If no \fIoption\fR is specified, returns a list describing all of
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
information on the format of this list).  If \fIoption\fR is specified
information on the format of this list).  If \fIoption\fR is specified
with no \fIvalue\fR, then the command returns a list describing the
with no \fIvalue\fR, then the command returns a list describing the
one named option (this list will be identical to the corresponding
one named option (this list will be identical to the corresponding
sublist of the value returned if no \fIoption\fR is specified).  If
sublist of the value returned if no \fIoption\fR is specified).  If
one or more \fIoption\-value\fR pairs are specified, then the command
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
modifies the given widget option(s) to have the given value(s);  in
this case the command returns an empty string.
this case the command returns an empty string.
\fIOption\fR may have any of the values accepted by the \fBextfileselectionbox\fR
\fIOption\fR may have any of the values accepted by the \fBextfileselectionbox\fR
command.
command.
.TP
.TP
\fIpathName \fBfilter\fR
\fIpathName \fBfilter\fR
Update the current contents of the extended file selection box based
Update the current contents of the extended file selection box based
on the current filter combobox value.
on the current filter combobox value.
.TP
.TP
\fIpathName \fBget\fR
\fIpathName \fBget\fR
Returns the current value of the selection combobox widget.
Returns the current value of the selection combobox widget.
.SH "COMPONENTS"
.SH "COMPONENTS"
.LP
.LP
.nf
.nf
Name:   \fBdirs\fR
Name:   \fBdirs\fR
Class:  \fBScrolledlistbox\fR
Class:  \fBScrolledlistbox\fR
.fi
.fi
.IP
.IP
The dirs component is the directory list box for the extended fileselection
The dirs component is the directory list box for the extended fileselection
box. See the "scrolledlistbox" widget manual entry for details on the dirs
box. See the "scrolledlistbox" widget manual entry for details on the dirs
component item.
component item.
.LP
.LP
.nf
.nf
Name:   \fBfiles\fR
Name:   \fBfiles\fR
Class:  \fBScrolledlistbox\fR
Class:  \fBScrolledlistbox\fR
.fi
.fi
.IP
.IP
The files component is the file list box for the extended fileselection box.
The files component is the file list box for the extended fileselection box.
See the "scrolledlistbox" widget manual entry for details on the files
See the "scrolledlistbox" widget manual entry for details on the files
component item.
component item.
.LP
.LP
.nf
.nf
Name:   \fBfilter\fR
Name:   \fBfilter\fR
Class:  \fBCombobox\fR
Class:  \fBCombobox\fR
.fi
.fi
.IP
.IP
The filter component is the field for user input of the filter value.
The filter component is the field for user input of the filter value.
See the "combobox" widget manual entry for details on the filter
See the "combobox" widget manual entry for details on the filter
component item.
component item.
.LP
.LP
.nf
.nf
Name:   \fBselection\fR
Name:   \fBselection\fR
Class:  \fBCombobox\fR
Class:  \fBCombobox\fR
.fi
.fi
.IP
.IP
The selection component is the field for user input of the currently
The selection component is the field for user input of the currently
selected file value.  See the "combobox" widget manual entry for details
selected file value.  See the "combobox" widget manual entry for details
on the selection component item.
on the selection component item.
.fi
.fi
.SH EXAMPLE
.SH EXAMPLE
.DS
.DS
extfileselectionbox .fsb
extfileselectionbox .fsb
pack .fsb -padx 10 -pady 10 -fill both -expand yes
pack .fsb -padx 10 -pady 10 -fill both -expand yes
.DE
.DE
.SH AUTHOR(S)
.SH AUTHOR(S)
Mark L. Ulferts
Mark L. Ulferts
.DE
.DE
Anthony Parent
Anthony Parent
.SH KEYWORDS
.SH KEYWORDS
extfileselectionbox, widget
extfileselectionbox, widget
 
 

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.