Google

CCP4 web logo CCP4i: Graphical User Interface
Documentation for Programmers
CreateLabinLine

next button previous button top button

NAME

CreateLabinLine - draw a line for the user to select labelled columns from an input file

SYNOPSIS

CreateLabinLine line_id message_text filenameVar label column_labelVar priority_name_list

Optional Arguments:

-sigma label2 column_labelVar2 priority_name_list2
-help help_target
-toggle_display controlVar status control_value_list

DESCRIPTION

Create a line which enables the user to select labelled columns from a list of the appropriate columns extracted from the input file. Return the id of the line line_id. The line is drawn with a text label label and the message message_text will appear in the message line when the cursor is over the input widgets in the line. filenameVar is the name of the variable which will contain the name of the input file. When an input file is selected, it is read and the names of the labelled columns are stored in the CCP4i program.

CreateLabelLine will create one or (if the -sigma argument is used) two menus which list all labelled columns in the input MTZ file of the appropriate type for the variable column_labelVar. The appropriate type depends on the data type of the variable which is set in the taskname.def file. The first column label of the appropriate type will be set as the default value for column_labelVar unless the MTZ file contains a label with one of the names listed in priority_name_list in which case it is set as the default. The priority_name_list can be useful if, for example, you know the user probably wants to select the FP but is not useful in other instances when it can be set to "".

-sigma label2 column_labelVar2 priority_name_list2
The labin line can have a second menu to select a second labelled column column_labelVar2 which is the sigma or weight of the first column_labelVar. The second variable will be updated automatically to keep in sync when the user changes the first. The second menu has a label label2 and can have a priority_name_list2 (I'm not sure this is useful).
-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 any widget in the line
-toggle_display controlVar status control_value_list
Whether the line is displayed is dependent on the value of the parameter called controlVar. 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 control_var is not one of those in the control_value_list.

KEYWORDS