This page is a listing of the entire contents of this library for IDL. This listing is the long version. Viewing the much more compact listing may be handier.
NAME:
CCW_PICKF
PURPOSE:
This function allows the user to interactively pick a file. A file
selection tool with a graphical user interface is created. Files
can be selected from the current directory or other directories.
EXTERN LIBRARIES:
creasolib.tlb
CATEGORY:
Widgets.
CALLING SEQUENCE:
Result = ccw_pickf()
KEYWORD PARAMETERS:
GROUP: The widget ID of the widget that calls ccw_pickf. When this
ID is specified, a death of the caller results in the death of
the ccw_pickf widget application.
READ: Set this keyword to make the title of the ccw_pickf window
"Select File to Read".
WRITE: Set this keyword to make the title of the ccw_pickf window
"Select File to Write".
PATH: The initial path to select files from. If this keyword is
not set, the current directory is used. (will be changed)
FILTER: A string array of file extensions to be allowed. This
keyword is used to ensure that the user can only select files
of a certain type. (will be changed)
Passing a string (not a string array!) that contains wildcard
characters (*), this string serves as a filename filter.
LANGARR: Language array. Follwing order of used words has to specified
langarr (0) = filter
langarr (1) = up one directory level
langarr (2) = subdirectories
langarr (3) = files
langarr (4) = selection
langarr (5) = ok
langarr (6) = cancel
langarr (7) = message
langarr (8) = directory >
langarr (9) = < does not exist !
langarr (10) = please select a file
langarr (11) = for reading
langarr (12) = for writing
langarr (13) = File >
If it is not specified, the standard english vocabulary is
used
GERMAN: If the language array was not specified, then standard german
vocabulary was used.
CREATE: If this keyword is set, the selected filename will be tested on
existing filepath only.
Example: If you want to specify an filename for writing, the
filename must not exist. Then the ccw_pickf routine
checks only the filepath.
XOFFSET: X offset of ccw_pickf widget.
YOFFSET: Y offset of ccw_pickf widget.
TITLE: A scalar string to be used for the window title.
OUTPUTS:
CCW_PICKF returns a string that contains the name of the file selected.
If no file is selected, CCW_PICKF returns a null string.
COMMON BLOCKS:
PICKER: COMMON block that maintains state for the widget.
SIDE EFFECTS:
This function initiates the XMANAGER if it is not already running.
RESTRICTIONS:
Only on VAX/VMS tested.
This routine is known to work on Suns (OPEN LOOK), MIPS, RS/6000,
VAX/VMS and SGI machines.
Only one instance of the CCW_PICKF widget can be running at one time.
CCW_PICKF does not recognize symbolic links to other files in UNIX.
PROCEDURE:
Create and register the widget and then exit, returning the filename
that was picked.
EXAMPLE:
Create a CCW_PICKF widget that lets users select only files with
the extensions 'pro' and 'dat'. Use the 'Select File to Read' title
and store the name of the selected file in the variable F. Enter:
F = CCW_PICKF (/READ, FILTER = ['pro', 'dat'])
Create a CCW_PICKF widget that lets users select only files beginning
with with 'x' and the extension 'pro'. Use the 'Select File to Write'
title and store the name of the selected file in the variable F. Enter:
F = CCW_PICKF (/WRITE, FILTER = 'x*.pro')
MODIFICATION HISTORY:
Written by: Steve Richards, April, 1991
July, 1991 Added a FILTER keyword to allow users
to select files with a given extension or
extensions.
August, 1991 Fixed bugs caused by differences between
spawned ls commands on different machines.
3/92 - ACY Corrected initialization of dirsave, change spawn
command to "ls -lL" and added case for links
add NOCONFIRM keyword for auto exiting on selection
6/92 - HJB Fixed various bugs for VMS and added functionality to
change disks on VMS (Filter) including interpreting
filters like "*.d*" for VMS.
8/92 - HJB Added X and Y offset keywords.
10/92 - AH Changed to Compound Widget. (redesign)
(See /host/bluemoon/usr2/idllib/user_contrib/creaso/ccw_pickf.pro)
NAME:
CHANGEDIR
PURPOSE:
This routine changes the current directory.
CALLING SEQUENCE:
changedir, dir, error=error, /message
INPUTS:
None
KEYWORDS:
error - if an error occured, error is -1
message - if an error occured, a message wil be send
OUTPUT:
None
COMMON BLOCKS:
None
SIDE EFFECTS:
No known side effects.
RESTRICTIONS:
For VAX/VMS only.
EXAMPLE:
MODIFICATION HISTORY:
July 1992, AH, CreaSo Created.
(See /host/bluemoon/usr2/idllib/user_contrib/creaso/changedir.pro)
NAME:
CREATECT
PURPOSE:
Create a new colortable file (IDL version 2.4 and above).
CALLING SEQUENCE:
createct, filename, [entries]
INPUTS:
filename - The name of the new colortable file.
entries - Number of entries in new table. Optional. Default = 1.
KEYWORDS:
None.
OUTPUTS:
None.
COMMON BLOCKS:
None.
SIDE EFFECTS:
A new colortable file is created.
RESTRICTIONS:
- Tested on VAX/VMS only.
EXAMPLES:
Create a new colortable with 20 entries. The 20 entries are all
zero by default. No colortable names are create. The entries may
be modified and extended with the procedure modifyct.
IDL> createct, 'mycolor.tbl', 20
MODIFICATION HISTORY:
November 1992, HJB, CreaSo Created.
(See /host/bluemoon/usr2/idllib/user_contrib/creaso/createct.pro)
NAME:
FILELIST
PURPOSE:
This routine finds the files or directories at the current directory level.
It must be called with either files or directories as a keyword.
CALLING SEQUENCE:
FILELIST
INPUTS:
None
KEYWORDS:
PATH - path in which programm looks for
FILES - List of found files
DIRECTORIES - List of found directories
FILTER - List of filters
USEDPATH - path in which rocedure looks for. It could be that
keyword path is "[-]" and than it could be useful to
know the used path
ERROR - if set, than error message will not be send variable will
set as follows :
0 - normal successful completion
1 - directory not found
OUTPUT:
List of found files.
COMMON BLOCKS:
None
SIDE EFFECTS:
No known side effects.
RESTRICTIONS:
For VAX/VMS only.
EXAMPLE:
filelist, path = "[here]",$
FILES = files, $
DIRECTORIES = DIRECTORIES, $
FILTER = "*.c"
Looks for C source code in the directories [here]
returns the file list in files and the directory list in directories.
MODIFICATION HISTORY:
July 1992, AH, CreaSo Created.
(See /host/bluemoon/usr2/idllib/user_contrib/creaso/filelist.pro)
NAME:
FILESCAN
PURPOSE:
This functions returns the required parts of the filename in a string
array.
CALLING SEQUENCE:
FILESCAN
INPUTS:
filename - Filename to be scanned
CURRENT - if set and necessary the path value will be completed with
current path elements.
KEYWORDS:
EXCLUDE - Return the parts of filename without '::', ':', []...
FULL - If not set, the logicals in filename will be translated all
except a concealed device.
OUTPUTS:
NODE - Node of filename (includes '::')
DEV - Device of filename (includes ':')
DIR - Directory of filename (includes '[]')
NAME - Filename to be scanned
TYPE - Extension of the filename (includes '.')
VER - Version number of the filename (includes ';' or '.')
PATH - Node+device+directory
COMMON BLOCKS:
None
SIDE EFFECTS:
No known side effects.
RESTRICTIONS:
For VAX/VMS only.
EXAMPLE:
FileScan ("disk4:[ah]filescan.pro", TYPE = MyExtension, $
DIR = MyDirectory)
MyDirectory eq "[ah]"
MyExtension eq ".pro"
MODIFICATION HISTORY:
October 1992, AH, CreaSo Created.
(See /host/bluemoon/usr2/idllib/user_contrib/creaso/filescan.pro)
NAME:
PACK
PURPOSE:
Pack ascii files into one container file in order to make it
easier to transfer a bunch of procedures to another computer
system (especially for E-Mail and Kermit). The container file
may be used like an IDL command procedure to unpack itself.
No additional unpack procedure is neccessary.
CALLING SEQUENCE:
pack, [filename, [packname]]
INPUTS:
filename - A comma separated list of filenames to be packed
into the container file (default = *.pro)
packname - The name of the container file (default = idl.pck).
KEYWORDS:
None.
OUTPUTS:
None.
COMMON BLOCKS:
None.
SIDE EFFECTS:
A container file is created.
RESTRICTIONS:
- Tested on VAX/VMS only.
- No check for packing binary files or directories is done.
- No check for packing the current or other packfiles is done.
- The unpack operation will terminate IDL when done.
- No filename checking for other operating systems is performed.
- No I/O error handling is performed. All errors will stop the program.
- The pack procedure is not automatically copied into the packfile
for a later re-pack on the target system. This could be solved by
making PACK a userlib procedure (incl. loadarray.pro and filescan.pro).
- The directory information is not transfered (directory tree transfer).
EXAMPLES:
Packing a default container:
IDL> pack
Unpack the default container IDL.PCK on the target machine:
IDL> @idl.pck
Alternative unpack without having IDL started before:
idl idl.pck
MODIFICATION HISTORY:
October 1992, HJB, CreaSo Created.
(See /host/bluemoon/usr2/idllib/user_contrib/creaso/pack.pro)
NAME:
PIE_PLOT
PURPOSE:
Creates a pie-graph.
CATEGORY:
Graphics.
CALLING SEQUENCE:
PIE_PLOT, VALUES
INPUTS:
Values: A vector containing the values to be represented by the pieces
of the pie. Each element in VALUES corresponds to a single piece
in the output.
KEYWORD PARAMETERS:
CENTER: Gives the center position of the pie.
RADIUS: Is the lenght of a piece.
ANGLE: Startup angle in conclusion to vertical above the center.
It is given in "dec".
EXPLODE: A vector (float),the same size as VALUES, containg the index, how wide the pieces
have to move out of the center (in percent of radius).
COLORS: A vector, the same size as VALUES, containing the color index
to be used for each piece. If not specified, the colors are
selected based on spacing the color indices as widley as possible
within the available colors.
OUTLINES: A vector, the same size as VALUES, containing the color index
to be used for the outlines of each piece. If not specified,
the colors are taken from the colors for the filled pieces.
TITLE: A string containing the main title for the pie plot.
LABELS: A string array, containing one string label per piece.
PERCENT: If set, the different percentages of the pieces are also plotted.
FORMAT: Contains the format for the percentage.
NUMBERS: If set, the numbers of the pieces are plotted around.
FILLED: If set, the pieces are filled.
INVISIBLE: Contains the numbers of pieces not to be shown.
T3D: Creates pie in 3-D.
CHARSIZE: Size of the characters used for numbers, labels, percentage.
CHARTHICK: Thickness of characters.
FONT: Font for characters.
FILL_PATTERN: Fill pattern for pieces.
STEPS: width of increment.
WINSIZE: Size of the output window.
POSITION: Position of output window.
THICK: Thickness of the outline.
SHADOW: If shadow is set, a shadow pie is drawn under the pie (only with t3d).
SOLID: If solid is set, the 3-d pie gets a solid box around the pieces
(only with t3d).
HIGH: A value, that describes how high the boxes around the pieces hade to be
(only with t3d).
MODIFICATION HISTORY:
Created by Michael Dalbert / CreaSo in august, 1992.
(See /host/bluemoon/usr2/idllib/user_contrib/creaso/pie_plot.pro)
NAME:
READCT
PURPOSE:
Read a colortable from file.
CALLING SEQUENCE:
readct, num, filename, red, green, blue
INPUTS:
num - Number of colortable to be read.
filename - Name of the new colortable file.
KEYWORDS:
nointer - Do not interpolate if ne equal zero.
OUTPUTS:
red - Red values of the colortable.
green - Green values of the colortable.
blue - Blue values of the colortable.
COMMON BLOCKS:
None.
SIDE EFFECTS:
A file is read.
RESTRICTIONS:
Tested on VAX/VMS only.
MODIFICATION HISTORY:
September 1992, HJB, CreaSo Created.
(See /host/bluemoon/usr2/idllib/user_contrib/creaso/readct.pro)
NAME:
RESTOREARRAY
PURPOSE:
This routine loads the content of an array into a string seperate by the
separator string.
CALLING SEQUENCE:
LOADARRAY, STRING_ARRAY, SEPARATOR
INPUTS:
STRING, SEPERATOR
KEYWORDS:
FULL - If not set, empty elements will not appear in string
SELEM - Starting element
EELEM - Ending element
OUTPUT:
string
COMMON BLOCKS:
None
SIDE EFFECTS:
No known side effects.
RESTRICTIONS:
NONE
EXAMPLE:
str = loadarray (["ulib","usca","test"], ".")
result : str eq ulib.usca.test
MODIFICATION HISTORY:
July 1992, AH, CreaSo Created.
(See /host/bluemoon/usr2/idllib/user_contrib/creaso/restorearray.pro)
NAME:
SEC_PLOT
PURPOSE:
Plots a circle-sector defined by center,startup angle and rangeangle.
CATEGORY:
Graphics.
CALLING SEQUENCE:
SEC_PLOT, Center, Radius, Rangeangle
INPUTS:
CENTER: Gives the center position of the sector.
RADIUS: Is the lenght of the sector.
RANGEANGLE: It gives the width of the sector in form of an angle.
It is given in "dec".
KEYWORD PRAMETERS:
STARTANGLE: Startup angle in conclusion to vertical above the center.
It is given in "rad".
COLOR: Given color is used for sector, default is 255.
OUTLINE: Given color for the secotor outlines.
FILLED: If it is set, the pieces are filled with the colors, given
by keyword colors or by colortable.
T3D: Creates sector 3-dim.
FILL_PATTERN: The fill pattern for filling the polygons.
STEPS: Width of increment.
THICK: Thickness of the outline.
Z: The high of sector if it is drawn as an solid one (only with t3d).
SOLID: If solid is set, the sector gets a box around (only with t3d).
SHADOW: If it is set, the sector gets a shadow below (only with t3d).
MODIFICATION HISTORY:
Created by Michael Dalbert / CreaSo in august, 1992.
(See /host/bluemoon/usr2/idllib/user_contrib/creaso/sec_plot.pro)
NAME:
SHOWCT
PURPOSE:
Show (set) a colortable.
CALLING SEQUENCE:
showct, red, green, blue
INPUTS:
red - Red values of the colortable.
green - Green values of the colortable.
blue - Blue values of the colortable.
KEYWORDS:
bottom - Stretch bottom value.
top - Stretch top value.
gamma - Gamma value.
rev - Reverse the colortable.
chop - Chop top if 1, clip if 0.
OUTPUTS:
colors - The rgb colors set by this procedure as a [3,n] array.
COMMON BLOCKS:
None.
SIDE EFFECTS:
A file is read.
RESTRICTIONS:
Tested on VAX/VMS only.
MODIFICATION HISTORY:
September 1992, HJB, CreaSo Created.
(See /host/bluemoon/usr2/idllib/user_contrib/creaso/showct.pro)
NAME:
VMS translate logical
PURPOSE:
This routine translates a VMS logical without translating concilt
devices .
CALLING SEQUENCE:
result = vms_trnl (logi)
INPUTS:
logical - VMS logical
KEYWORDS:
None.
OUTPUTS:
TRnaslated logical
COMMON BLOCKS:
None
SIDE EFFECTS:
No known side effects.
RESTRICTIONS:
For VAX/VMS only.
EXAMPLE:
MODIFICATION HISTORY:
November 1992, AH, CreaSo Created.
(See /host/bluemoon/usr2/idllib/user_contrib/creaso/vms_trnl.pro)
NAME:
XFONT
PURPOSE:
This procedure allows to view arbritrary text in different font
on your operating system.
CATEGORY:
Widgets, Fonts
CALLING SEQUENCE:
XFONT
INPUTS:
OPTIONAL INPUT PARAMETERS:
KEYWORD PARAMETERS:
GROUP = The widget ID of the widget that calls xfont. When this
ID is specified, a death of the caller results in a death of
xfont.
OUTPUTS:
OPTIONAL OUTPUT PARAMETERS:
COMMON BLOCKS:
SIDE EFFECTS:
Initiates the XManager if it is not already running.
RESTRICTIONS:
Written and tested on VAX/VMS. For other operating systems we
need a file containing all valid names of X fonts. A default
X font file that works for all operating systems has not yet
been created (suggestion: X11 fonts list). New font list files
should be named "XFONTS."+!VERSION.OS .
Selection on the spacing field (P=Proportional, M=Monospaced and
C=CharCell is not yet implemented (Arrays: fa and xa).
Selection of slants "Reverse Italic", "Reverse Oblique" and
"Other" is not yet implemented.
PROCEDURE:
Create and register the widget and then exit.
MODIFICATION HISTORY:
Created from a template written by: Hans-Joachim Bothe, November 1991
(See /host/bluemoon/usr2/idllib/user_contrib/creaso/xfont.pro)