Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

restoreregions - Constructor

	Package	display
	Module	widgets
	Tool	restoreregions

Construct a restoreregions widget

Synopsis
restoreregions(parent, table, changenames, globalrestore, widgetset)

Arguments

parent		Parent of the widget
		Allowed:	Widget
		Default:	F
table		The table of interest
		Allowed:	Table tool, image tool or string
		Default:	''
changenames		Entry boxes to enable region name changes are provided
		Allowed:	T or F
		Default:	T
globalrestore		Restore to global name space or a record
		Allowed:	T or F
		Default:	F
widgetset		The widget server to use
		Allowed:	widgetserver tool
		Default:	dws

Returns
Agent

Description

This is the constructor. If parent=F, then the widget will make its own parent frame.

The Table can be specified in many ways; a Table tool, an Image) tool, the name of a Table (a string) which might be an AIPS++ image, or the name of a Glish symbol which is either a Table or an Image tool.

If changenames=T, when you select regions, entry boxes which enable you to change the names of the regions on restore are provided.

If globalrestore=T, the regions are restored to global name space (i.e. to Glish). Otherwise they are restored to a record which you recover with function regions.

Example

- include 'restoreregions.g'   
- r := restoreregions(table='hcn')
- whenever rr->restored do {
   regions := rr.regions();
  }

In this example, the widget is contructed with a Table called hcn. When the user has selected the regions, they are recovered into a record (because globalrestore=F). Each field of the record contains one region tool (see Regionmanager). The fields of that record are named according to the names of the regions in the table.