hwtk::openfileentry

Pop up a dialog box for the user to select a file to open or save.

Format

hwtk::openfileentry - pathName ?option value? …

Description

Its purpose is for the user to select an existing file only. If the user enters a non-existent file, the dialog box gives the user an error prompt and requires the user to give an alternative selection. If an application allows the user to create new files, it should do so by providing a separate New menu command.

Standard Options

-clientdata
Database name: clientData
Database class: ClientData
Acts as a data storage for a widgets. User can store any data and this will not have any effect on widget property.
-cursor
Database name: cursor
Database class: Cursor
Specifies the mouse cursor to be used for the widget. See Tk_GetCursor and cursors(n) in the Tk reference manual for the legal values. If set to the empty string (the default), the cursor is inherited from the parent widget.
-help
Database name: help
Database class: Text
Specifies the text or help message that displays when the cursor moves over the widget.
-helpcommand
Database name: helpcommand
Database class: Command
Dynamic help which calls an assigned -helpcommand when the user moves the mouse on the widget. The text which is returned by the -helpcommand will be in turn be displayed on the tooltip.
-marker
Database name: marker
Database class: Marker
Specifies the color of the marker decorator. Can be either info, error, or warning. If not specified, hide the marker.
-state
Database name: state
Database class: State
May be set to normal or disabled to control the disabled state bit.
-takefocus
Database name: takeFocus
Database class: TakeFocus
Determines whether the window accepts the focus during keyboard traversal. Either 0, 1, a command prefix (to which the widget path is appended, and which should return 0 or 1), or the empty string. See options(n) in the Tk reference manual for the full description.
-textvariable
Database name: textVariable
Database class: Variable
Specifies the name of a global variable. The value of the variable is a text string to be displayed inside the widget; if the variable value changes then the widget will automatically update itself to reflect the new value. The way in which the string is displayed in the widget depends on the particular widget and may be determined by other options, such as anchor or justify.
-width
Database name: width
Database class: Width
Specifies the width of a widget.

Widget-Specific Options

-buttonpos
Database name: buttonpos
Database class: Buttonpos
The position of the file browse button in relation to the file entry. Valid values are e, w, left and right.
-command
Database name: command
Database class: Command
A script to evaluate when the widget is invoked.
-defaultextension
Database name: defaultextension
Database class: Defaultextension
Specifies a string that will be appended to the filename if the user enters a filename without an extension. The default value is the empty string, which means no extension will be appended to the filename in any case. This option is ignored on Mac OS X, which does not require extensions to filenames, and the UNIX implementation guesses reasonable values for this from the -filetypes option when this is not supplied.
-filetypes
Database name: filetypes
Database class: Filetypes
If a File types listbox exists in the file dialog on the particular platform, this option gives the filetypes in this listbox. When the user choose a filetype in the listbox, only the files of that type are listed. If this option is unspecified, or if it is set to the empty list, or if the File types listbox is not supported by the particular platform then all files are listed regardless of their types. See Specify File Patterns below for a discussion on the contents of filePatternList.
-initialdir
Database name: initialdir
Database class: Initialdir
Specifies that the directories in directory should be displayed when the dialog pops up. If this parameter is not specified, then the directories in the current working directory are displayed. If the parameter specifies a relative path, the return value will convert the relative path to an absolute path.
-initialfile
Database name: initialfile
Database class: Initialfile
Specifies a filename to be displayed in the dialog when it pops up.
-invalidcommand
Database name: invalidCommand
Database class: InvalidCommand
A script template to evaluate whenever the validate command returns 0. See Validation for more information.
-justify
Database name: justify
Database class: Justify
Specifies how the text is aligned within the entry widget. One of left, center, or right.
-marker
Database name: marker
Database class: Marker
Specifies the color of the marker decorator. Can be either info, error, or warning. If not specified, hide the marker.
-multiple
Database name: multiple
Database class: Multiple
Allows the user to choose multiple files from the Open dialog.
-parent
Database name: parent
Database class: Parent
Makes window the logical parent of the dialog. The dialog is displayed on top of its parent window.
-show
Database name: show
Database class: Show
If this option is specified, then the true contents of the entry are not displayed in the window. Instead, each character in the entry’s value will be displayed as the first character in the value of this option, such as “*”. This is useful, for example, if the entry is to be used to enter a password. If characters in the entry are selected and copied elsewhere, the information copied will be what is displayed, not the true contents of the entry.
-title
Database name: title
Database class: Title
Specifies a string to display as the title of the dialog box. If this option is not specified, then a default title will be displayed.
-typevariable
Database name: typevariable
Database class: Typevariable
The global variable variableName is used to preselect which filter is used from filterList when the dialog box is opened and is updated when the dialog box is closed, to the last selected filter. The variable is read once at the beginning to select the appropriate filter. If the variable does not exist, or its value does not match any filter typename, or is empty ({}), the dialog box will revert to the default behavior of selecting the first filter in the list. If the dialog is canceled, the variable is not modified.
-validate
Database name: validate
Database class: Validate
Specifies the mode in which validation should operate: none, focus, focusin, focusout, key, or all. Default is none, meaning that validation is disabled. See Validation.
-validatecommand
Database name: validateCommand
Database class: ValidateCommand
A script template to evaluate whenever validation is triggered. If set to the empty string (the default), validation is disabled. The script must return a boolean value. See Validation.

Widget Command

pathName configure ?option? ?value option value …?
Query or modify the configuration options of the widget. 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. If option is specified with no value, then the command returns a list describing the named option: the elements of the list are the option name, database name, database class, default value, and current value. If no option is specified, returns a list describing all of the available options for pathName.
pathName cget option
Returns the current value of the configuration option given by option.
pathName identify element x y
Returns the name of the element under the point given by x and y, or an empty string if the point does not lie within any element. x and y are pixel coordinates relative to the widget. Some widgets accept other identify subcommands.
pathName instate statespec ?script?
Test the widget’s state. If script is not specified, returns 1 if the widget state matches statespec and 0 otherwise. If script is specified, equivalent to
if{[pathNameinstatestateSpec]}script
pathName state ?stateSpec?
Modify or inquire widget state. If stateSpec is present, sets the widget state: for each flag in stateSpec, sets the corresponding flag or clears it if prefixed by an exclamation point. Returns a new state spec indicating which flags were changed:
setchanges[pathNamestatespec]
pathNamestate$changes
will restore pathName to the original state. If stateSpec is not specified, returns a list of the currently-enabled state flags.
pathName bbox index
Returns a list of four numbers describing the bounding box of the character given by index. The first two elements of the list give the x and y coordinates of the upper-left corner of the screen area covered by the character (in pixels relative to the widget) and the last two elements give the width and height of the character, in pixels. The bounding box may refer to a region outside the visible area of the window.
pathName delete first ?last?
Delete one or more elements of the entry. First is the index of the first character to delete, and last is the index of the character just after the last one to delete. If last isn’t specified it defaults to first+1, that is, a single character is deleted. This command returns the empty string.
pathName get
Returns the entry’s string.
pathName icursor index
Arrange for the insert cursor to be displayed just before the character given by index. Returns the empty string.
pathName index string
Arrange for the insert cursor to be displayed just before the character given by index. Returns the empty string.
pathName insert index string
Insert string just before the character indicated by index. Returns the empty string.
pathName selection option arg
This command is used to adjust the selection within an entry. It has several forms, depending on option:
pathName selection clear
Clear the selection if it is currently in this widget. If the selection isn’t in this widget then the command has no effect. Returns the empty string.
pathName selection present
Returns 1 if there is are characters selected in the entry, 0 if nothing is selected.
pathName selection range start end
Sets the selection to include the characters starting with the one indexed by start and ending with the one just before end. If end refers to the same character as start or an earlier one, then the entry’s selection is cleared.
pathName set str
Sets the entry’s value to str.
pathName xview args
This command is used to query and change the horizontal position of the text in the widget’s window. It can take any of the following forms:
pathName xview
Returns a list containing two elements. Each element is a real fraction between 0 and 1; together they describe the horizontal span that is visible in the window. For example, if the first element is .2 and the second element is .6, 20% of the entry’s text is offscreen to the left, the middle 40% is visible in the window, and 40% of the text is offscreen to the right. These are the same values passed to scrollbars via the -xscrollcommand option.
pathName xview index
Adjusts the view in the window so that the character given by index is displayed at the left edge of the window.
pathName xview moveto fraction
Adjusts the view in the window so that the character fraction of the way through the text appears at the left edge of the window. fraction must be a fraction between 0 and 1.
pathName xview scroll number what
This command shifts the view in the window left or right according to number and what. Number must be an integer. What must be either units or pages. If what is units, the view adjusts left or right by number average width characters on the display; if it is pages then the view adjusts by number screenfuls. If number is negative then characters farther to the left become visible; if it is positive then characters farther to the right become visible.

Example

hwtk::dialog .d -title "::hwtk::openfileentry"
set w [.d recess]

grid [hwtk::label $w.11 -text Enabled] [hwtk::openfilentry $w.openFile1]
grid [hwtk::label $w.12 -text Disabled] [hwtk::openfilentry $w.openFile2 -state disabled]
grid [hwtk::label $w.13 -text Multiple] [hwtk::openfilentry $w.openFile3 -multiple 1]

.d post
$w.openfile configure -buttonpos left
$w.openfile configure -multiple 1

.d post