getSlotHTMLTable {RGtkViewers}R Documentation

Generate HTML displaying Gtk class information

Description

Compute the HTML text for displaying the slot information for the specified class. The complete and combined arguments control if and how we group information about inherited slots. If combined is FALSE, then we get separate tables for each of the ancestor/base classes in the inheritance hierarchy

Alternatively, if combined is TRUE, then if complete is TRUE, we put all the slots - inherited and defined locally with the class - together into a single table, but color code each slot by the class in which it was defined. See formatClassSlots.

Usage

getSlotHTMLTable(className, complete = TRUE, combined = FALSE)

Arguments

className the name of the class whose slots are to be found and described.
complete a logical value indicating whether to get the slots that are inherited from base/ancestor classes (TRUE) or just work with the slots defined explicitly by this class (FALSE). If this is FALSE, combined is not relevant.
combined a logical value indicating how to present the inherited slots relative to the directly defined slots. If this is TRUE, all slots are displayed in a single HTML table and the slots are color coded to match the class name (shown in a simple hierarchy made up of links). If this is FALSE, then there is a separate table for each of the ancestor classes.

Details

Value

A HTML string.

Author(s)

Duncan Temple Lang <duncan@research.bell-labs.com>

References

http://www.omegahat.org/RGtk, http://www.omegahat.org/RSMethods/index.html http://www.gtk.org

See Also

formatClassSlots

Examples



[Package RGtkViewers version 0.7 Index]