CCP4i: Graphical User Interface
	Documentation for Programmers
	CreateInputFileLine

NAME

CreateInputFileLine - draw a line for the user to select input file

SYNOPSIS

CreateInputFileLine line_id message_text label filenameVar dirVar ?args?

Optional Arguments:

-help help_target
-toggle_display controlVar status control_value_list
-filout filenameVar dirVar append_text
-setfileparam parameter_type parameterVar
-setlabin labinVar priority_labels

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 statusopen 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.

-filout filenameVar dirVar append_text

After the user has selected the input file, derive a name for the output file name in the variable filenameVar. The output file name will have the directory path for the default directory in dirVar. The file root will be copied from the input file name with the string append_text added. For example, the append_text may include the name of the program (e.g. '_refmac'). If you do not want to append anything, set append_text to '--'. The file extension will be the appropriate one for the data type for the output file. Do NOT use this option if it is liable to derive an output file name which is the same as the input file name.

-setfileparam parameter_type parameterVar

If the input file is of data type _MTZ_file or _pdb_file, it will be read and some key crystallographic data will be saved within the CCP4i program. This data can be used to initialise variables with the task interface. For each variable to be initialised, use the -setfileparam keyword followed by the parameter_type (see below) and the name of the variable parameterVar

-setlabin labinVar priority_labels

For an MTZ input file, the names and types of column labels are extracted and used to initialise the menus defined by the CreateLabinLine command. It is not necessary to use the -setlabin keyword for any labinVar used in CreateLabinLine. Not finished

KEYWORDS

DATA EXTRACTED FROM INPUT FILES

From MTZ Files

CELL_1

CELL_2

CELL_3

CELL_4

CELL_5

CELL_6

RESOLUTION_MIN

RESOLUTION_MAX

SPACE_GROUP_NAME

SPACE_GROUP_NUMBER

From PDB Files

SPACE_GROUP_NAME