>  Docs Center  >  Libraries  >  JHU/APL/S1R  >  XHELP

XHELP

XHELP

Name


      XHELP

Purpose


      Widget to display given help text.

Category


Calling Sequence


      xhelp, txt

Inputs


      txt = String array with help text to display. in

Keyword Parameters


Keywords


        TITLE=txt title text or text array (def=none).
        LINES=lns maximum number of lines to display
          before added a scroll bar (def=30).
        XSIZE=xs Width of text area in characters (def=max needed).
        /SCROLL force scroll bars. Useful if new text will
          displayed later.
        /BOTTOM Put buttons at the bottom instead of top.
        EXIT_TEXT=txt Exit button text (def=Quit help).
        SAVE=file If a file name is given a SAVE button is
          added and the contents may be saved. Given name is
          used as the default.
        TEXT2=txt2 A text array to display when the text2 button is clicked.
        T2LABEL=t2lab Label for the text2 button (def=text2).
          Clicking this button will replace the displayed text with the text
          in the array txt2. txt2 must be given for this button to appear.
        WID=id returned widget ID of help widget. This
          allows the help widget to be automatically
          destroyed after action occurs.
        TID=tid returned widget ID of text area. This
          allows text to be updated from outside this routine.
          widget_control,tid,set_val=new_text,xsize=xs,ysize=ys
          New x and y sizes may optionally be set.
        TTID=ttid returned widget ID of the title (-1 if no title).
          Title may be changed: widget_control,ttid,set_val=new
        /NOWAIT means do not wait for exit button to be
          pressed. Use with WID for to display help.
        /WAIT means wait for OK button without using xmanager
          to register xhelp. Will not drop through if button
          is not pressed as in default case.
        GROUP_LEADER=grp Assign a group leader to this
          widget. When the widget with ID group is destroyed
          this widget is also.
        XOFFSET=xoff, YOFFSET=yoff Widget position.

Outputs


Common Blocks


Notes


Modification History


      R. Sterner, 29 Sep, 1993
      R. Sterner, 18 Oct, 1993 --- Added LINES and event handler.
      R. Sterner, 1994 Feb 21 --- Changed title text.
      R. Sterner, 1994 Sep 7 --- Added /WAIT keyword.
      R. Sterner, 1998 Jun 4 --- Added /NO_BLOCK to xmanager.
      R. Sterner, 1998 Jul 27 --- Added SAVE=sv option.
      R. Sterner, 2002 Jun 12 --- Minor help text fix.
      R. Sterner, 2002 Jun 28 --- Added XOFFSET, YOFFSET.
      R. Sterner, 2002 Oct 28 --- Added TID=tid, TTID=ttid, & /SCROLL keywds.
      R. Sterner, 2003 Sep 23 --- Changed help to drop use /wait with save=sv.
      R. Sterner, 2003 Oct 28 --- Minor help text change.
      R. Sterner, 2004 Jan 08 --- Added XSIZE=xs.
      R. Sterner, 2005 Jun 21 --- Added Text 2 button. Buttons now at top.
      R. Sterner, 2005 Jul 26 --- Fixed missing txt2.
      R. Sterner, 2007 Jul 31 --- Added /BOTTOM.
      R. Sterner, 2007 Sep 11 --- Added another space in top title.
      R. Sterner, 2010 Jun 04 --- Converted arrays from () to [].
      R. Sterner, 2010 Jul 21 --- Added the COMMAND button to spawn commands.
  Copyright (C) 1993, 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.



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us