<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

Utilities/

report.pro

Like DIALOG_MESSAGE if there is already some widget active or like MESSAGE if there is not any widget active. To ask a question whose answer is not yes/no, use xquestion.

topreport

result = report(textin, DEFAULT_NO=DEFAULT_NO, PARENT=PARENT, QUESTION=QUESTION, SIMPLE=SIMPLE, _EXTRA=_EXTRA)

Return value

-1 if the keyword QUESTION is not activated If the keyword QUESTION is activated, return 1 for yes and 0 for no.

Parameters

textin        in required type: scalar string or arrays of string

If TEXTIN is a scalar string, we look for the line feed character "!C". If TEXTIN is set to an array of strings, each array element is displayed as a separate line of text.

Keywords

DEFAULT_NO        default: "Yes"

Set this keyword to make the "No" button the default selection for "Question" dialog.

PARENT       

same as DIALOG_PARENT of DIALOG_MESSAGE

QUESTION        default: "Warning"

Set this keyword to create a "Question" dialog.

SIMPLE       

activate to print only the message without the name and the line of the routine (defined by calling routine_name) or++ Activate to print the error message without printing the routine name with its full path.

_EXTRA       

Used to pass keywords to DIALOG_MESSAGE and MESSAGE

Examples

If there is not any widget activated: IDL> help, report('toto tata') % $MAIN$: toto tata INT = -1 IDL> help, report('does it works ?',/question) does it works ? y/n (default answer is y) BYTE = 1 IDL> help, report('question1: !C does it works ?',/question) question1: does it works ? y/n (default answer is y) BYTE = 1 If widgets are already activated, it is the same thing but with widgets!

Version history

Version

$Id: report.pro 277 2007-09-04 12:30:58Z smasson $

History

Sebastien Masson (smasson@lodyc.jussieu.fr) 21/10/1999

Statistics

McCabe cyclic 16
McCabe essential 1
McCabe modular design 1
Produced by IDLdoc 2.0.