XTXTIN Name
XTXTIN Purpose
Widget based text input. Category
Calling Sequence
xtxtin, out Inputs
Keyword Parameters
Keywords
TITLE=tt Widget title text (def="Enter text").
May be a text array.
DEFAULT=def Initial text string (def=null).
GROUP_LEADER=g Give group leader (needed if called
from another widget routine). Can use the top level
base wid of the calling routine.
XSIZE=text entry area size in characters (minimum).
YSIZE=text entry area number of lines (def=1).
If YSIZE used then must exit with 'Accept Entry' button.
XOFFSET=xoff, YOFFSET=yoff Widget position.
OK=ok_txt Text for OK button (def="Accept entry").
CLEAR=clr_txt Text for Clear button (def="Clear text").
CANCEL=cnc_txt Text for Cancel button (def="Cancel entry").
Extra buttons, 3 sets, all optional:
MENU=txt Text array of labels for added menu buttons.
Clicking a menu button returns its label text.
/ROW means add menu buttons in a row (use short labels).
/TOP means put menu buttons on top (def=bottom).
MBLAB=mblab Label for menu button (def="-").
Presets: Dropdown menu button with preset text.
Clicking puts new text in text area from pvals.
PTITLE=pttl Title on preset text button (scalar).
PTAGS=ptags Text array with short tags for preset text.
PVALS=pvals Text array of preset text strings (def=PTAGS).
Must give at least PTITLE and PTAGS to use preset text.
Extra command buttons: may give a few extra command
buttons that look like the OK, CLEAR, and CANCEL
buttons. Returns value when clicked.
XTAGS=xtags Text array with button labels.
XVALS=xvals Text array with text to return (def=XTAGS).
May also have optional flags:
FTAG=ftag Flag label(s).
FDEF=fdef Flag default setting(s) (0 or 1).
FOUT=fout Returned flag setting(s).
Outputs
out = Returned text string (null for CANCEL). out
Common Blocks
Notes
Modification History
R. Sterner, 1994 Mar, 14
R. Sterner, 1995 Mar 21 --- Added optional buttons.
R. Sterner, 1998 Jun 3 --- Added xoff, yoff.
R. Sterner, 2000 Aug 22 --- Added preset text keywords.
R. Sterner, 2000 Aug 30 --- Ignored null strings for ptags.
R. Sterner, 2002 Jun 14 --- Allowed custom button labels.
R. Sterner, 2002 Jun 25 --- Added extra command buttons.
R. Sterner, 2002 Jul 17 --- Added optional flags.
R. Sterner, 2002 Jul 19 --- Fixed bug and cleaned up.
R. Sterner, 2002 Sep 06 --- Added /ROW and MBLAB= keywords.
R. Sterner, 2004 Apr 29 --- Upgraded to IDL5+ modal method.
R. Sterner, 2004 Jul 13 --- Allowed multiline input (YSIZE).
R. Sterner, 2006 Mar 03 --- Fixed problem when calling from a widget.
R. Sterner, 2010 May 07 --- Converted arrays from () to [].
Copyright (C) 1994, Johns Hopkins University/Applied Physics Laboratory
This software may be used, copied, or redistributed as long as it is not
sold and this copyright notice is reproduced on each copy made. This
routine is provided as is without any express or implied warranties
whatsoever. Other limitations apply as described in the file disclaimer.txt.