[Previous]
[Next]
NAME:
XDISPLAYFILE
PURPOSE:
Display an ASCII text file using widgets and the widget manager.
CATEGORY:
Widgets.
CALLING SEQUENCE:
XDISPLAYFILE, Filename
INPUTS:
Filename: A scalar string that contains the filename of the file
to display. The filename can include a path to that file.
KEYWORD PARAMETERS:
BLOCK: Set this keyword to have XMANAGER block when this
application is registered. By default the Xmanager
keyword NO_BLOCK is set to 1 to provide access to the
command line if active command line processing is available.
Note that setting BLOCK for this application will cause
all widget applications to block, not only this
application. For more information see the NO_BLOCK keyword
to XMANAGER.
DONE_BUTTON: the text to use for the Done button. If omitted,
the text "Done with <filename>" is used.
EDITABLE: Set this keyword to allow modifications to the text
displayed in XDISPLAYFILE. Setting this keyword also
adds a "Save" button in addition to the Done button.
FONT: The name of the font to use. If omitted use the default
font.
GROUP: The widget ID of the group leader of the widget. If this
keyword is specified, the death of the group leader results in
the death of XDISPLAYFILE.
HEIGHT: The number of text lines that the widget should display at one
time. If this keyword is not specified, 24 lines is the
default.
TEXT: A string or string array to be displayed in the widget
instead of the contents of a file. This keyword supercedes
the FILENAME input parameter.
TITLE: A string to use as the widget title rather than the file name
or "XDisplayFile".
WIDTH: The number of characters wide the widget should be. If this
keyword is not specified, 80 characters is the default.
WTEXT: Output parameter, the id of the text widget. This allows
setting text selections and cursor positions programmatically.
OUTPUTS:
No explicit outputs. A file viewing widget is created.
CALLED BY:
BCS, BIGPICKFILE, CDSPICKFILE, CW_ANIMATE2, CW_POS, FCS, GET_PT, MK_SUMER_CAT, NRHRCAL
PICKFILE, PICKFONT use to be XFONT, POINTING3, ROUTINE_NAME [4]
ROUTINE_NAME [7], STARFIELD, SUMER_SEARCH_PD_EVENT, SUMER_TOOL_PD_EVENT
WBDA [1], WBDA [2], WBSC_LTC_EV [1], WBSC_LTC_EV [2], WIMG_INFO1, WIMG_INFO2
WIMG_INFO4, WINFO_ACTIV, WLISTER, WLOAD, WLOADC, XLOAD, XLOADCT [1], XLOADCT [2]
XLOADCT [3], XSEL_PD_EVENT, eis_view_study_descriptions [1]
eis_view_study_descriptions [2]
SIDE EFFECTS:
Triggers the XMANAGER if it is not already in use.
RESTRICTIONS:
None.
PROCEDURE:
Open a file and create a widget to display its contents.
MODIFICATION HISTORY:
Written By Steve Richards, December 1990
Graceful error recovery, DMS, Feb, 1992.
12 Jan. 1994 - KDB
If file was empty, program would crash. Fixed.
4 Oct. 1994 MLR Fixed bug if /TEXT was present and /TITLE was not.
2 jan 1997 DMS Added DONE_BUTTON keyword, made Done
button align on left, removed padding.
[Previous]
NAME:
XDISPLAYFILE
PURPOSE:
Display an ASCII text file using widgets and the widget manager.
CATEGORY:
Widgets.
CALLING SEQUENCE:
XDISPLAYFILE, Filename
INPUTS:
Filename: A scalar string that contains the filename of the file
to display. The filename can include a path to that file.
KEYWORD PARAMETERS:
BLOCK: Set this keyword to have XMANAGER block when this
application is registered. By default the Xmanager
keyword NO_BLOCK is set to 1 to provide access to the
command line if active command line processing is available.
Note that setting BLOCK for this application will cause
all widget applications to block, not only this
application. For more information see the NO_BLOCK keyword
to XMANAGER.
DONE_BUTTON: the text to use for the Done button. If omitted,
the text "Done with <filename>" is used.
EDITABLE: Set this keyword to allow modifications to the text
displayed in XDISPLAYFILE. Setting this keyword also
adds a "Save" button in addition to the Done button.
FONT: The name of the font to use. If omitted use the default
font.
GROUP: The widget ID of the group leader of the widget. If this
keyword is specified, the death of the group leader results in
the death of XDISPLAYFILE.
HEIGHT: The number of text lines that the widget should display at one
time. If this keyword is not specified, 24 lines is the
default.
TEXT: A string or string array to be displayed in the widget
instead of the contents of a file. This keyword supercedes
the FILENAME input parameter.
TITLE: A string to use as the widget title rather than the file name
or "XDisplayFile".
WIDTH: The number of characters wide the widget should be. If this
keyword is not specified, 80 characters is the default.
WTEXT: Output parameter, the id of the text widget. This allows
setting text selections and cursor positions programmatically.
OUTPUTS:
No explicit outputs. A file viewing widget is created.
CALLED BY:
BCS, BIGPICKFILE, CDSPICKFILE, CW_ANIMATE2, CW_POS, FCS, GET_PT, MK_SUMER_CAT, NRHRCAL
PICKFILE, PICKFONT use to be XFONT, POINTING3, ROUTINE_NAME [4]
ROUTINE_NAME [7], STARFIELD, SUMER_SEARCH_PD_EVENT, SUMER_TOOL_PD_EVENT
WBDA [1], WBDA [2], WBSC_LTC_EV [1], WBSC_LTC_EV [2], WIMG_INFO1, WIMG_INFO2
WIMG_INFO4, WINFO_ACTIV, WLISTER, WLOAD, WLOADC, XLOAD, XLOADCT [1], XLOADCT [2]
XLOADCT [3], XSEL_PD_EVENT, eis_view_study_descriptions [1]
eis_view_study_descriptions [2]
SIDE EFFECTS:
Triggers the XMANAGER if it is not already in use.
RESTRICTIONS:
None.
PROCEDURE:
Open a file and create a widget to display its contents.
MODIFICATION HISTORY:
Written By Steve Richards, December 1990
Graceful error recovery, DMS, Feb, 1992.
12 Jan. 1994 - KDB
If file was empty, program would crash. Fixed.
4 Oct. 1994 MLR Fixed bug if /TEXT was present and /TITLE was not.
2 jan 1997 DMS Added DONE_BUTTON keyword, made Done
button align on left, removed padding.