Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

donechoice - Function

	Package	display
	Module	guiutils

A choice dialog appropriate for done()

Synopsis
donechoice(description, widgetset)

include "choice.g"

Description
This is a choice appropriate for use with a tool done function. Done which may be invoked by pressing a ``Done'' button on the tool GUI. Since done is used to destroy the tool, it is often desirable to ensure that the user really meant to invoke that function. This function exists so that the choice dialog boxes used with done all have a similar appearance. Only the descriptive text will vary.

This function returns a boolean T if the user has pressed the "yes" button. In all other cases, a F will be returned.

Arguments

description		Descriptive text for the choices
		Allowed:	string
widgetset		Which widgetserver to use
		Allowed:	widgetserver
		Default:	dws

Returns
boolean

Example

amidone := donechoice();
if (amidone) {print 'This tool has been destroyed';};