Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

viewerdisplaypanel.addgui - Function

	Package	display
	Module	viewer
	Tool	viewerdisplaypanel

Add various GUI components to this Viewerdisplaypanel tool

Synopsis
addgui(guihasmenubar, guihascontrolbox, guihasanimator, guihasbuttons, hasdismiss, hasdone, isolationmode)

Arguments

guihasmenubar		add a menu bar (top)?
		Allowed:	boolean
		Default:	T
guihascontrolbox		add a control box (left)?
		Allowed:	boolean
		Default:	T
guihasanimator		add an animator/tapedeck (right)?
		Allowed:	boolean
		Default:	T
guihasbuttons		add buttons (bottom)?
		Allowed:	boolean
		Default:	T
hasdismiss		add a ``Dismiss'' button to the GUI?
		Allowed:	unset or boolean
		Default:	unset
hasdone		add a ``Done'' button to the GUI?
		Allowed:	unset or boolean
		Default:	unset
isolationmode		prevent user accessing other components of this Viewer tool?
		Allowed:	boolean
		Default:	F

Returns
T

Description

This function can be used to add specified graphical user interface components to an existing Viewerdisplaypanel tool. This function can only be called once per Viewerdisplaypanel tool, so get it right the first time!

If both hasdismiss and hasdone are given as T, then a warning will be emitted, and hasdismiss will be forcibly set to F. If both hasdismiss and hasdone are left unset, then hasdone will be forcibly set to T and hasdismiss to F. If only one of these two arguments is specified, and the other left unset, then the unset argument will default to the opposite of the given argument.

If isolationmode is T, then the GUI added to the Viewerdisplaypanel toolwill not provide the user with the buttons or menu items to create new Viewerdisplaypanel tools or Viewerdatamanager tools. Typically this option should be used whenever a non-global Viewer tool is constructed.

See the GUI description on hpw to operate the GUI.