Documentation for /home/davin/idl/socware/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

external/CDAWlib/

cdaweb_xdisplayfile.pro


Routines

Routines from cdaweb_xdisplayfile.pro

XDISPLAYFILE_write, wText, filename
XDISPLAYFILE_event, event
XDisplayFileGrowToScreen, tlb, text, height, nlines
cdaweb_XDisplayFile, FILENAME, TITLE=TITLE, GROUP=GROUP, WIDTH=WIDTH, HEIGHT=HEIGHT, TEXT=TEXT, FONT=FONT, DONE_BUTTON=DONE_BUTTON, MODAL=MODAL, EDITABLE=EDITABLE, GROW_TO_SCREEN=GROW_TO_SCREEN, WTEXT=WTEXT, BLOCK=BLOCK, RETURN_ID=RETURN_ID

NAME: XDISPLAYFILE PURPOSE: Display an ASCII text file using widgets and the widget manager.

Routine details

top source XDISPLAYFILE_write

XDISPLAYFILE_write, wText, filename

Parameters

wText
filename

top source XDISPLAYFILE_event

XDISPLAYFILE_event, event

Parameters

event

top source XDisplayFileGrowToScreen

XDisplayFileGrowToScreen, tlb, text, height, nlines

Parameters

tlb
text
height
nlines

top source cdaweb_XDisplayFile

cdaweb_XDisplayFile, FILENAME, TITLE=TITLE, GROUP=GROUP, WIDTH=WIDTH, HEIGHT=HEIGHT, TEXT=TEXT, FONT=FONT, DONE_BUTTON=DONE_BUTTON, MODAL=MODAL, EDITABLE=EDITABLE, GROW_TO_SCREEN=GROW_TO_SCREEN, WTEXT=WTEXT, BLOCK=BLOCK, RETURN_ID=RETURN_ID

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 " 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. GROW_TO_SCREEN: If TRUE, the length of the display area is grown to show as much of the text as possible without being too large to fit on the screen. In this case, HEIGHT sets the lower bound on the size instead of setting the size itself. 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. RETURN_ID : A variable to be set to the widget ID of the top level base of the resulting help application. 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. 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. 19 Nov 2004, GROW_TO_SCREEN and RETURN_ID keywords. Allow for user to resize display. General updating.

Parameters

FILENAME

Keywords

TITLE
GROUP
WIDTH
HEIGHT
TEXT
FONT
DONE_BUTTON
MODAL
EDITABLE
GROW_TO_SCREEN
WTEXT
BLOCK
RETURN_ID

File attributes

Modification date: Tue Oct 21 13:53:47 2014
Lines: 183