 |
CCP4i: Graphical User Interface |
| Documentation for Programmers | |
| CreateOutputFileLine |
|
NAME
CreateOutputFileLine - draw a line for the user to select output file
SYNOPSIS
CreateOutputFileLine line_id message_text label filenameVar dirVar ?args?
Optional Arguments:
-help help_target
-toggle_display controlVar status control_value_list
DESCRIPTION
Create a line with the components of a 'file' line: default projects menu, an entry field, access to a file browser and access to a file viewer and return the id of the line line_id. The line will be drawn with a label label (which should be short) and the text message_text will be displayed in the message line when the mouse is over the entry field. This message text should be a short description of what the file is required for, and give any program keyword which might help a user who is familiar with the program.
There are two variables associated with each file line: the name of the selected file, filenameVar, and the name of the default directory for the file, dirVar. The dirVar is associated with a menu which lists the project directories defined by the user and the scratch directory. The initial input value of dirVar is set in the taskname.def file and should usually be "" (i.e. null); the CCP4i program will then set it to the current default project directory.
- -help help_target
- The user can access on-line help by clicking the right mouse button on a widget. The help file is defined by the preceding SetProgramHelpFile command. The help_target is the target within that file to go to when the user clicks on he entry field in this line.
- -toggle_display controlVar status control_value_list
- Whether the line is displayed, is dependent on the value of the parameter called controlVar. status can have the values open or hide. If the value of controlVar is one of the values in control_value_list, the line will be displayed if status is open or hidden if status is hide. The opposite status will be adopted if the value of controlVar is not one of those in the control_value_list.