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

Subversion Repositories or1k

[/] [or1k/] [trunk/] [insight/] [itcl/] [iwidgets3.0.0/] [demos/] [html/] [fileselectionbox.n.html] - Blame information for rev 1770

Go to most recent revision | Details | Compare with Previous | View Log


<HTML>
<HEAD>
<TITLE>iwidgets2.2.0 User Commands - fileselectionbox</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<H1>iwidgets2.2.0 User Commands - fileselectionbox</H1>
<HR>
<PRE>
 
</PRE>
<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>
 
 
</PRE>
<H2>NAME</H2><PRE>
     fileselectionbox - Create and manipulate  a  file  selection
     box widget
 
 
</PRE>
<H2>SYNOPSIS</H2><PRE>
     <STRONG>fileselectionbox</STRONG> <EM>pathName</EM> ?<EM>options</EM>?
 
 
</PRE>
<H2>INHERITANCE</H2><PRE>
     itk::Widget &lt;- Fileselectionbox
 
 
</PRE>
<H2>STANDARD OPTIONS</H2><PRE>
     <STRONG>activeBackground</STRONG>               <STRONG>background</STRONG>      <STRONG>borderWidthcursor</STRONG>
     <STRONG>foreground</STRONG>      <STRONG>highlightColor</STRONG> <STRONG>highlightThicknessinsertBackground</STRONG>
     <STRONG>insertBorderWidth</STRONG>              <STRONG>insertOffTime</STRONG>   <STRONG>insertOnTimeinsertWidth</STRONG>
     <STRONG>relief</STRONG>          <STRONG>repeatDelay</STRONG>    <STRONG>repeatInterval</STRONG>  <STRONG>selectBackground</STRONG>
     <STRONG>selectBorderWidth</STRONG>              <STRONG>selectForeground</STRONG>
 
     See the "options" manual entry for details on  the  standard
     options.
 
 
</PRE>
<H2>ASSOCIATED OPTIONS</H2><PRE>
     <STRONG>textBackground</STRONG>  <STRONG>textFont</STRONG>
 
     See the "entryfield" widget manual entry for details on  the
     above associated options.
 
     <STRONG>labelFont</STRONG>       <STRONG>labelMargin</STRONG>
 
     See the "labeledwidget" widget manual entry for  details  on
     the above associated options.
 
     <STRONG>activeRelief</STRONG>    <STRONG>elementBorderWidth</STRONG>             <STRONG>jumptroughColor</STRONG>
 
     See the "scrollbar" widget class manual entry for details on
     the above associated options.
 
     <STRONG>hscrollMode</STRONG>     <STRONG>sbWidth</STRONG>        <STRONG>scrollMargin</STRONG>    <STRONG>textBackground</STRONG>
     <STRONG>textFont</STRONG>        <STRONG>vscrollMode</STRONG>
 
     See the "scrolledlistbox" widget manual entry for details on
     the above associated options.
 
 
</PRE>
<H2>WIDGET-SPECIFIC OPTIONS</H2><PRE>
     Name:           <STRONG>childSitePos</STRONG>
     Class:          <STRONG>Position</STRONG>
     Command-Line Switch:           <STRONG>-childsitepos</STRONG>
 
          Specifies the position of the child site in the  selec-
          tion box: <STRONG>n</STRONG>, <STRONG>s</STRONG>, <STRONG>e</STRONG>, or <STRONG>w</STRONG>.  The default is s.
 
     Name:           <STRONG>dblDirsCommand</STRONG>
     Class:          <STRONG>Command</STRONG>
     Command-Line Switch:           <STRONG>-dbldirscommand</STRONG>
 
          Specifies a Tcl command procedure which is called  when
          an  directory  list  item is double clicked.  Typically
          this occurs when mouse button 1 is double clicked  over
          a directory name.
 
     Name:           <STRONG>dblFilesCommand</STRONG>
     Class:          <STRONG>Command</STRONG>
     Command-Line Switch:           <STRONG>-dblfilescommand</STRONG>
 
          Specifies a Tcl command procedure which is called  when
          an  file  list  item is double clicked.  Typically this
          occurs when mouse button 1 is  double  clicked  over  a
          file name.
 
     Name:           <STRONG>directory</STRONG>
     Class:          <STRONG>Directory</STRONG>
     Command-Line Switch:           <STRONG>-directory</STRONG>
 
          Specifies the initial default directory.   The  default
          is the present working directory.
 
     Name:           <STRONG>dirsfraction</STRONG>
     Class:          <STRONG>DirsFraction</STRONG>
     Command-Line Switch:           <STRONG>-dirsfraction</STRONG>
 
          Specifies the fraction as a percentage of  the  overall
          width that the directory list takes up.
 
     Name:           <STRONG>dirSearchCommand</STRONG>
     Class:          <STRONG>Command</STRONG>
     Command-Line Switch:           <STRONG>-dirsearchcommand</STRONG>
 
          Specifies a Tcl command to be  executed  to  perform  a
          directory search.  The command will receive the current
          working directory and filter mask  as  arguments.   The
          command  should  return  a  list of files which will be
          placed into the directory list.
 
     Name:           <STRONG>dirsLabel</STRONG>
     Class:          <STRONG>Text</STRONG>
     Command-Line Switch:           <STRONG>-dirslabel</STRONG>
 
          Specifies the text of the label for the directory list.
          The default is "Directories".
 
     Name:           <STRONG>dirsLabelPos</STRONG>
     Class:          <STRONG>Position</STRONG>
     Command-Line Switch:           <STRONG>-dirslabelpos</STRONG>
          Specifies the position of the label along the  side  of
          the directory list: <STRONG>n</STRONG>, <STRONG>ne</STRONG>, <STRONG>e</STRONG>, <STRONG>se</STRONG>, <STRONG>s</STRONG>, <STRONG>sw</STRONG>, <STRONG>w</STRONG>, or <STRONG>nw</STRONG>.  The
          default is nw.
 
     Name:           <STRONG>dirsOn</STRONG>
     Class:          <STRONG>DirsOn</STRONG>
     Command-Line Switch:           <STRONG>-dirson</STRONG>
 
          Specifies whether or not to display the directory list.
          The  value  may be given in any of the forms acceptable
          to <STRONG>Tcl_GetBoolean</STRONG>.  The default is true.
 
     Name:           <STRONG>fileSearchCommand</STRONG>
     Class:          <STRONG>Command</STRONG>
     Command-Line Switch:           <STRONG>-filesearchcommand</STRONG>
 
          Specifies a Tcl command to be  executed  to  perform  a
          file  search.   The  command  will  receive the current
          working directory and filter mask  as  arguments.   The
          command  should  return  a  list of files which will be
          placed into the file list.
 
     Name:           <STRONG>filesLabel</STRONG>
     Class:          <STRONG>Text</STRONG>
     Command-Line Switch:           <STRONG>-fileslabel</STRONG>
 
          Specifies the text of the label  for  the  files  list.
          The default is "Files".
 
     Name:           <STRONG>filesLabelPos</STRONG>
     Class:          <STRONG>Position</STRONG>
     Command-Line Switch:           <STRONG>-fileslabelpos</STRONG>
 
          Specifies the position of the label along the  side  of
          the  files  list: : <STRONG>n</STRONG>, <STRONG>ne</STRONG>, <STRONG>e</STRONG>, <STRONG>se</STRONG>, <STRONG>s</STRONG>, <STRONG>sw</STRONG>, <STRONG>w</STRONG>, or <STRONG>nw</STRONG>.  The
          default is nw.
 
     Name:           <STRONG>filesOn</STRONG>
     Class:          <STRONG>FilesOn</STRONG>
     Command-Line Switch:           <STRONG>-fileson</STRONG>
 
          Specifies whether or not to  display  the  files  list.
          The  value  may be given in any of the forms acceptable
          to <STRONG>Tcl_GetBoolean</STRONG>.  The default is true.
 
     Name:           <STRONG>fileType</STRONG>
     Class:          <STRONG>FileType</STRONG>
     Command-Line Switch:           <STRONG>-filetype</STRONG>
 
          Specify the type of files which may appear in the  file
          list: <STRONG>regular</STRONG>, <STRONG>directory</STRONG>, or <STRONG>any</STRONG>.  The default is regu-
          lar.
 
     Name:           <STRONG>filterCommand</STRONG>
     Class:          <STRONG>Command</STRONG>
     Command-Line Switch:           <STRONG>-filtercommand</STRONG>
 
          Specifies a Tcl command to be executed upon hitting the
          Return key in the filter entry widget.
 
     Name:           <STRONG>filterFocusCommand</STRONG>
     Class:          <STRONG>Command</STRONG>
     Command-Line Switch:           <STRONG>-filterfocuscommand</STRONG>
 
          Specifies a Tcl command to be executed  upon  reception
          of focus by the filter.
 
     Name:           <STRONG>filterLabel</STRONG>
     Class:          <STRONG>Text</STRONG>
     Command-Line Switch:           <STRONG>-filterlabel</STRONG>
 
          Specifies the text of the label for  the  filter  entry
          field.  The default is "Filter".
 
     Name:           <STRONG>filterLabelPos</STRONG>
     Class:          <STRONG>Position</STRONG>
     Command-Line Switch:           <STRONG>-filterlabelpos</STRONG>
 
          Specifies the position of the label along the  side  of
          the filter: <STRONG>n</STRONG>, <STRONG>ne</STRONG>, <STRONG>e</STRONG>, <STRONG>se</STRONG>, <STRONG>s</STRONG>, <STRONG>sw</STRONG>, <STRONG>w</STRONG>, or <STRONG>nw</STRONG>.  The default
          is nw.
 
     Name:           <STRONG>filterOn</STRONG>
     Class:          <STRONG>FilterOn</STRONG>
     Command-Line Switch:           <STRONG>-filteron</STRONG>
 
          Specifies whether or not to display the  filter  entry.
          The  value  may be given in any of the forms acceptable
          to <STRONG>Tcl_GetBoolean</STRONG>.  The default is true.
 
     Name:           <STRONG>height</STRONG>
     Class:          <STRONG>Height</STRONG>
     Command-Line Switch:           <STRONG>-height</STRONG>
 
          Specifies the height of the selection box.   The  value
          may  be  specified  in  any  of the forms acceptable to
          Tk_GetPixels.  The default is 360 pixels.
 
     Name:           <STRONG>horizmargin</STRONG>
     Class:          <STRONG>Margin</STRONG>
     Command-Line Switch:           <STRONG>-horizmargin</STRONG>
 
          Specifies    distance    between    the    lists    and
          filter/selection  entries.   The  value may be given in
          any of  the  forms  acceptable  to  <STRONG>Tk_GetPixels</STRONG>.   The
          default is 7.
 
     Name:           <STRONG>invalid</STRONG>
     Class:          <STRONG>Command</STRONG>
     Command-Line Switch:           <STRONG>-invalid</STRONG>
 
          Command to be executed should the  filter  contents  be
          proven invalid.  The default is {bell}.
 
     Name:           <STRONG>mask</STRONG>
     Class:          <STRONG>Mask</STRONG>
     Command-Line Switch:           <STRONG>-mask</STRONG>
 
          Specifies the initial file mask string.  The default is
          "*".
 
     Name:           <STRONG>noMatchString</STRONG>
     Class:          <STRONG>NoMatchString</STRONG>
     Command-Line Switch:           <STRONG>-nomatchstring</STRONG>
 
          Specifies the string to be displayed in the files  list
          should  no  files  match  the  mask.  The default is "[
          ]".
 
     Name:           <STRONG>selectDirCommand</STRONG>
     Class:          <STRONG>Command</STRONG>
     Command-Line Switch:           <STRONG>-selectdirommand</STRONG>
 
          Specifies a Tcl command to be executed following selec-
          tion of a directory in the directory list.
 
     Name:           <STRONG>selectFileCommand</STRONG>
     Class:          <STRONG>Command</STRONG>
     Command-Line Switch:           <STRONG>-selectfileommand</STRONG>
 
          Specifies a Tcl command to be executed following selec-
          tion of a file in the files list.
 
     Name:           <STRONG>selectionCommand</STRONG>
     Class:          <STRONG>Command</STRONG>
     Command-Line Switch:           <STRONG>-selectioncommand</STRONG>
 
          Specifies a Tcl command to be executed upon hitting the
          Return key in the selection entry widget.
 
     Name:           <STRONG>selectionFocusCommand</STRONG>
     Class:          <STRONG>Command</STRONG>
     Command-Line Switch:           <STRONG>-selectionfocuscommand</STRONG>
 
          Specifies a Tcl command to be executed  upon  reception
          of focus by the selection entry.
 
     Name:           <STRONG>selectionImage</STRONG>
     Class:          <STRONG>Image</STRONG>
     Command-Line Switch:           <STRONG>-selectionimage</STRONG>
 
          Specifies a image to be used  as  the  selection  entry
          label.  The  image  may be any of the values created by
          the <STRONG>image</STRONG> <STRONG>create</STRONG> command.
 
     Name:           <STRONG>selectionLabel</STRONG>
     Class:          <STRONG>Text</STRONG>
     Command-Line Switch:           <STRONG>-selectionlabel</STRONG>
 
          Specifies the text of the label for the selection entry
          field.  The default is "Selection".
 
     Name:           <STRONG>selectionLabelPos</STRONG>
     Class:          <STRONG>Position</STRONG>
     Command-Line Switch:           <STRONG>-selectionlabelpos</STRONG>
 
          Specifies the position of the label along the  side  of
          the  selection:  <STRONG>n</STRONG>,  <STRONG>ne</STRONG>,  <STRONG>e</STRONG>,  <STRONG>se</STRONG>, <STRONG>s</STRONG>, <STRONG>sw</STRONG>, <STRONG>w</STRONG>, or <STRONG>nw</STRONG>.  The
          default is nw.
 
     Name:           <STRONG>selectionOn</STRONG>
     Class:          <STRONG>SelectionOn</STRONG>
     Command-Line Switch:           <STRONG>-selectionon</STRONG>
 
          Specifies whether  or  not  to  display  the  selection
          entry.   The  value  may  be  given in any of the forms
          acceptable to <STRONG>Tcl_GetBoolean</STRONG>.  The default is true.
 
     Name:           <STRONG>style</STRONG>
     Class:          <STRONG>Syle</STRONG>
     Command-Line Switch:           <STRONG>-style</STRONG>
 
          Specifies display style of the fileselectionbox:  <STRONG>motif</STRONG>
          or <STRONG>notif</STRONG>.  The default is motif which reflects the lay-
          out of the OSF/Motif standard Xmfileselectionbox widget
          composed  of  directory and file scrolled lists as well
          as filter and selection entry fields.  The notif option
          setting  varies  the layout by removing directory names
          from the files, separates the lists by a paned  window,
          and  changes  the  filter  and  entry  fields into com-
          boboxes.
 
     Name:           <STRONG>vertmargin</STRONG>
     Class:          <STRONG>Margin</STRONG>
     Command-Line Switch:           <STRONG>-vertmargin</STRONG>
 
          Specifies  distance  between  the  directory  and  file
          lists.   The  value  may  be  given in any of the forms
          acceptable to <STRONG>Tk_GetPixels</STRONG>.  The default  is  7.   This
          option  is  only useful for motif styled fileselection-
          boxes.  For notif styled  ones,  use  the  dirsfraction
          option  to  modify  spacing  between  the directory and
          files lists.
 
     Name:           <STRONG>width</STRONG>
     Class:          <STRONG>Width</STRONG>
     Command-Line Switch:           <STRONG>-width</STRONG>
 
          Specifies the width of the selection  box.   The  value
          may  be  specified  in  any  of the forms acceptable to
          Tk_GetPixels.  The default is 470 pixels.
 
 
</PRE>
<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>
 
 
 
</PRE>
<H2>DESCRIPTION</H2><PRE>
     The <STRONG>fileselectionbox</STRONG> command creates a  file  selection  box
     similar  to the OSF/Motif standard Xmfileselectionbox compo-
     site widget.  The fileselectionbox is composed of  directory
     and  file  scrolled  lists  as  well as filter and selection
     entry fields.  Bindings are in place such that selection  of
     a  directory  list  item  loads  the  filter entry field and
     selection of a file list  item  loads  the  selection  entry
     field.   Options exist to control the appearance and actions
     of the widget.
 
 
 
</PRE>
<H2>METHODS</H2><PRE>
     The <STRONG>fileselectionbox</STRONG> command creates a new Tcl command whose
     name  is <EM>pathName</EM>.  This command may be used to invoke vari-
     ous operations on the widget.  It has the following  general
     form:
 
          <EM>pathName</EM> <EM>option</EM> ?<EM>arg</EM> <EM>arg</EM> ...?
 
     <EM>Option</EM> and the <EM>arg</EM>s determine the exact behavior of the com-
     mand.   The  following  commands are possible for fileselec-
     tionbox widgets:
 
 
 
</PRE>
<H2>WIDGET-SPECIFIC METHODS</H2><PRE>
     <EM>pathName</EM> <STRONG>cget</STRONG> <EM>option</EM>
          Returns the current value of the  configuration  option
          given  by  <EM>option</EM>.   <EM>Option</EM>  may have any of the values
          accepted by the <STRONG>fileselectionbox</STRONG> command.
 
     <EM>pathName</EM> <STRONG>childsite</STRONG>
          Returns the child site widget path name.
 
     <EM>pathName</EM> <STRONG>configure</STRONG> ?<EM>option</EM>? ?<EM>value</EM> <EM>option</EM> <EM>value</EM> ...?
          Query  or  modify  the  configuration  options  of  the
          widget.   If  no  <EM>option</EM>  is  specified, returns a list
          describing all of the available  options  for  <EM>pathName</EM>
          (see  <STRONG>Tk_ConfigureInfo</STRONG> for information on the format of
          this list).  If <EM>option</EM> is specified with no <EM>value</EM>, then
          the  command  returns  a  list describing the one named
          option (this list will be identical to the  correspond-
          ing  sublist  of  the  value  returned  if no <EM>option</EM> is
          specified).  If one or more  <EM>option</EM> - <EM>value</EM>  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.  <EM>Option</EM> may have any
          of the values accepted by the <STRONG>fileselectionbox</STRONG> command.
 
     <EM>pathName</EM> <STRONG>filter</STRONG>
          Update the current contents of the file  selection  box
          based on the current filter entry field value.
 
     <EM>pathName</EM> <STRONG>get</STRONG>
          Returns  the  current  value  of  the  selection  entry
          widget.
 
 
 
</PRE>
<H2>COMPONENTS</H2><PRE>
     Name:           <STRONG>childsite</STRONG>
     Class:          <STRONG>Frame</STRONG>
 
          The childsite component is the user child site for  the
          file  selection  box.   See  the  "frame" widget manual
          entry for details on the childsite component item.
 
     Name:           <STRONG>dirs</STRONG>
     Class:          <STRONG>Scrolledlistbox</STRONG>
 
          The dirs component is the directory list  box  for  the
          file  selection  box.  See the "scrolledlistbox" widget
          manual entry for details on the dirs component item.
 
     Name:           <STRONG>files</STRONG>
     Class:          <STRONG>Scrolledlistbox</STRONG>
 
          The files component is the file list box for  the  file
          selection box.  See the "scrolledlistbox" widget manual
          entry for details on the files component item.
 
     Name:           <STRONG>filter</STRONG>
     Class:          <STRONG>Entryfield</STRONG>
 
          The filter component is the entry field for user  input
          of  the  filter  value.   See  the  "entryfield" widget
          manual entry for details on the filter component item.
 
 
     Name:           <STRONG>selection</STRONG>
     Class:          <STRONG>Entryfield</STRONG>
 
          The selection component is the  entry  field  for  user
          input  of  the  currently selected file value.  See the
          "entryfield" widget manual entry  for  details  on  the
          selection component item.
 
 
 
</PRE>
<H2>EXAMPLE</H2><PRE>
          option add *textBackground GhostWhite
 
          fileselectionbox .fsb
          pack .fsb -padx 10 -pady 10 -fill both -expand yes
 
 
 
</PRE>
<H2>AUTHOR(S)</H2><PRE>
     Mark L. Ulferts
 
     Anthony Parent
 
 
</PRE>
<H2>KEYWORDS</H2><PRE>
     fileselectionbox, widget
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
</PRE>
</BODY>
</HTML>

Browse

Tools

Subversion Repositories or1k

[/] [or1k/] [trunk/] [insight/] [itcl/] [iwidgets3.0.0/] [demos/] [html/] [fileselectionbox.n.html] - Blame information for rev 1770

Line No.	Rev	Author	Line
1	578	markom	`<HTML>`
2			`<HEAD>`
3			`<TITLE>iwidgets2.2.0 User Commands - fileselectionbox</TITLE>`
4			`</HEAD>`
5			`<BODY BGCOLOR="#FFFFFF">`
6			`<H1>iwidgets2.2.0 User Commands - fileselectionbox</H1>`
7			`<HR>`
8			`<PRE>`
9
10			`</PRE>`
11			`<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>`
12
13
14			`</PRE>`
15			`<H2>NAME</H2><PRE>`
16			`fileselectionbox - Create and manipulate a file selection`
17			`box widget`
18
19
20			`</PRE>`
21			`<H2>SYNOPSIS</H2><PRE>`
22			`<STRONG>fileselectionbox</STRONG> <EM>pathName</EM> ?<EM>options</EM>?`
23
24
25			`</PRE>`
26			`<H2>INHERITANCE</H2><PRE>`
27			`itk::Widget <- Fileselectionbox`
28
29
30			`</PRE>`
31			`<H2>STANDARD OPTIONS</H2><PRE>`
32			`<STRONG>activeBackground</STRONG> <STRONG>background</STRONG> <STRONG>borderWidthcursor</STRONG>`
33			`<STRONG>foreground</STRONG> <STRONG>highlightColor</STRONG> <STRONG>highlightThicknessinsertBackground</STRONG>`
34			`<STRONG>insertBorderWidth</STRONG> <STRONG>insertOffTime</STRONG> <STRONG>insertOnTimeinsertWidth</STRONG>`
35			`<STRONG>relief</STRONG> <STRONG>repeatDelay</STRONG> <STRONG>repeatInterval</STRONG> <STRONG>selectBackground</STRONG>`
36			`<STRONG>selectBorderWidth</STRONG> <STRONG>selectForeground</STRONG>`
37
38			`See the "options" manual entry for details on the standard`
39			`options.`
40
41
42			`</PRE>`
43			`<H2>ASSOCIATED OPTIONS</H2><PRE>`
44			`<STRONG>textBackground</STRONG> <STRONG>textFont</STRONG>`
45
46			`See the "entryfield" widget manual entry for details on the`
47			`above associated options.`
48
49			`<STRONG>labelFont</STRONG> <STRONG>labelMargin</STRONG>`
50
51			`See the "labeledwidget" widget manual entry for details on`
52			`the above associated options.`
53
54			`<STRONG>activeRelief</STRONG> <STRONG>elementBorderWidth</STRONG> <STRONG>jumptroughColor</STRONG>`
55
56			`See the "scrollbar" widget class manual entry for details on`
57			`the above associated options.`
58
59			`<STRONG>hscrollMode</STRONG> <STRONG>sbWidth</STRONG> <STRONG>scrollMargin</STRONG> <STRONG>textBackground</STRONG>`
60			`<STRONG>textFont</STRONG> <STRONG>vscrollMode</STRONG>`
61
62			`See the "scrolledlistbox" widget manual entry for details on`
63			`the above associated options.`
64
65
66			`</PRE>`
67			`<H2>WIDGET-SPECIFIC OPTIONS</H2><PRE>`
68			`Name: <STRONG>childSitePos</STRONG>`
69			`Class: <STRONG>Position</STRONG>`
70			`Command-Line Switch: <STRONG>-childsitepos</STRONG>`
71
72			`Specifies the position of the child site in the selec-`
73			`tion box: <STRONG>n</STRONG>, <STRONG>s</STRONG>, <STRONG>e</STRONG>, or <STRONG>w</STRONG>. The default is s.`
74
75			`Name: <STRONG>dblDirsCommand</STRONG>`
76			`Class: <STRONG>Command</STRONG>`
77			`Command-Line Switch: <STRONG>-dbldirscommand</STRONG>`
78
79			`Specifies a Tcl command procedure which is called when`
80			`an directory list item is double clicked. Typically`
81			`this occurs when mouse button 1 is double clicked over`
82			`a directory name.`
83
84			`Name: <STRONG>dblFilesCommand</STRONG>`
85			`Class: <STRONG>Command</STRONG>`
86			`Command-Line Switch: <STRONG>-dblfilescommand</STRONG>`
87
88			`Specifies a Tcl command procedure which is called when`
89			`an file list item is double clicked. Typically this`
90			`occurs when mouse button 1 is double clicked over a`
91			`file name.`
92
93			`Name: <STRONG>directory</STRONG>`
94			`Class: <STRONG>Directory</STRONG>`
95			`Command-Line Switch: <STRONG>-directory</STRONG>`
96
97			`Specifies the initial default directory. The default`
98			`is the present working directory.`
99
100			`Name: <STRONG>dirsfraction</STRONG>`
101			`Class: <STRONG>DirsFraction</STRONG>`
102			`Command-Line Switch: <STRONG>-dirsfraction</STRONG>`
103
104			`Specifies the fraction as a percentage of the overall`
105			`width that the directory list takes up.`
106
107			`Name: <STRONG>dirSearchCommand</STRONG>`
108			`Class: <STRONG>Command</STRONG>`
109			`Command-Line Switch: <STRONG>-dirsearchcommand</STRONG>`
110
111			`Specifies a Tcl command to be executed to perform a`
112			`directory search. The command will receive the current`
113			`working directory and filter mask as arguments. The`
114			`command should return a list of files which will be`
115			`placed into the directory list.`
116
117			`Name: <STRONG>dirsLabel</STRONG>`
118			`Class: <STRONG>Text</STRONG>`
119			`Command-Line Switch: <STRONG>-dirslabel</STRONG>`
120
121			`Specifies the text of the label for the directory list.`
122			`The default is "Directories".`
123
124			`Name: <STRONG>dirsLabelPos</STRONG>`
125			`Class: <STRONG>Position</STRONG>`
126			`Command-Line Switch: <STRONG>-dirslabelpos</STRONG>`
127			`Specifies the position of the label along the side of`
128			`the directory list: <STRONG>n</STRONG>, <STRONG>ne</STRONG>, <STRONG>e</STRONG>, <STRONG>se</STRONG>, <STRONG>s</STRONG>, <STRONG>sw</STRONG>, <STRONG>w</STRONG>, or <STRONG>nw</STRONG>. The`
129			`default is nw.`
130
131			`Name: <STRONG>dirsOn</STRONG>`
132			`Class: <STRONG>DirsOn</STRONG>`
133			`Command-Line Switch: <STRONG>-dirson</STRONG>`
134
135			`Specifies whether or not to display the directory list.`
136			`The value may be given in any of the forms acceptable`
137			`to <STRONG>Tcl_GetBoolean</STRONG>. The default is true.`
138
139			`Name: <STRONG>fileSearchCommand</STRONG>`
140			`Class: <STRONG>Command</STRONG>`
141			`Command-Line Switch: <STRONG>-filesearchcommand</STRONG>`
142
143			`Specifies a Tcl command to be executed to perform a`
144			`file search. The command will receive the current`
145			`working directory and filter mask as arguments. The`
146			`command should return a list of files which will be`
147			`placed into the file list.`
148
149			`Name: <STRONG>filesLabel</STRONG>`
150			`Class: <STRONG>Text</STRONG>`
151			`Command-Line Switch: <STRONG>-fileslabel</STRONG>`
152
153			`Specifies the text of the label for the files list.`
154			`The default is "Files".`
155
156			`Name: <STRONG>filesLabelPos</STRONG>`
157			`Class: <STRONG>Position</STRONG>`
158			`Command-Line Switch: <STRONG>-fileslabelpos</STRONG>`
159
160			`Specifies the position of the label along the side of`
161			`the files list: : <STRONG>n</STRONG>, <STRONG>ne</STRONG>, <STRONG>e</STRONG>, <STRONG>se</STRONG>, <STRONG>s</STRONG>, <STRONG>sw</STRONG>, <STRONG>w</STRONG>, or <STRONG>nw</STRONG>. The`
162			`default is nw.`
163
164			`Name: <STRONG>filesOn</STRONG>`
165			`Class: <STRONG>FilesOn</STRONG>`
166			`Command-Line Switch: <STRONG>-fileson</STRONG>`
167
168			`Specifies whether or not to display the files list.`
169			`The value may be given in any of the forms acceptable`
170			`to <STRONG>Tcl_GetBoolean</STRONG>. The default is true.`
171
172			`Name: <STRONG>fileType</STRONG>`
173			`Class: <STRONG>FileType</STRONG>`
174			`Command-Line Switch: <STRONG>-filetype</STRONG>`
175
176			`Specify the type of files which may appear in the file`
177			`list: <STRONG>regular</STRONG>, <STRONG>directory</STRONG>, or <STRONG>any</STRONG>. The default is regu-`
178			`lar.`
179
180			`Name: <STRONG>filterCommand</STRONG>`
181			`Class: <STRONG>Command</STRONG>`
182			`Command-Line Switch: <STRONG>-filtercommand</STRONG>`
183
184			`Specifies a Tcl command to be executed upon hitting the`
185			`Return key in the filter entry widget.`
186
187			`Name: <STRONG>filterFocusCommand</STRONG>`
188			`Class: <STRONG>Command</STRONG>`
189			`Command-Line Switch: <STRONG>-filterfocuscommand</STRONG>`
190
191			`Specifies a Tcl command to be executed upon reception`
192			`of focus by the filter.`
193
194			`Name: <STRONG>filterLabel</STRONG>`
195			`Class: <STRONG>Text</STRONG>`
196			`Command-Line Switch: <STRONG>-filterlabel</STRONG>`
197
198			`Specifies the text of the label for the filter entry`
199			`field. The default is "Filter".`
200
201			`Name: <STRONG>filterLabelPos</STRONG>`
202			`Class: <STRONG>Position</STRONG>`
203			`Command-Line Switch: <STRONG>-filterlabelpos</STRONG>`
204
205			`Specifies the position of the label along the side of`
206			`the filter: <STRONG>n</STRONG>, <STRONG>ne</STRONG>, <STRONG>e</STRONG>, <STRONG>se</STRONG>, <STRONG>s</STRONG>, <STRONG>sw</STRONG>, <STRONG>w</STRONG>, or <STRONG>nw</STRONG>. The default`
207			`is nw.`
208
209			`Name: <STRONG>filterOn</STRONG>`
210			`Class: <STRONG>FilterOn</STRONG>`
211			`Command-Line Switch: <STRONG>-filteron</STRONG>`
212
213			`Specifies whether or not to display the filter entry.`
214			`The value may be given in any of the forms acceptable`
215			`to <STRONG>Tcl_GetBoolean</STRONG>. The default is true.`
216
217			`Name: <STRONG>height</STRONG>`
218			`Class: <STRONG>Height</STRONG>`
219			`Command-Line Switch: <STRONG>-height</STRONG>`
220
221			`Specifies the height of the selection box. The value`
222			`may be specified in any of the forms acceptable to`
223			`Tk_GetPixels. The default is 360 pixels.`
224
225			`Name: <STRONG>horizmargin</STRONG>`
226			`Class: <STRONG>Margin</STRONG>`
227			`Command-Line Switch: <STRONG>-horizmargin</STRONG>`
228
229			`Specifies distance between the lists and`
230			`filter/selection entries. The value may be given in`
231			`any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>. The`
232			`default is 7.`
233
234			`Name: <STRONG>invalid</STRONG>`
235			`Class: <STRONG>Command</STRONG>`
236			`Command-Line Switch: <STRONG>-invalid</STRONG>`
237
238			`Command to be executed should the filter contents be`
239			`proven invalid. The default is {bell}.`
240
241			`Name: <STRONG>mask</STRONG>`
242			`Class: <STRONG>Mask</STRONG>`
243			`Command-Line Switch: <STRONG>-mask</STRONG>`
244
245			`Specifies the initial file mask string. The default is`
246			`"*".`
247
248			`Name: <STRONG>noMatchString</STRONG>`
249			`Class: <STRONG>NoMatchString</STRONG>`
250			`Command-Line Switch: <STRONG>-nomatchstring</STRONG>`
251
252			`Specifies the string to be displayed in the files list`
253			`should no files match the mask. The default is "[`
254			`]".`
255
256			`Name: <STRONG>selectDirCommand</STRONG>`
257			`Class: <STRONG>Command</STRONG>`
258			`Command-Line Switch: <STRONG>-selectdirommand</STRONG>`
259
260			`Specifies a Tcl command to be executed following selec-`
261			`tion of a directory in the directory list.`
262
263			`Name: <STRONG>selectFileCommand</STRONG>`
264			`Class: <STRONG>Command</STRONG>`
265			`Command-Line Switch: <STRONG>-selectfileommand</STRONG>`
266
267			`Specifies a Tcl command to be executed following selec-`
268			`tion of a file in the files list.`
269
270			`Name: <STRONG>selectionCommand</STRONG>`
271			`Class: <STRONG>Command</STRONG>`
272			`Command-Line Switch: <STRONG>-selectioncommand</STRONG>`
273
274			`Specifies a Tcl command to be executed upon hitting the`
275			`Return key in the selection entry widget.`
276
277			`Name: <STRONG>selectionFocusCommand</STRONG>`
278			`Class: <STRONG>Command</STRONG>`
279			`Command-Line Switch: <STRONG>-selectionfocuscommand</STRONG>`
280
281			`Specifies a Tcl command to be executed upon reception`
282			`of focus by the selection entry.`
283
284			`Name: <STRONG>selectionImage</STRONG>`
285			`Class: <STRONG>Image</STRONG>`
286			`Command-Line Switch: <STRONG>-selectionimage</STRONG>`
287
288			`Specifies a image to be used as the selection entry`
289			`label. The image may be any of the values created by`
290			`the <STRONG>image</STRONG> <STRONG>create</STRONG> command.`
291
292			`Name: <STRONG>selectionLabel</STRONG>`
293			`Class: <STRONG>Text</STRONG>`
294			`Command-Line Switch: <STRONG>-selectionlabel</STRONG>`
295
296			`Specifies the text of the label for the selection entry`
297			`field. The default is "Selection".`
298
299			`Name: <STRONG>selectionLabelPos</STRONG>`
300			`Class: <STRONG>Position</STRONG>`
301			`Command-Line Switch: <STRONG>-selectionlabelpos</STRONG>`
302
303			`Specifies the position of the label along the side of`
304			`the selection: <STRONG>n</STRONG>, <STRONG>ne</STRONG>, <STRONG>e</STRONG>, <STRONG>se</STRONG>, <STRONG>s</STRONG>, <STRONG>sw</STRONG>, <STRONG>w</STRONG>, or <STRONG>nw</STRONG>. The`
305			`default is nw.`
306
307			`Name: <STRONG>selectionOn</STRONG>`
308			`Class: <STRONG>SelectionOn</STRONG>`
309			`Command-Line Switch: <STRONG>-selectionon</STRONG>`
310
311			`Specifies whether or not to display the selection`
312			`entry. The value may be given in any of the forms`
313			`acceptable to <STRONG>Tcl_GetBoolean</STRONG>. The default is true.`
314
315			`Name: <STRONG>style</STRONG>`
316			`Class: <STRONG>Syle</STRONG>`
317			`Command-Line Switch: <STRONG>-style</STRONG>`
318
319			`Specifies display style of the fileselectionbox: <STRONG>motif</STRONG>`
320			`or <STRONG>notif</STRONG>. The default is motif which reflects the lay-`
321			`out of the OSF/Motif standard Xmfileselectionbox widget`
322			`composed of directory and file scrolled lists as well`
323			`as filter and selection entry fields. The notif option`
324			`setting varies the layout by removing directory names`
325			`from the files, separates the lists by a paned window,`
326			`and changes the filter and entry fields into com-`
327			`boboxes.`
328
329			`Name: <STRONG>vertmargin</STRONG>`
330			`Class: <STRONG>Margin</STRONG>`
331			`Command-Line Switch: <STRONG>-vertmargin</STRONG>`
332
333			`Specifies distance between the directory and file`
334			`lists. The value may be given in any of the forms`
335			`acceptable to <STRONG>Tk_GetPixels</STRONG>. The default is 7. This`
336			`option is only useful for motif styled fileselection-`
337			`boxes. For notif styled ones, use the dirsfraction`
338			`option to modify spacing between the directory and`
339			`files lists.`
340
341			`Name: <STRONG>width</STRONG>`
342			`Class: <STRONG>Width</STRONG>`
343			`Command-Line Switch: <STRONG>-width</STRONG>`
344
345			`Specifies the width of the selection box. The value`
346			`may be specified in any of the forms acceptable to`
347			`Tk_GetPixels. The default is 470 pixels.`
348
349
350			`</PRE>`
351			`<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>`
352
353
354
355			`</PRE>`
356			`<H2>DESCRIPTION</H2><PRE>`
357			`The <STRONG>fileselectionbox</STRONG> command creates a file selection box`
358			`similar to the OSF/Motif standard Xmfileselectionbox compo-`
359			`site widget. The fileselectionbox is composed of directory`
360			`and file scrolled lists as well as filter and selection`
361			`entry fields. Bindings are in place such that selection of`
362			`a directory list item loads the filter entry field and`
363			`selection of a file list item loads the selection entry`
364			`field. Options exist to control the appearance and actions`
365			`of the widget.`
366
367
368
369			`</PRE>`
370			`<H2>METHODS</H2><PRE>`
371			`The <STRONG>fileselectionbox</STRONG> command creates a new Tcl command whose`
372			`name is <EM>pathName</EM>. This command may be used to invoke vari-`
373			`ous operations on the widget. It has the following general`
374			`form:`
375
376			`<EM>pathName</EM> <EM>option</EM> ?<EM>arg</EM> <EM>arg</EM> ...?`
377
378			`<EM>Option</EM> and the <EM>arg</EM>s determine the exact behavior of the com-`
379			`mand. The following commands are possible for fileselec-`
380			`tionbox widgets:`
381
382
383
384			`</PRE>`
385			`<H2>WIDGET-SPECIFIC METHODS</H2><PRE>`
386			`<EM>pathName</EM> <STRONG>cget</STRONG> <EM>option</EM>`
387			`Returns the current value of the configuration option`
388			`given by <EM>option</EM>. <EM>Option</EM> may have any of the values`
389			`accepted by the <STRONG>fileselectionbox</STRONG> command.`
390
391			`<EM>pathName</EM> <STRONG>childsite</STRONG>`
392			`Returns the child site widget path name.`
393
394			`<EM>pathName</EM> <STRONG>configure</STRONG> ?<EM>option</EM>? ?<EM>value</EM> <EM>option</EM> <EM>value</EM> ...?`
395			`Query or modify the configuration options of the`
396			`widget. If no <EM>option</EM> is specified, returns a list`
397			`describing all of the available options for <EM>pathName</EM>`
398			`(see <STRONG>Tk_ConfigureInfo</STRONG> for information on the format of`
399			`this list). If <EM>option</EM> is specified with no <EM>value</EM>, then`
400			`the command returns a list describing the one named`
401			`option (this list will be identical to the correspond-`
402			`ing sublist of the value returned if no <EM>option</EM> is`
403			`specified). If one or more <EM>option</EM> - <EM>value</EM> pairs are`
404			`specified, then the command modifies the given widget`
405			`option(s) to have the given value(s); in this case the`
406			`command returns an empty string. <EM>Option</EM> may have any`
407			`of the values accepted by the <STRONG>fileselectionbox</STRONG> command.`
408
409			`<EM>pathName</EM> <STRONG>filter</STRONG>`
410			`Update the current contents of the file selection box`
411			`based on the current filter entry field value.`
412
413			`<EM>pathName</EM> <STRONG>get</STRONG>`
414			`Returns the current value of the selection entry`
415			`widget.`
416
417
418
419			`</PRE>`
420			`<H2>COMPONENTS</H2><PRE>`
421			`Name: <STRONG>childsite</STRONG>`
422			`Class: <STRONG>Frame</STRONG>`
423
424			`The childsite component is the user child site for the`
425			`file selection box. See the "frame" widget manual`
426			`entry for details on the childsite component item.`
427
428			`Name: <STRONG>dirs</STRONG>`
429			`Class: <STRONG>Scrolledlistbox</STRONG>`
430
431			`The dirs component is the directory list box for the`
432			`file selection box. See the "scrolledlistbox" widget`
433			`manual entry for details on the dirs component item.`
434
435			`Name: <STRONG>files</STRONG>`
436			`Class: <STRONG>Scrolledlistbox</STRONG>`
437
438			`The files component is the file list box for the file`
439			`selection box. See the "scrolledlistbox" widget manual`
440			`entry for details on the files component item.`
441
442			`Name: <STRONG>filter</STRONG>`
443			`Class: <STRONG>Entryfield</STRONG>`
444
445			`The filter component is the entry field for user input`
446			`of the filter value. See the "entryfield" widget`
447			`manual entry for details on the filter component item.`
448
449
450			`Name: <STRONG>selection</STRONG>`
451			`Class: <STRONG>Entryfield</STRONG>`
452
453			`The selection component is the entry field for user`
454			`input of the currently selected file value. See the`
455			`"entryfield" widget manual entry for details on the`
456			`selection component item.`
457
458
459
460			`</PRE>`
461			`<H2>EXAMPLE</H2><PRE>`
462			`option add *textBackground GhostWhite`
463
464			`fileselectionbox .fsb`
465			`pack .fsb -padx 10 -pady 10 -fill both -expand yes`
466
467
468
469			`</PRE>`
470			`<H2>AUTHOR(S)</H2><PRE>`
471			`Mark L. Ulferts`
472
473			`Anthony Parent`
474
475
476			`</PRE>`
477			`<H2>KEYWORDS</H2><PRE>`
478			`fileselectionbox, widget`
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508			`</PRE>`
509			`</BODY>`
510			`</HTML>`