Manual Pages for UNIX Darwin command on man iwidgets

Manual Pages for UNIX Darwin command on man iwidgets_fileselectionbox

iwidgets::fileselectionbox(1) [incr Widgets] iwidgets::fileselectionbox(1)

NAME

iwidgets::fileselectionbox - Create and manipulate a file selection box

widget

SYNOPSIS

iiwwiiddggeettss::::ffiilleesseelleeccttiioonnbbooxx pathName ?options? IINNHHEERRIITTAANNCCEE

itk::Widget <- iwidgets::Fileselectionbox

SSTTAANNDDAARRDD OOPPTTIIOONNSS aaccttiivveeBBaacckkggrroouunndd bbaacckkggrroouunndd bboorrddeerrWWiiddtthh ccuurrssoorr ffoorreeggrroouunndd hhiigghhlliigghhttCCoolloorr hhiigghhlliigghhttTThhiicckknneessss iinnsseerrttBBaacckkggrroouunndd iinnsseerrttBBoorrddeerrWWiiddtthh iinnsseerrttOOffffTTiimmee iinnsseerrttOOnnTTiimmee iinnsseerrttWWiiddtthh sseelleeccttBBaacckkggrroouunndd sseelleeccttBBoorrddeerrWWiiddtthh sseelleeccttFFoorreeggrroouunndd See the "options" manual entry for details on the standard options. AASSSSOOCCIIAATTEEDD OOPPTTIIOONNSS tteexxttBBaacckkggrroouunndd tteexxttFFoonntt

See the "entryfield" widget manual entry for details on the above asso-

ciated options. llaabbeellFFoonntt See the "labeledwidget" widget manual entry for details on the above associated options. aaccttiivveeRReelliieeff eelleemmeennttBBoorrddeerrWWiiddtthh jjuummppttrroouugghhCCoolloorr See the "scrollbar" widget class manual entry for details on the above associated options. tteexxttBBaacckkggrroouunndd tteexxttFFoonntt See the "scrolledlistbox" widget manual entry for details on the above associated options.

WWIIDDGGEETT-SSPPEECCIIFFIICC OOPPTTIIOONNSS

Name: aauuttoommoouunntt Class: AAuuttoommoouunntt

Command-Line Switch: -aauuttoommoouunntt

Specifies a list of directory prefixes to ignore. Typically, this option would be used as follows:

-automount {export tmpmnt}

Name: cchhiillddSSiitteePPooss Class: PPoossiittiioonn

Command-Line Switch: -cchhiillddssiitteeppooss

Specifies the position of the child site in the selection box: nn, ss, ee, ww, ttoopp, bboottttoomm, or cceenntteerr. The default is s. 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: ddiirreeccttoorryy Class: DDiirreeccttoorryy

Command-Line Switch: -ddiirreeccttoorryy

Specifies the initial default directory. The default is the present working directory. Name: ddiirrSSeeaarrcchhCCoommmmaanndd Class: CCoommmmaanndd

Command-Line Switch: -ddiirrsseeaarrcchhccoommmmaanndd

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: ddiirrssLLaabbeell Class: TTeexxtt

Command-Line Switch: -ddiirrssllaabbeell

Specifies the text of the label for the directory list. The default is "Directories". Name: ddiirrssOOnn Class: DDiirrssOOnn

Command-Line Switch: -ddiirrssoonn

Specifies whether or not to display the directory list. The

value may be given in any of the forms acceptable to TTccllGGeett-

BBoooolleeaann. The default is true. Name: ffiilleeSSeeaarrcchhCCoommmmaanndd Class: CCoommmmaanndd

Command-Line Switch: -ffiilleesseeaarrcchhccoommmmaanndd

Specifies a Tcl command to be executed to perform a file search.

The command will receive the current working directory and fil-

ter mask as arguments. The command should return a list of files which will be placed into the file list. Name: ffiilleessLLaabbeell Class: TTeexxtt

Command-Line Switch: -ffiilleessllaabbeell

Specifies the text of the label for the files list. The default is "Files". Name: ffiilleessOOnn Class: FFiilleessOOnn

Command-Line Switch: -ffiilleessoonn

Specifies whether or not to display the files list. The value may be given in any of the forms acceptable to TTccllGGeettBBoooolleeaann. The default is true. Name: ffiilleeTTyyppee Class: FFiilleeTTyyppee

Command-Line Switch: -ffiilleettyyppee

Specify the type of files which may appear in the file list: rreegguullaarr, ddiirreeccttoorryy, or aannyy. The default is regular. Name: ffiilltteerrCCoommmmaanndd Class: CCoommmmaanndd

Command-Line Switch: -ffiilltteerrccoommmmaanndd

Specifies a Tcl command to be executed upon hitting the Return key in the filter entry widget. Name: ffiilltteerrLLaabbeell Class: TTeexxtt

Command-Line Switch: -ffiilltteerrllaabbeell

Specifies the text of the label for the filter entry field. The default is "Filter". Name: ffiilltteerrOOnn Class: FFiilltteerrOOnn

Command-Line Switch: -ffiilltteerroonn

Specifies whether or not to display the filter entry. The value may be given in any of the forms acceptable to TTccllGGeettBBoooolleeaann. The default is true. Name: hheeiigghhtt Class: HHeeiigghhtt

Command-Line Switch: -hheeiigghhtt

Specifies the height of the selection box. The value may be specified in any of the forms acceptable to TkGetPixels. The default is 360 pixels. Name: iinnvvaalliidd Class: CCoommmmaanndd

Command-Line Switch: -iinnvvaalliidd

Command to be executed should the filter contents be proven invalid. The default is {bell}. Name: mmaasskk Class: MMaasskk

Command-Line Switch: -mmaasskk

Specifies the initial file mask string. The default is "*". Name: nnooMMaattcchhSSttrriinngg Class: NNooMMaattcchhSSttrriinngg

Command-Line Switch: -nnoommaattcchhssttrriinngg

Specifies the string to be displayed in the files list should no files match the mask. The default is "". Name: sseelleeccttDDiirrCCoommmmaanndd Class: CCoommmmaanndd

Command-Line Switch: -sseelleeccttddiirroommmmaanndd

Specifies a Tcl command to be executed following selection of a directory in the directory list. Name: sseelleeccttFFiilleeCCoommmmaanndd Class: CCoommmmaanndd

Command-Line Switch: -sseelleeccttffiilleeoommmmaanndd

Specifies a Tcl command to be executed following selection of a file in the files list. Name: sseelleeccttiioonnCCoommmmaanndd Class: CCoommmmaanndd

Command-Line Switch: -sseelleeccttiioonnccoommmmaanndd

Specifies a Tcl command to be executed upon hitting the Return key in the selection entry widget. Name: sseelleeccttiioonnLLaabbeell Class: TTeexxtt

Command-Line Switch: -sseelleeccttiioonnllaabbeell

Specifies the text of the label for the selection entry field. The default is "Selection". Name: sseelleeccttiioonnOOnn Class: SSeelleeccttiioonnOOnn

Command-Line Switch: -sseelleeccttiioonnoonn

Specifies whether or not to display the selection entry. The

value may be given in any of the forms acceptable to TTccllGGeett-

BBoooolleeaann. The default is true. Name: wwiiddtthh Class: WWiiddtthh

Command-Line Switch: -wwiiddtthh

Specifies the width of the selection box. The value may be specified in any of the forms acceptable to TkGetPixels. The default is 470 pixels.

DESCRIPTION

The iiwwiiddggeettss::::ffiilleesseelleeccttiioonnbbooxx command creates a file selection box similar to the OSF/Motif standard Xmfileselectionbox composite 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 wid-

get. MMEETTHHOODDSS The iiwwiiddggeettss::::ffiilleesseelleeccttiioonnbbooxx command creates a new Tcl command whose

name is pathName. This command may be used to invoke various opera-

tions on the widget. It has the following general form: pathName option ?arg arg ...? Option and the args determine the exact behavior of the command. The following commands are possible for fileselectionbox widgets:

WWIIDDGGEETT-SSPPEECCIIFFIICC MMEETTHHOODDSS

pathName ccggeett option Returns the current value of the configuration option given by

option. Option may have any of the values accepted by the iiwwiidd-

ggeettss::::ffiilleesseelleeccttiioonnbbooxx command. pathName cchhiillddssiittee Returns the child site widget path name. pathName ccoonnffiigguurree ?option? ?value option value ...? Query or modify the configuration options of the widget. If no

option is specified, returns a list describing all of the avail-

able options for pathName (see TTkkCCoonnffiigguurreeIInnffoo for information on the format of this list). If option is specified with no value, 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 option is specified). If one or

more option-value 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. Option may have any

of the values accepted by the iiwwiiddggeettss::::ffiilleesseelleeccttiioonnbbooxx com-

mand. pathName ffiilltteerr Update the current contents of the file selection box based on the current filter entry field value. pathName ggeett Returns the current value of the selection entry widget. CCOOMMPPOONNEENNTTSS Name: ddiirrss Class: SSccrroolllleeddlliissttbbooxx

The dirs component is the directory list box for the file selec-

tion box. See the "scrolledlistbox" widget manual entry for details on the dirs component item. Name: ffiilleess Class: SSccrroolllleeddlliissttbbooxx 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: ffiilltteerr Class: EEnnttrryyffiieelldd 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: sseelleeccttiioonn Class: EEnnttrryyffiieelldd The selection component is the entry field for user input of the

currently selected file value. See the "entryfield" widget man-

ual entry for details on the selection component item. EEXXAAMMPPLLEE package require Iwidgets 4.0 iwidgets::fileselectionbox .fsb

pack .fsb -padx 10 -pady 10 -fill both -expand yes

AUTHOR(S) Mark L. Ulferts KKEEYYWWOORRDDSS fileselectionbox, widget Tk iwidgets::fileselectionbox(1)