Home | Categories | Alphabetical | Classes | All Contents | [ < ] | [ > ]

Action Routines


Most Motif widgets supply action routines which can be bound to events (such as keypress events). Action routines provided by IDL can be used to define commands for Control Panel buttons or menu items by using the idlAction resource.

The following action routines can be used in the same manner as the IDL commands specified in an idlCommand resource. The syntax to add an action routine to a control panel button is:

Idl*idlde*control*buttonName*idlAction: Action 

or

Idl*idlde*control*buttonName*idlAction: Action(Arguments) 

where buttonName is the name of the button and Action is the name of the action routine. Arguments to the action routine, if require, are enclosed in parentheses.

IdlBreakpoint

Use IdlBreakpoint to control the placement of breakpoints. If no parameter is specified, the breakpoint is set on the current line. At least one of the arguments from the following table must be set:

Argument
Action
SET
Set a breakpoint on the current line.
CLEAR
Clear the breakpoint on the current line.
TOGGLE
Toggle (SET or CLEAR) the state of the breakpoint on the current line.
COMPLEX
Display breakpoint dialog to set a complex breakpoint.
LIST
List all currently set breakpoints

For example, to use this action routine to clear a breakpoint, the Action specified would be:

IdlBreakpoint(CLEAR) 

IdlClearLog

Use IdlClearLog to erase the contents of the Output Log.

IdlClearView

Use IdlClearView to clear the contents of the currently-active file in the Multiple Document Panel.

IdlCommandHide

Use IdlCommandHide to hide or expose the Command Area, which includes the Command Input Line and the Output Log. One of the following arguments must be set: Show, Hide, or Toggle.

IdlCompile

Use IdlCompile to compile the file in the currently-active editor window. One of the arguments from the following table must be set:

Argument
Action
FILE
Compiles the currently-active file.
TEMPORARY
Compiles the currently-active file into a temporary file
RESOLVE
Resolves all referenced and uncompiled IDL routines

IdlControlHide

Use IdlControlHide to hide or expose the Control Panel. One of the following arguments must be set: Show, Hide, or Toggle.

IdlEdit

Use IdlEdit to manipulate the contents of the currently-selected editor window. One of the arguments from the following table must be set:

Argument
Action
UNDO
Undo previous editing action.
REDO
Redo previously undone action.
CUT
Remove currently-selected text to UNIX clipboard.
COPY
Copy currently-selected text to UNIX clipboard.
PASTE
Paste contents of UNIX clipboard at current insertion point.
SELECTALL
Select all of the text in the currently-selected editor window.
GOTODEF
Display the definition of the currently-selected procedure or function.
GOTOLINE
Move directly to the specified line number.

IdlEditMacros

Use IdlEditMacros to display the Edit Macros dialog.

IdlExit

Use IdlExit to cause IDLDE to act as though the EXIT command has been entered. Note that this is usually tied to a menu accelerator (Ctrl-Q in this case), so this routine is rarely called directly.

IdlFile

Use IdlFile to manipulate the currently-selected editor window. One of the arguments in the following table must be set:

Argument
Action
NEW
Creates a new editor window.
OPEN
Opens an existing file.
SAVE
Saves the contents of the currently-selected editor window.
PRINT
Prints the contents of the currently-selected editor window.

IdlFileReadOnly

Use IdlFileReadOnly to specify the read/write status of the currently-active editor window. One of the arguments from the following table must be set:

Argument
Action
READONLY
Disable editing of the currently-selected editor window.
READWRITE
Enables editing of the currently-selected window.

IdlFunctionKey

Use IdlFunctionKey to allow entry of an IDL command into the input command stream. It is typically used to tie IDL commands to function keys. For example:

<Key>F5:IdlFunctionKey("print, 'F5 pressed'")\n 

IdlInterrupt

Use IdlInterrupt to cause IDLDE to receive an interrupt. Note that this is usually tied to Ctrl-C as a menu accelerator.

IdlListStack

Use IdlListStack to display the current nesting of procedures and functions (calling stack).

IdlLogHide

Use IdlLogHide to hide or expose the Output Log. One of the following arguments must be set: Show, Hide, or Toggle.

IdlRecallCommand

Use IdlRecallCommand to recalls previously entered commands into the command widget. Either the BACK or the FORWARD argument must be specified to indicate the direction of the recall. For example:

<Key>osfUp:IdlRecallCommand(BACK)\n 

IdlReset

Use IdlReset to reset the IDL environment.

IdlRun

Use IdlRun to execute the currently-active file.

IdlSearch

Use IdlSearch to call the Find dialog for a search of the current Multiple Document Panel. One of the optional arguments from the following table may be used:

Argument
Action
FIND
Displays a search dialog (default).
FINDAGAIN
Finds the next occurrence of the specified string.
FINDSELECTION
Finds next occurrence of the current selection.
ENTERSELECTION
Enters the current selection as the search string in the Find dialog.
REPLACE
Replaces the search string, with a specified replacement string.
REPLACEFIND
Finds the next occurrence of the search string, and replaces it with the specified replacement string.

IdlStatusHide

Use IdlStatusHide to hide or expose the Status Bar. One of the following arguments must be set: Show, Hide, or Toggle.

IdlStep

Use IdlStep to control statement execution for debugging. At least one of the arguments from the following table must be set.

Argument
Action
INTO
Executes a single statement in the current program. If nested procedures or functions are encountered, they are also executed in single-statement mode.
OVER
Executes a single statement in the current program. If nested procedures or functions are encountered, they are run until completion, whereupon interactive control returns.
OUT
Continues execution until current routine returns.
SKIP
Skips one statement and executes following statement.
CONTINUE
Continues execution of an interrupted program.
TOCURSOR
Executes file until encountering the cursor.
TORETURN
Executes file until encountering the return.

IdlTrace

Use IdlTrace to display a dialog box to control program tracing.

IdlViewHide

Use IdlViewHide to hide or expose the Multiple Document Panel. One of the following arguments must be set: Show, Hide, or Toggle.

IdlWindows

Use IdlWindows to manipulate the state of the Editor windows. One of the arguments from the following table must be set:

Argument
Action
CASCADE
Arrange open windows in a staggered, overlapping fashion.
TILE
Arrange all windows in a non-overlapping fashion.
MULTI
Open windows outside the IDLDE interface.
SINGLE
Display the most recent window on the Multiple Document Panel.


Home | Categories | Alphabetical | Classes | All Contents | [ < ] | [ > ]