Google

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

next button previous button top button

NAME

OpenFolder - Begin defining the contents of a folder in a task interface window; set the status of the folder

SYNOPSIS

The OpenFolder command can take a varying amount of arguments, but these MUST be following one of four patterns:

  • OpenFolder folder_id
  • OpenFolder folder_id "closed"
  • OpenFolder folder_id control_var status control_value_list status
  • OpenFolder folder_id control_var status control_value_list status control_value_list status

DESCRIPTION

Begin the definition of the contents of folder folder_id where folder_id is either "protocol", "file" or an integer between 1 and the number of folder_titles given in the command CreateTaskWindow.

By default the folder will initially be "open" but it can be closed by adding the keyword closed to the arguments.

The status of the folder can be made dependent on the value of a variable control_var which is the name of an element in the array associated with the task. This variable should normally be one that is altered in the protocol section of the task window. The name of the control_var should be followed by a status keyword: open, closed or hide and then a list of values that the control_var may take (control_value_list). If the control_var has one of these values, the folder will adopt the status given by the status keyword. The arguments control_var, status, control_value_list will normally be followed by another status argument which defines the status of the folder when control_var does not have one of the values in control_value_list.

It is possible that, dependent on the value of control_var, the folder may adopt any of the three status options - the argument list should take the final form listed in the synopsis.

It is possible that you want the status to be dependent on two variables. The way to handle this is to specify a third variable to be used as control_var which does not appear on the interface but which is updated whenever the the other two variables are changed. You will need to create a procedure in your taskname.tcl file to update the control_var and call this procedure by associating a -command keyword with the the other two variables in the CreateLine command(s).

KEYWORDS