viewerstandardgui.unmap

Remove the graphical user interface from the screen

Synopsis
unmap(force)

Arguments

force	force unmap even if this `tool` seems to be unmapped already
	Allowed:	boolean
	Default:	F

Returns
boolean

Description

This function should be used to remove a graphical user interface from the screen. If the tool made its own top-level frame, then that entire frame will be removed from the screen. Otherwise, the next highest level frame will be removed from its parent frame, which itself may or may not be presently mapped to the screen.

A boolean value of T is returned if an action was taken to unmap the GUI. Otherwise, F is returned, implying that the tool believed itself to already be unmapped.

Next: viewerstandardgui.done - Function Up: viewerstandardgui - Tool Previous: viewerstandardgui.map - Function Contents Index

	Package	display
	Module	viewer
	Tool	viewerstandardgui

viewerstandardgui.unmap - Function