idldoc\xidldoc\

xidldoc.pro

Last modification:
Sat Mar 11 21:30:44 2006
xIDLdoc is a graphical front-end for IDLdoc, the IDL documentation system developed by Michael D. Galloy of RSI's Global Services Group.

To use xIDLdoc, IDLdoc should already be installed in a user's IDL path or compiled in memory. IDLdoc messages, warnings and errors are displayed in the IDL output log.

Routine summary

result = xidldoc::get_value(uname)

Finds and returns the value of a widget (or, for a button widget, whether it is set), given the uname of the widget.

xidldoc::set_value, uname, value

Finds and sets the value of a widget, given the uname of the widget and the value to set.

xidldoc::run

Runs IDLdoc, given the parameters set in the xIDLdoc UI.

xidldoc::handle_events, event

Handles events in the xIDLdoc UI.

xidldoc::cleanup_widgets, top

Destroys the UI and cleans up any resources associated with it.

xidldoc::start_xmanager

Calls XMANAGER to register xIDLdoc's widget interface.

xidldoc::display

Displays the header image in the draw window, if present.

xidldoc::realize

Realizes the widget hierarchy.

xidldoc::center_ui

Centers the UI on the display.

xidldoc::make_input_row, parent, label, text[, /no_button]

Makes a UI element consisting of a label, a text field and a "Browse" button.

result = xidldoc::select_font([/big][, /bold])

Returns a string containing the name of a font that can be used in a label or text widget.

xidldoc::build_widgets

Builds the widget hierarchy.

xidldoc::destruct

The actual class destructor.

xidldoc::cleanup

The official class destructor.

result = xidldoc::init([header_image=RGB image])

Class constructor, used to load class data.

xidldoc__define

The xIDLdoc class data definition routine.

xidldoc

This is a wrapper for simplifying the creation and use of an xIDLdoc object.

topxidldoc::get_value

result = xidldoc::get_value(uname)

Finds and returns the value of a widget (or, for a button widget, whether it is set), given the uname of the widget.

Return value

The value of the widget, or for a button, 1 if set, 0 if not set.

Parameters

uname        in required type: string

The user value of the widget being manipulated.

topxidldoc::set_value

xidldoc::set_value, uname, value

Finds and sets the value of a widget, given the uname of the widget and the value to set.

Parameters

uname        in required type: string

The user value of the widget being manipulated.

value        in required

The value to assign the widget.

topxidldoc::run

xidldoc::run

Runs IDLdoc, given the parameters set in the xIDLdoc UI. IDLdoc messages, warnings and errors are displayed in the IDL output log. It is assumed that the user has IDLdoc installed, either in their path, or already compiled in memory.

topxidldoc::handle_events

xidldoc::handle_events, event

Handles events in the xIDLdoc UI. All events generated in the UI pass through the wrapper routine HANDLE_EVENTS and arrive here, where the event is parsed based on the generating widget's user name.

Parameters

event        in required type: structure

The event structure passed from XMANAGER.

topxidldoc::cleanup_widgets

xidldoc::cleanup_widgets, top

Destroys the UI and cleans up any resources associated with it. Destroys the object in this case, as well.

This method is called by XMANAGER through the widget cleanup routine CLEANUP_WIDGETS.

Parameters

top        in type: long

The top-level base widget identifier, required in the call by XMANAGER.

topxidldoc::start_xmanager

xidldoc::start_xmanager

Calls XMANAGER to register xIDLdoc's widget interface. Events are passed through the wrapper routine HANDLE_EVENTS. The kill_notify signal is passed through CLEANUP_WIDGETS.

Note that the NO_BLOCK keyword is ignored by IDL Runtime/Virtual Machine for IDL < 6.0.

Other attributes

Uses routines

HANDLE_EVENTS, CLEANUP_WIDGETS

topxidldoc::display

xidldoc::display

Displays the header image in the draw window, if present.

topxidldoc::realize

xidldoc::realize

Realizes the widget hierarchy.

topxidldoc::center_ui

xidldoc::center_ui

Centers the UI on the display.

topxidldoc::make_input_row

xidldoc::make_input_row, parent, label, text[, /no_button]

Makes a UI element consisting of a label, a text field and a "Browse" button.

Parameters

parent        in required type: long

The widget identifier of the parent base of this group of widgets.

label        in required type: string

The text to display in the label widget.

text        in required type: string

The text to display in the text widget.

Keywords

no_button        in optional type: boolean

Set to not display the "Browse" button.

Known issues

Todo items

Make this into a compound widget.

topxidldoc::select_font

result = xidldoc::select_font([/big][, /bold])

Returns a string containing the name of a font that can be used in a label or text widget.

Return value

A string giving the name of the font.

Keywords

big        in optional type: boolean

Set this keyword to get a larger font.

bold        in optional type: boolean

Set this keyword to get a bold font.

Known issues

Todo items

Make this into an independent function outside this class definition.

topxidldoc::build_widgets

xidldoc::build_widgets

Builds the widget hierarchy. Lots of buttons and fields.

Each widget has a user name (uname) used to identify the widget in the get_value and set_value methods.

topxidldoc::destruct

xidldoc::destruct

The actual class destructor. All cleanup code goes here, since it can be called directly.

topxidldoc::cleanup

xidldoc::cleanup

The official class destructor. This method can't be called directly, however, so all code is placed in the destruct method instead.

topxidldoc::init

result = xidldoc::init([header_image=RGB image])

Class constructor, used to load class data. Only one instance of xIDLdoc can run at any time.

Note that only a pixel-interleaved RGB image can be displayed at the top of the interface.

Return value

1 on success, 0 on failure.

Keywords

header_image        in optional type: RGB image

A pixel-interleaved RGB image to be displayed at the top of the xIDLdoc interface.

topxidldoc__define

xidldoc__define

The xIDLdoc class data definition routine.

topxidldoc

xidldoc

This is a wrapper for simplifying the creation and use of an xIDLdoc object.

Examples

 IDL> xidldoc
 

Version history

Author

Mark Piper, RSI, 2004

History

  • 2005-03-28, MP: Desensitized checkbox for STATISTICS keyword.
  • 2005-07-21, MP: Resensitized checkbox for STATISTICS keyword. Added checkboxes for the ASSISTANT and PREFORMAT keywords.
  • 2006-03-11, MG: Added tooltips for buttons, desensitized checkbox for BROWSE_ROUTINES, added text box for LOG_FILE keyword

Known issues

Todo items

Save settings between calls in an init file stored with APP_USER_DIR. Requires IDL 6.1.

Other attributes

Requires IDL version

IDL 6.0

Uses routines

Michael D. Galloy's IDLdoc. IDLdoc can be downloaded for free from the RSI codebank: (www.rsinc.com/codebank). Also SOURCEROOT.

Pre-condition

IDLdoc must be in the user's path or already compiled in the user's IDL session.
Produced by IDLdoc 2.0 on Sat Mar 11 21:40:01 2006.