Google

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

next button previous button top button

NAME

CreateTaskWindow - Open a window of the usual format for task interfaces

SYNOPSIS

CreateTaskWindow arrayname title icon_name folder_titles

Optional Arguments:

-action_buttons button_keyword_list
-help_file help_filename

DESCRIPTION

This command is used at the beginning of the taskname_task_window procedure in the taskname.tcl file. It will open a task interface window with the title title and icon name icon_name and n folders where n is the length of the list folder_titles. The folders will have the titles given in folder_titles. The command will also initialise the parameters in the array arrayname by reading the $CCP4_top/tasks/taskname.def file and (if it exists) the user's project default taskname.def. The array arrayname is also used to store status parameters set up by this command and subsequent commands such as CreateExtendingFrame.

By default the window will have the action buttons Run, Save&Restore and Close at the bottom of the window. This can be changed with the optional argument -action_buttons which should be followed by a list of button keywords chosen from:

quit
button text is Exit or Close - close the window
save
Save&Restore - options to save to or restore from .def file
exit
Save&Exit - save current parameters to project default .def file and exit window
run
Run - options to run task

The buttons will be arranged in the reverse order to that given in the button_keyword_list.

By default, the help file accessed from the Help button at the top right of the task interface window is that for the module to which the task belongs (as defined in the $CCP4I_top/etc/modules file) but an alternative help file name can be given after the argument -help_file.

After this command the command OpenFolder must be used before defining the interface with CreateLine, CreateInputFileLine etc.

KEYWORDS