File: HTML.html

package info (click to toggle)
xmhtml 1.1.7-18
links: PTS
area: main
in suites: wheezy
size: 6,576 kB
sloc: ansic: 68,174; makefile: 438; sh: 158; perl: 36
file content (2097 lines) | stat: -rw-r--r-- 61,184 bytes
parent folder | download | duplicates (10)
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
	<TITLE>XmHTML Programmers Manual: XmHTML Widget Class</TITLE>
	<META HTTP-EQUIV="Keywords" CONTENT="XmHTML, HTML, Motif, Widget, eXode, XntHelp, Linux">
	<META HTTP-EQUIV="Reply-to" CONTENT="ripley@xs4all.nl">
	<META HTTP-EQUIV="Description" CONTENT="XmHTML - The XmHTML Widget Class">
	<META NAME="Author" CONTENT="Koen D'Hondt">
	<META NAME="Copyright" content="1995-1997 by Ripley Software Development">
	<META NAME="Source" content="$Source$">
	<META NAME="Revision" content="$Revision$">
<!--
	<META NAME="Font" content="helvetica">
-->
	<link rev="made" href="mailto:ripley@xs4all.nl">
	<link rel="home" href="index.html">
	<link rel="next" href="ImInfo.html">
	<link rel="up" href="../man.html">
	<link rel="down" href="">
	<link rel="copyright" href="copyrights.html">
</HEAD>

<BODY BGCOLOR="#FFFFFF" text="#000000">
<div align="center">
<a name="top"><img src="../../Images/xmhtml-banner.gif"></a>
</div>

<h3><font face="helvetica,arial">Name</font></h3>

<blockquote>
	XmHTML - The XmHTML Widget Class
</blockquote>

<h3><font face="helvetica,arial">Synopsis</font></h3>

<blockquote>
	#include &lt;XmHTML/XmHTML.h&gt;
</blockquote>

<h3><font face="helvetica,arial">Description</font></h3>

<blockquote>
	XmHTML provides a widget capable of displaying HTML 3.2 
	confirming text. XmHTML widgets can be used for navigating in and between
	such documents and can also display non HTML 3.2 documents and standalone
	images. It contains full image support and a keyboard navigation
	interface which can be customized through XmHTML's translations.
</blockquote>

<h3><font face="helvetica,arial">Class Information</font></h3>

<blockquote>
	Class Hierarchy: Core-&gt;Composite-&gt;Constraint-&gt;XmManager-&gt;XmHTML
	<p>

	Class pointer: xmHTMLWidgetClass.
	<p>

	Class name: XmHTMLWidget
	<p>

	Functions/Macros: XmCreateHTML, XmHTML... routines, XmIsHTML.
</blockquote>

<h3><font face="helvetica,arial">New Resources</font></h3>

<blockquote>
XmHTML defines the following resources.
<p>

<table border="1" rowpadding=0 rowspacing=0 cellspacing=0 cellpadding=1>
<tr>
	<td><b>Name</b>
	<td><b>Class</b>
	<td><b>Type</b>
	<td><b>Default</b>
	<td><b>Access</b>
<tr>
<tr>
	<td><a href="#XmNalignment">XmNalignment</a>
	<td>XmCAlignment
	<td>unsigned char
	<td>XmALIGNMENT_BEGINNING
	<td>CSG
<!--
<tr>
	<td><a href="#XmNalphaChannelProcessing">XmNalphaChannelProcessing</a>
	<td>unsigned char
	<td>XmAUTOMATIC
	<td>CSG
-->
<tr>
	<td><a href="#XmNanchorActivatedBackground">
		XmNanchorActivatedBackground</a>
	<td>XmCBackground
	<td>Pixel
	<td>white
	<td>CSG
<tr>
	<td><a href="#XmNanchorActivatedForeground">
		XmNanchorActivatedForeground</a>
	<td>XmCForeground
	<td>Pixel
	<td>red	
	<td>CSG
<tr>
	<td><a href="#XmNanchorButtons">XmNanchorButtons</a>
	<td>XmCBoolean
	<td>Boolean
	<td>True
	<td>CSG
<tr>
	<td><a href="#XmNanchorCursor">XmNanchorCursor</a>
	<td>XmCCursor
	<td>Cursor
	<td>built-in	
	<td>CSG
<tr>
	<td><a href="#XmNanchorDisplayCursor">XmNanchorDisplayCursor</a>
	<td>XmCBoolean
	<td>Boolean
	<td>True
	<td>CSG
<tr>
	<td><a href="#XmNanchorForeground">XmNanchorForeground</a>
	<td>XmCForeground
	<td>Pixel
	<td>blue1
	<td>CSG
<tr>
	<td><a href="#XmNanchorTargetForeground">XmNanchorTargetForeground</a>
	<td>XmCForeground
	<td>Pixel
	<td>blue1
	<td>CSG
<tr>
	<td><a href="#XmNanchorTargetUnderlineType">XmNanchorTargetUnderlineType</a>
	<td>XmCAnchorUnderlineType
	<td nowrap>unsigned char
	<td nowrap>XmSINGLE_DASHED_LINE
	<td>CSG
<tr>
	<td><a href="#XmNanchorUnderlineType">XmNanchorUnderlineType</a>
	<td>XmCAnchorUnderlineType
	<td>unsigned char
	<td>XmSINGLE_LINE
	<td>CSG
<tr>
	<td><a href="#XmNanchorVisitedForeground">XmNanchorVisitedForeground</a>
	<td>XmCForeground
	<td>Pixel
	<td>blue1
	<td>CSG
<tr>
	<td><a href="#XmNanchorVisitedProc">XmNanchorVisitedProc</a>
	<td>XmCAnchorVisitedProc
	<td>(*)()
	<td>NULL
	<td>CSG
<tr>
	<td><a href="#XmNanchorVisitedUnderlineType">
		XmNanchorVisitedUnderlineType</a>
	<td>XmCAnchorUnderlineType
	<td>unsigned char
	<td>XmSINGLE_LINE
	<td>CSG
<tr>
	<td><a href="#XmNbodyImage">XmNbodyImage</a>
	<td>XmCString
	<td>String
	<td>NULL
	<td>CSG
<tr>
	<td><a href="#XmNcharset">XmNcharset</a>
	<td>XmCString
	<td>String
	<td>iso8859-1
	<td>CSG
<tr>
	<td><a href="#XmNclientData">XmNclientData</a>
	<td>XmCClientData
	<td>XtPointer
	<td>NULL
	<td>CSG
<tr>
	<td><a href="#XmNdecodeGIFProc">XmNdecodeGIFProc</a>
	<td>XmCDecodeGIFProc
	<td>XmImageGifProc
	<td>NULL
	<td>CSG
<tr>
	<td><a href="#XmNenableBadHTMLWarnings">XmNenableBadHTMLWarnings</a>
	<td>XmCWarningMode
	<td>Byte
	<td>XmHTML_ALL
	<td>CSG
<tr>
	<td><a href="#XmNenableBodyColors">XmNenableBodyColors</a>
	<td>XmCBoolean
	<td>Boolean
	<td>True
	<td>CSG
<tr>
	<td><a href="#XmNenableBodyImages">XmNenableBodyImages</a>
	<td>XmCBoolean
	<td>Boolean
	<td>True
	<td>CSG
<tr>
	<td><a href="#XmNenableDocumentColors">XmNenableDocumentColors</a>
	<td>XmCBoolean
	<td>Boolean
	<td>True
	<td>CSG
<tr>
	<td><a href="#XmNenableDocumentFonts">XmNenableDocumentFonts</a>
	<td>XmCBoolean
	<td>Boolean
	<td>True
	<td>CSG
<tr>
	<td><a href="#XmNenableFormColors">XmNenableFormColors</a>
	<td>XmCBoolean
	<td>Boolean
	<td>True
	<td>CSG
<tr>
	<td><a href="#XmNenableIconEntities">XmNenableIconEntities</a>
	<td>XmCBoolean
	<td>Boolean
	<td>False
	<td>CSG
<tr>
	<td><a href="#XmNenableOutlining">XmNenableOutlining</a>
	<td>XmCBoolean
	<td>Boolean
	<td>False
	<td>CSG
<tr>
	<td><a href="#XmNeventProc">XmNeventProc</a>
	<td>XmCEventProc
	<td>XmHTMLEventProc
	<td>NULL
	<td>CSG
<tr>
	<td><a href="#XmNfontFamily">XmNfontFamily</a>
	<td>XmCString
	<td>String
	<td>adobe-times-normal-*
	<td>CSG
<tr>
	<td><a href="#XmNfontFamilyFixed">XmNfontFamilyFixed</a>
	<td>XmCString
	<td>String
	<td>adobe-courier-normal-*
	<td>CSG
<tr>
	<td><a href="#XmNfontSizeList">XmNfontSizeList</a>
	<td>XmCString
	<td>String
	<td>14,8,24,18,14,12,10,8
	<td>CSG
<tr>
	<td><a href="#XmNfontSizeFixedList">XmNfontSizeFixedList</a>
	<td>XmCString
	<td>String
	<td>12,8
	<td>CSG
<tr>
	<td><a href="#XmNfreezeAnimations">XmNfreezeAnimations</a>
	<td>XmCBoolean
	<td>Boolean
	<td>False
	<td>CSG
<tr>
	<td><a href="#XmNhighlightOnEnter">XmNhighlightOnEnter</a>
	<td>XmCHighlightOnEnter
	<td>Boolean
	<td>True
	<td>CSG
<tr>
	<td><a href="#XmNhorizontalScrollBar">XmNhorizontalScrollBar</a>
	<td>XmCHorizontalScrollBar
	<td>Widget
	<td>NULL
	<td>CG
<tr>
	<td><a href="#XmNiconAlignment">XmNiconAlignment</a>
	<td>XmCVerticalAlignment
	<td>unsigned char
	<td>XmALIGNMENT_CENTER
	<td>CSG
<tr>
	<td><a href="#XmNimageEnable">XmNimageEnable</a>
	<td>XmCBoolean
	<td>Boolean
	<td>True
	<td>CSG
<tr>
	<td><a href="#XmNimagemapDrawBoundingBoxes">XmNimagemapDrawBoundingBoxes</a>
	<td>XmCBoolean
	<td>Boolean
	<td>False
	<td>CSG
<tr>
	<td><a href="#XmNimagemapBoundingBoxForeground">
		XmNimagemapBoundingBoxForeground</a>
	<td>XmCForeground
	<td>Pixel
	<td>White
	<td>CSG
<tr>
	<td><a href="#XmNimageMapToPalette">XmNimageMapToPalette</a>
	<td>XmCConversionMode
	<td>unsigned char
	<td>XmDISABLED
	<td>CSG
<tr>
	<td><a href="#XmNimagePalette">XmNimagePalette</a>
	<td>XmCString
	<td>String
	<td>NULL
	<td>CG
<tr>
	<td><a href="#XmNimageProc">XmNimageProc</a>
	<td>XmCImageProc
	<td>XmImageProc
	<td>dynamic
	<td>CSG
<tr>
	<td><a href="#XmNimageRGBConversion">XmNimageRGBConversion</a>
	<td>XmCConversionMode
	<td>unsigned char
	<td>XmBEST
	<td>CSG
<tr>
	<td><a href="#XmNmarginHeight">XmNmarginHeight</a>
	<td>XmCMarginHeight
	<td>Dimension
	<td>20
	<td>CSG
<tr>
	<td><a href="#XmNmarginWidth">XmNmarginWidth</a>
	<td>XmCMarginWidth
	<td>Dimension
	<td>20
	<td>CSG
<tr>
	<td><a href="#XmNmaxImageColors">XmNmaxImageColors</a>
	<td>XmCMaxImageColors
	<td>int
	<td>0
	<td>CSG
<tr>
	<td><a href="#XmNmimeType">XmNmimeType</a>
	<td>XmCString
	<td>String
	<td>text/html
	<td>CSG
<tr>
	<td><a href="#XmNrepeatDelay">XmNrepeatDelay</a>
	<td>XmCRepeatDelay
	<td>int
	<td>25
	<td>CSG
<tr>
	<td><a href="#XmNresizeHeight">XmNresizeHeight</a>
	<td>XmCResizeHeight
	<td>Boolean
	<td>False
	<td>CSG
<tr>
	<td><a href="#XmNresizeWidth">XmNresizeWidth</a>
	<td>XmCResizeWidth
	<td>Boolean
	<td>False
	<td>CSG
<tr>
	<td><a href="#XmNscreenGamma">XmNscreenGamma</a>
	<td>XmCScreenGamma
	<td>float
	<td>2.2
	<td>CSG
<tr>
	<td><a href="#XmNscrollBarDisplayPolicy">XmNscrollBarDisplayPolicy</a>
	<td>XmCScrollBarDisplayPolicy
	<td>unsigned char
	<td>XmAS_NEEDED
	<td>CSG
<tr>
	<td><a href="#XmNscrollBarPlacement">XmNscrollBarPlacement</a>
	<td>XmCScrollBarPlacement
	<td>unsigned char
	<td>XmBOTTOM_RIGHT
	<td>CSG
<tr>
	<td><a href="#XmNsmoothScrolling">XmNsmoothScrolling</a>
	<td>XmCBoolean
	<td>Boolean
	<td>True
	<td>CSG
<tr>
	<td><a href="#XmNstrictHTMLChecking">XmNstrictHTMLChecking</a>
	<td>XmCBoolean
	<td>Boolean
	<td>False
	<td>CSG
<tr>
	<td><a href="#XmNstringDirection">XmNStringDirection</a>
	<td>XmCStringDirection
	<td>unsigned char
	<td>XmSTRING_DIRECTION_L_TO_R
	<td>CSG
<tr>
	<td><a href="#XmNtabWidth">XmNtabWidth</a>
	<td>XmCTabWidth
	<td>int
	<td>8
	<td>CSG
<tr>
	<td><a href="#XmNtopLine">XmNtopLine</a>
	<td>XmCTopLine
	<td>Cardinal
	<td>0
	<td>CSG
<tr>
	<td><a href="#XmNuncompressCommand">XmNuncompressCommand</a>
	<td>XmCString
	<td>String
	<td>uncompress
	<td>CSG
<tr>
	<td><a href="#XmNvalue">XmNvalue</a>
	<td>XmCValue
	<td>String
	<td>NULL
	<td>CSG
<tr>
	<td><a href="#XmNverticalScrollBar">XmNverticalScrollBar</a>
	<td>XmCVerticalScrollBar
	<td>Widget
	<td>NULL
	<td>CG
<tr>
	<td><a href="#XmNworkWindow">XmNworkWindow</a>
	<td>XmCWorkWindow
	<td>Widget
	<td>NULL
	<td>CG
<tr>
</table>

<dl>

<dt><a name="XmNalignment">XmNalignment</a>
<dd>Identifies the default alignment (left to right) in which text will be 
	displayed. Possible values are:
	XmALIGNMENT_BEGINNING, XmALIGNMENT_CENTER and XmALIGNMENT_END.
	<p>
	This resource is only meaningfull when the 
	<a href="#XmNenableOutlining">XmNenableOutlining</a> resource is 
	<b>False</b>.
<p>

<!-- -- UNIMPLEMENTED --
<dt><a name="XmNalphaChannelProcessing">XmNalphaChannelProcessing</a>
<dd>
<p>
-->

<dt><a name="XmNanchorActivatedBackground">XmNanchorActivatedBackground</a>
<dd>The background color to use when an anchor is activated.
	This resource is only honored when the XmNanchorButtons resource is set to
	<b>False</b>
<p>

<dt><a name="XmNanchorActivatedForeground">XmNanchorActivatedForeground</a>
<dd>The foreground color to use when an anchor is activated.
<p>

<dt><a name="XmNanchorButtons">XmNanchorButtons</a>
<dd>When set to True, all anchors will be rendered as pushbuttons instead of
	being underlined.
<p>

<dt><a name="XmNanchorCursor">XmNanchorCursor</a>
<dd>The cursor to display when the pointer is moved over an anchor. The
	built-in cursor is a hand with a pointing finger.
	Only in effect when the XmNanchorDisplayCursor resource is set.
<p>

<dt><a name="XmNanchorDisplayCursor">XmNanchorDisplayCursor</a>
<dd>When set to True, the cursor will change when the pointer is moved
	over an anchor.
<p>

<dt><a name="XmNanchorForeground">XmNanchorForeground</a>
<dd>The color in which anchors will be displayed.
<p>

<dt><a name="XmNanchorTargetForeground">XmNanchorTargetForeground</a>
<dd>The color in which anchors that have a TARGET attribute specified will be
	displayed.
<p>

<dt><a name="XmNanchorTargetUnderlineType">XmNanchorTargetUnderlineType</a>
<dd>Underlining style for anchors that have a TARGET attribute specified.
	See XmNanchorUnderlineType for possible values.
	This resource is only honored when the XmNanchorButtons resource is set to
	<b>False</b>
<p>

<dt><a name="XmNanchorUnderlineType">XmNanchorUnderlineType</a>
<dd>Underlining style for anchors. Can be any of the following:
<p>
	<table cols=2 border=0>
	<tr>
		<td>XmNO_LINE
		<td>/* no underlines */
	<tr>
		<td>XmSINGLE_LINE
		<td>/* a single, solid, underline */
	<tr>
		<td>XmDOUBLE_LINE
		<td>/* a double, solid, underline */
	<tr>
		<td>XmSINGLE_DASHED_LINE
		<td>/* a single, dashed, underline */
	<tr>
		<td>XmDOUBLE_DASHED_LINE
		<td>/* a double, dashed, underline */
	<tr>
	</table>
<p>
	This resource is only honored when the XmNanchorButtons resource is set to
	<b>False</b>
<p>

<dt><a name="XmNanchorVisitedForeground">XmNanchorVisitedForeground</a>
<dd>The color in which previously visited anchors will be displayed.
<p>

<dt><a name="XmNanchorVisitedProc">XmNanchorVisitedProc</a>
<dd>The procedure that should be called to test if an anchor has been
	activated before. There are three arguments to this procedure: the widget
	id, the name of the anchor and a pointer to data that the application
	attached to the widget using the <a href="#XmNclientData">XmNclientData</a>
	resource. It should return <b>True</b> 
	when the anchor should be rendered using the XmNanchorVisitedForeground
	resource. 
<p>
	This procedure is used when a document is loaded into the widget. It is 
	called for every anchor encountered.
<p>

<dt><a name="XmNanchorVisitedUnderlineType">XmNanchorVisitedUnderlineType</a>
<dd>Underlining style for previously visited anchors. See
	XmNanchorUnderlineType for possible values.
	This resource is only honored when the XmNanchorButtons resource is set to
	<b>False</b>
<p>

<dt><a name="XmNbodyImage">XmNbodyImage</a>
<dd>The name of the image to be used as the default body image.
	This resource is only honored when the XmNenableBodyImages resource is set
	to <b>True</b>
<p>

<dt><a name="XmNcharset">XmNcharset</a>
<dd>A string representing the ISO character set encoding to be used.
	The default value (iso8859-1) represents the ISO Latin-1 character set.
	<p>

	When an attempt is made to set a charset which does not exist on the
	X server, the XmHTML widget falls back to it's default charset.
	<p>
<p>

<dt><a name="XmNclientData">XmNclientData</a>
<dd>A pointer to data that the application can attach to the functions
	attached to the <a href="#XmNanchorVisitedProc">XmNanchorVisitedProc</a>
	and <a href="#XmNimageProc">XmNimageProc</a> resources. This resource
	is unused internally.
<p>

<dt><a name="XmNdecodeGIFProc">XmNdecodeGIFProc</a>
<dd>An alternative procedure that should be used for decoding GIF images.
	<p>

	To avoid patent issues related to the use of the LZW algorithm
	(patented by Unisys Coorporation), the default GIF decoder uses a
	patent-free workaround (involving a system call to the program specified
	under the XmNuncompressCommand resource). Although this workaround is
	fairly fast for single-image GIF images, decoding animations can take
	a considerable amount of time. Therefore, owners of a LZW license or
	authors of freeware can attach their own LZW decoder to this resource,
	thereby achieving a small to considerable performance increase.
	<p>

	See <a href="HTGIFStr.html">XmHTMLGIFStream</a> --XmHTML
	External GIF Decoder Interface Definition-- for more information.

<p>

<dt><a name="XmNenableBadHTMLWarnings">XmNenableBadHTMLWarnings</a>
<dd>Specifies the types of warnings a XmHTML Widget may issues when the
	HTML parser detects bad HTML constructs in the input document.
	Unless were noted, multiple warning types can be specified by OR'ing
	different warning types together.
	<p>

	Possible values are:
	<table>
	<tr>
		<td>XmHTML_NONE
		<td nowrap>/* no warnings at all, exclusive value */
	</tr>
	<tr>
		<td>XmHTML_UNKNOWN_ELEMENT
		<td nowrap>/* unknown HTML element */
	</tr>
	<tr>
		<td>XmHTML_BAD
		<td nowrap>/* very badly placed element */
	</tr>
	<tr>
		<td>XmHTML_OPEN_BLOCK
		<td nowrap>/* block still open while new block started	*/
	</tr>
	<tr>
		<td>XmHTML_CLOSE_BLOCK
		<td nowrap>/* block closed but was never opened */
	</tr>
	<tr>
		<td>XmHTML_OPEN_ELEMENT
		<td nowrap>/* unbalanced terminator */
	</tr>
	<tr>
		<td>XmHTML_NESTED
		<td nowrap>/* improperly nested element */
	</tr>
	<tr>
		<td>XmHTML_VIOLATION
		<td nowrap>/* bad content for current block/element */
	</tr>
	<tr>
		<td>XmHTML_ALL
		<td nowrap>/* show all warnings, exclusive value */
	</tr>
	</table>

<p>

<dt><a name="XmNenableBodyColors">XmNenableBodyColors</a>
<dd>If <b>True</b> (default), the body and text colors specified in a HTML
	document will be honored.
<p>

<dt><a name="XmNenableBodyImages">XmNenableBodyImages</a>
<dd>If <b>True</b> (default), the background image specified in a HTML
	document will be honored.
<p>

<dt><a name="XmNenableDocumentColors">XmNenableDocumentColors</a>
<dd>If <b>True</b> (default), the color attribute will be honored for the
	HTML tags listed in the XmHTML
	<a href="../extensions.html#color">HTML Extensions</a> as well as for the
	&lt;FONT&gt; element. If set to <b>False</b> no color switching will
	be performed.
<p>

<dt><a name="XmNenableDocumentFonts">XmNenableDocumentFonts</a>
<dd>If <b>True</b> (default), the size and face attribute of the &lt;FONT&gt;
	will be honored. If set to <b>False</b>, no font switching will be
	performed. Note that setting both XmNenableDocmentColors and
	XmNenableDocumentFonts to False effectively <b>disables</b> the
	&lt;FONT&gt; element.
<p>

<dt><a name="XmNenableFormColors">XmNenableFormColors</a>
<dd>If <b>True</b> (default), any widgets created by a XmHTML Widget as
	part of a HTML &lt;FORM&gt; tag use the document background and foreground
	colors. When <b>False</b>, Motif's default values will be used. Please
	note that in the latter case this will break the natural look of the
	document.
<p>

<dt><a name="XmNenableIconEntities">XmNenableIconEntities</a>
<dd>If <b>True</b>, support for builtin icon entities will be enabled.
	This allows the recognition of character escapes that are to be rendered
	as icons. For example, <tt>&amp;folder.open;</tt> represents an icon of
	an open file folder. XmHTML supports all 61 icons listed in the W3C
	Working Draft WD-wwwicon-960729.
	<p>

	The default value of this resource is <b>False</b>.
<p>

<dt><a name="XmNenableOutlining">XmNenableOutlining</a>
<dd>If <b>True</b> (default), all text of which the alignment is not
	explicitly set will be outlined (justified): every line in a paragraph
	(or sentence spanning more than a single line) will have the same left
	and right margin.
<p>

<dt><a name="XmNeventProc">XmNeventProc</a>
<dd>This resource identifies a procedure to be called whenever a
	HTML4.0 event is encountered while the document is being loaded.
	<p>

	The call to this procedure contains three arguments: the widget ID of the 
	XmHTML widget, the value of the event (some action that should be
	performed when a HTML4.0 event occurs) and a pointer to
	data that the application attached to the widget using the
	<a href="#XmNclientData">XmNclientData</a> resource.
	<p>

	The return value of this procedure is a pointer to application data
	which is used as the <i>data</i> field of the
	<a href="#XmNeventCallback">XmNeventCallback</a> whenever a HTML4.0
	event occurs. This value is unused internally.
	<p>

	Note: the <a href="GtHdAttr.html">XmHTMLGetHeadAttributes</a>
	convenience function can be used to retrieve the &lt;SCRIPT&gt; source
	to which these actions most likely refer.
<p>

<dt><a name="XmNfontFamily">XmNfontFamily</a>
<dd>A sequence of <b>four</b>, dash-separated strings that make up the family 
	of fonts to be used for displaying text. A fontFamily is composed of the 
	following fields:
	<p>

	<ol>
	<li>foundry: the type foundry that digitized and supplied the font, i.e. 
		Adobe;
	<li>family: the font family name, i.e. roman;
	<li>set width: a value describing a font's proportionate width according
		to the selected foundry, i.e. normal;
	<li>spacing: type of character spacing for a font. m (for monospace, i.e.
		fixed width) or p (proportional, i.e., variable-width) are two well 
		known font spacings.
	</ol>
	<p>

	Wildcards are allowed for all four fields, but can produce unwanted results
	if your X (or font) server is not configured correctly or if you have a lot
	of fonts installed. A nominal specification should at least include the 
	<i>family</i> field.
<p>

<dt><a name="XmNfontFamilyFixed">XmNfontFamilyFixed</a>
<dd>A string describing the family of fonts to be used for displaying text 
	at a fixed width. 
	<p>

	See XmNfontFamily on how to compose this string.
<p>

<dt><a name="XmNfontSizeList">XmNfontSizeList</a>
<dd>A comma separated list of <b>eight</b> strings describing the various 
	default font sizes to be used, specified in <b>points</b>.
	The list below describes the various fields in this resource.
	<p>

	<ol>
	<li>default font size.
	<li>sub and superscript font size
	<li>font size for the &lt;H1&gt; element
	<li>font size for the &lt;H2&gt; element
	<li>font size for the &lt;H3&gt; element
	<li>font size for the &lt;H4&gt; element
	<li>font size for the &lt;H5&gt; element
	<li>font size for the &lt;H6&gt; element
	</ol>
	<p>
	When an element in this list has the value 0 (zero), the appropriate default
	font size is used.
<p>

<dt><a name="XmNfontSizeFixedList">XmNfontSizeFixedList</a>
<dd>A comma separated list of <b>two</b> strings describing the fixed font 
	sizes to be used, specified in <b>points</b>.
	The list below describes the various fields in this resource.
	<p>

	<ol>
	<li>default fixed font size.
	<li>sub and superscript fixed font size
	</ol>
	<p>

	When an element in this list has the value 0 (zero), the appropriate default
	font size is used.
<p>

<dt><a name="XmNfreezeAnimations">XmNfreezeAnimations</a>
<dd>When set to <b>True</b>, XmHTML will freeze all animations in a document
	at the currently displayed frame. Animation will continue when the
	value of this resource is set to <b>False</b>.
<p>

<dt><a name="XmNhighlightOnEnter">XmNhighlightOnEnter</a>
<dd>When <b>True</b> (default), an anchor will appear highlighted when the
	cursor is moved over it. When set to <b>False</b>, anchor highlighting is
	not performed. The color used for performing anchor highlighting is
	computed dynamically and depends on the current document foreground color
	and background setting.
<p>

<dt><a name="XmNhorizontalScrollBar">XmNhorizontalScrollBar</a>
<dd>The widget ID of the horizontal scrollbar.
<p>

<dt><a name="XmNiconAlignment">XmNiconAlignment</a>
<dd>This resource specifies the default vertical alignment that must be used
	for icon entities. Only meaningfull when the
	<a href="#XmNenableIconEntities">XmNenableIconEntities</a> resource has
	been set to True.
	<p>

	Possible values for this resource are:
	<p>

	<table border=0>
	<tr>
		<td>XmALIGNMENT_BASELINE_TOP
		<td>/* text will be aligned at the top of the icon */
	<tr>
		<td>XmALIGNMENT_CENTER
		<td>/* text will be aligned at the center of the icon */
	<tr>
		<td>XmALIGNMENT_BASELINE_BOTTOM
		<td>/* text will be aligned at the bottom of the icon */
	<tr>
	</table>

<p>

<dt><a name="XmNimageEnable">XmNimageEnable</a>
<dd>When <b>True</b> (default) images are displayed.
<p>

<dt><a name="XmNimagemapDrawBoundingBoxes">XmNimagemapDrawBoundingBoxes</a>
<dd>When <b>True</b>, XmHTML will draw a bounding box around each area
	in an imagemap. The color used for drawing these bounding boxes can
	be changed using the XmNimagemapBoundingBoxForeground resource.
	<p>

	This resource is especially usefull for debugging imagemaps
	in a document, and it can be an aid to persons with limited visual
	capability.
<p>

<dt><a name="XmNimagemapBoundingBoxForeground">
		XmNimagemapBoundingBoxForeground</a>
<dd>The color used for drawing imagemap bounding boxes.
<p>

<dt><a name="XmNimageMapToPalette">XmNimageMapToPalette</a>
<dd>This resource determines if a XmHTML widget should perform dithering to
	a fixed palette and if so how that should be done.
	<p>

	Possible values are:
	<table border=0 align="center">
	<tr valign="top">
		<td>XmQUICK
		<td>A closest distance algorithm is used to map image colors to the
			palette. No	error correction is performed. Fast, but the resulting
			image quality depends on the distribution of the colors in the
			image.
	<tr valign="top">
		<td>XmBEST
		<td>Ordered dither using predefined error matrices. Offers the best
			balance between speed and quality but uses a lot of memory (512kb).
	<tr valign="top">
		<td>XmFAST
		<td>Simple ordered dither without error correction. This is the
			fastest method but uses a lot of memory (512kb).
	<tr valign="top">
		<td>XmSLOW
		<td>A closest distance algorithm followed by Floyd-Steinberg error
			diffusion. Slowest method but highest quality.
	<tr valign="top">
		<td>XmDISABLED
		<td>disables palette mapping. This is the default setting.
	<tr>
	</table>
<p>

<dt><a name="XmNimagePalette">XmNimagePalette</a>
<dd>Specifies a fixed palette a XmHTML widget should use. Document colors
	are mapped onto this palette and document images are dithered against it.
	<p>

	A palette is defined as a string consisting of RGB triplets. Each color
	component in a triplet must be given as a hexadecimal string and its value
	must be in the range 0-255 inclusive. Each color component is separated
	from the next by a single space. Triplets are separated by (any amount of)
	whitespace.
	<p>

	If the XmNmaxColors resource isn't set or differs from the number of colors
	in the specified palette, it will be set to the size of this palette (with
	a maximum of 256 colors).
	<p>

	If the imageMapToPalette resource has been set but no value has been 
	specified for this resource, the XmHTML Widget will create a palette. The
	size of this palette is given by the value of the maxImageColors resource.
	<p>

	This resource can only be set at creation time.
<p>

<dt><a name="XmNimageProc">XmNimageProc</a>
<dd>The procedure that should perform image loading.
	The call to this procedure contains five arguments: the widget ID of the 
	XmHTML widget, the URL where the image can be obtained, the width and
	height of the image as specified by the <tt>width</tt> and <tt>height</tt>
	attributes on the <tt>&lt;IMG&gt;</tt> tag (they are 0 (zero) if these
	attributes have not been specified) and a pointer to
	data that the application attached to the widget using the
	<a href="#XmNclientData">XmNclientData</a> resource.
	<p>

	The return value of this procedure must be a pointer to a
	<a href="ImInfo.html">XmImageInfo</a> structure. The URL argument to
	this procedure must be copied into this structure, it has a very limited
	lifetime within XmHTML itself.
	<p>

	For common use, this resource should point to a procedure which 
	retrieves the requested image, calls the XmHTMLImageDefaultProc 
	convenience function and returns the obtained XmImageInfo structure.
	<p>

	When no value is provided for this resource, XmHTML installs an internal 
	procedure that is capable of loading local images only. This resource has
	no effect if XmNimageEnable is False.
<p>

<dt><a name="XmNimageRGBConversion">XmNimageRGBConversion</a>
<dd>This resource determines the conversion XmHTML should use when it's
	converting 24bit PNG images to 8bit ones.
	<p>

	Possible values are:
	<table border=0>
	<tr valign="top">
		<td>XmQUICK
		<td>A fast check is made to see if an image contains
			less than XmNmaxImageColors colors. If not, 24 to 8 bit conversion
			is done using (ordered) dither against a fixed palette.
	<tr valign="top">
		<td>XmBEST
		<td>A fast check is made to see if an image contains
			less than XmNmaxImageColors colors. If not, 24 to 8 bit conversion
			is done using a histogram of the 24bit image. This offers
			the best tradeoff between speed and image quality for 24 to 8 bit
			conversion as 24bit RGB images on web pages often have less than
			256 colors. This is the default setting.
	<tr valign="top">
		<td>XmFAST
		<td>dithers to a fixed palette right away. This is the fastest way
			to do 24 to 8 bit conversion.
	<tr valign="top">
		<td>XmSLOW
		<td>skips the fast check and does 24 to 8 bit conversion using a
			histogram immediatly. This setting produces the best results.
	<tr>
	</table>
<p>

<dt><a name="XmNmarginHeight">XmNmarginHeight</a>
<dd>The spacing at the top and bottom of the display area.
<p>

<dt><a name="XmNmarginWidth">XmNmarginWidth</a>
<dd>The spacing at the right and left sides of the display area.
<p>

<dt><a name="XmNmaxImageColors">XmNmaxImageColors</a>
<dd>Specifies how many colors each image may take. A value of 0 (default)
	informs a XmHTML widget that it may allocate as many colors as it can
	(with a maximum of 256 colors). When set to a non-zero value, images with
	more colors than allowed will be quantized to reduce the number of colors
	in the image.
	<p>

	When the XmNimageMapToPalette resource has a value other than XmDISABLED
	without providing a palette with the XmNimagePalette resource, a XmHTML
	widget will create a palette with at most this many colors.
<p>

<dt><a name="XmNmimeType">XmNmimeType</a>
<dd>This resource informs how XmHTML should treat any content specified by
	the <a href="#XmNvalue">XmNvalue</a> resource.
	XmHTML knows how to handle the following mime types:
	<b>text/html, text/plain</b> and every image mime type specification that
	starts with <b>image/</b>.
	<p>

	This resource only takes effect when used in combination with the
	<a href="#XmNvalue">XmNvalue</a> resource.
<p>

<dt><a name="XmNrepeatDelay">XmNrepeatDelay</a>
<dd>The number of milliseconds a button must remain pressed before continuing
	further scrolling. This resource is used for both the keyboard navigation
	keys and scrollbars. Depending on the capabilities of your graphics
	hardware, setting this resource to a small value can cause screen
	updates to be slow or incomplete.
<p>

<dt><a name="XmNresizeHeight">XmNresizeHeight</a>
<dd>If <b>False</b>(default), the HTML widget will not expand vertically to
	fit all of the text. If <b>True</b>, the HTML widget always begins its 
	display with the text at the beginning of the source and expand as much
	as possible, but it will never exceed 80% of the available screen height. 
<p>

<dt><a name="XmNresizeWidth">XmNresizeWidth</a>
<dd>If <b>False</b>(default), the HTML widget will not expand horizontally to
	fit its text. If <b>True</b>, the widget tries to change its width, but
	it will never exceed 80% of the available screen width. 
<p>

<dt><a name="XmNscreenGamma">XmNscreenGamma</a>
<dd>Display gamma correction. The default value of 2.2 will be sufficient for
	most displays. When using a Silicon Graphics display, this value should be
	set to 1.8, and when using a Macintosh display (MkLinux) it should be 1.4.
	This resource is only used for rendering JPEG and PNG images.
<p>

<dt><a name="XmNscrollBarDisplayPolicy">XmNscrollBarDisplayPolicy</a>
<dd>Controls the presence of the Vertical and Horizontal ScrollBars. Possible
	values:
	<p>
	<table cols=2 border=0>
	<tr>
		<td>XmSTATIC
		<td>/* scrollbars are always displayed */
	<tr>
		<td>XmAS_NEEDED
		<td>/* scrollbars are only displayed when view is clipped */
	<tr>
	</table>
<p>

<dt><a name="XmNscrollBarPlacement">XmNscrollBarPlacement</a>
<dd>The positions of the ScrollBars relative to the work window.
	Possible values:
	<p>
	<table cols=2 border=0>
	<tr>
		<td>XmTOP_LEFT
		<td>/* vertical ScrollBar on left; horizontal on top */
	<tr>
		<td>XmBOTTOM_LEFT
		<td>/* vertical ScrollBar on left; horizontal on bottom */
	<tr>
		<td>XmTOP_RIGHT
		<td>/* vertical ScrollBar on right; horizontal on top */
	<tr>
		<td>XmBOTTOM_RIGHT
		<td>/* vertical ScrollBar on right; horizontal on bottom */
	<tr>
	</table>

<p>

<dt><a name="XmNsmoothScrolling">XmNsmoothScrolling</a>
<dd>If <b>True</b> (default), XmHTML will perform smooth scrolling: any
	slider movement of the scrollbars will result in an immediate update
	of the screen.
	<p>

	In some cases, smooth scrolling may lead to portions of the document
	not being updated properly (for example, very fast dragging of a scrollbar
	or a small value for the <a href="#XmNrepeatDelay">XmNrepeatDelay</a>
	resource). If you experience this (unwanted) behavior, try setting this
	resource to <b>False</b>. XmHTML will then discard any motion events
	that are still unprocessed if a new motion event arrives. This <i>may</i>
	lead to jumpy scrolling but ensures that the screen is updated properly.

<p>

<dt><a name="XmNstrictHTMLChecking">XmNstrictHTMLChecking</a>
<dd>This resource enables <b>strict</b> checking of HTML files according to
	the <b>HTML 3.2</b> standard. Beware that <i>many</i> HTML files are in
	violation of this standard and that the result might be not exactly what
	is intended. 
	<p>

	One important check that is performed when this resource is <b>True</b> 
	concerns the values for all color specifications. When a color is specified
	by a name, only the <a href="extensions.html#colors">16 standard colors</a> 
	are allowed.

<p>

<dt><a name="XmNstringDirection">XmNStringDirection</a>
<dd>The direction in which to render the document contents. Possible values
	are XmSTRING_DIRECTION_L_TO_R and XmSTRING_DIRECTION_R_TO_L.

<p>

<dt><a name="XmNtabWidth">XmNtabWidth</a>
<dd>Specifies the width of a horizontal tab in preformatted text. This
	resource is specified as a positive, non-zero integer value.

<p>

<dt><a name="XmNtopLine">XmNtopLine</a>
<dd>The number of the line to display at the top of the window. Values for
	this resource are relative to the beginning of the text, where the first
	line is defined as 0.

<p>

<dt><a name="XmNuncompressCommand">XmNuncompressCommand</a>
<dd>Specifies the command the internal GIF decoder should use to uncompress
	<tt>compress(1)</tt> data. If the target system lacks the presence of
	<tt>compress(1)</tt>, <tt>gzip -d</tt> provides a good alternative.

<p>

<dt><a name="XmNvalue">XmNvalue</a>
<dd>The string value to display in the HTML Widget. Use XtSetValues to copy
	string values to the internal buffer. XtGetValues will return a pointer
	to the internal buffer which may <b>not</b> be freed <b>nor</b> modified.

<p>

<dt><a name="XmNverticalScrollBar">XmNverticalScrollBar</a>
<dd>The widget ID of the vertical scrollbar.

<p>

<dt><a name="XmNworkWindow">XmNworkWindow</a>
<dd>The widget ID of the display area.

<p>

</dl>

</blockquote>

<h3><font face="helvetica,arial">Inherited Resources</font></h3>

<blockquote>
XmHTML inherits the following resources. The resources are listed 
alphabetically, along with the superclass that defines them
<p>
<table cols=4 border=1 align="center">
<tr>
	<td><b>Resource</b>
	<td nowrap><b>Inherited From</b>

	<td><b>Resource</b>
	<td nowrap><b>Inherited From</b>
<tr>
<tr>
	<td>XmNaccelerators
	<td>Core

	<td>XmNancestorSensitive
	<td>Core
<tr>
	<td>XmNbackground
	<td>Core

	<td>XmNbackgroundPixmap
	<td>Core
<tr>
	<td>XmNborderColor
	<td>Core

	<td>XmNborderPixmap
	<td>Core
<tr>
	<td>XmNborderWidth
	<td>Core

	<td>XmNbottomShadowColor
	<td>Core
<tr>
	<td>XmNbottomShadowPixmap
	<td>Core

	<td>XmNchildren
	<td>Composite
<tr>
	<td>XmNcolormap
	<td>Core

	<td>XmNdepth
	<td>Core
<tr>
	<td>XmNdestroyCallback
	<td>Core

	<td>XmNforeground
	<td>Manager
<tr>
	<td>XmNhelpCallback
	<td>Manager

	<td>XmNheight
	<td>Core
<tr>
	<td>XmNhighlightColor
	<td>Manager

	<td>XmNhightlightPixmap
	<td>Manager
<tr>
	<td>XmNinitialResourcesPersistent
	<td>Core

	<td>XmNinsertPosition
	<td>Composite
<tr>
	<td>XmNmappedWhenManaged
	<td>Core

	<td>XmNnavigationType	
	<td>Manager
<tr>
	<td>XmNnumChildren
	<td>Composite

	<td>XmNscreen
	<td>Core
<tr>
	<td>XmNsensitive
	<td>Core

	<td>XmNshadowThickness
	<td>Manager
<tr>
	<td>XmNstringDirection
	<td>Manager

	<td>XmNtopShadowColor
	<td>Manager
<tr>
	<td>XmNtopShadowPixmap
	<td>Manager

	<td>XmNtranslations
	<td>Core
<tr>
	<td>XmNtraversalOn
	<td>Manager

	<td>XmNunitType
	<td>Manager
<tr>
	<td>XmNuserData
	<td>Manager

	<td>XmNwidth
	<td>Core
<tr>
	<td>XmNx
	<td>Core

	<td>XmNy
	<td>Core
<tr>
</table>

</blockquote>

<h3><font face="helvetica,arial">Callback Resources</font></h3>

<blockquote>
	XmHTMLWidget defines the following callback resources:
	<p>
<table border=0>
<tr>
	<td><b>Callback</b>
	<td><b>Reason Constant</b>
	<td><b>Event Type</b>
<tr>
	<tr valign="top">
		<td><a href="#XmNactivateCallback">XmNactivateCallback</a>
		<td>XmCR_ACTIVATE
		<td>XButtonReleasedEvent
	<tr valign="top">
		<td><a href="#XmNanchorTrackCallback">XmNanchorTrackCallback</a>
		<td>XmCR_HTML_ANCHORTRACK
		<td>XMotionEvent, XLeaveWindowEvent, XFocusOutEvent
	<tr valign="top">
		<td><a href="#XmNarmCallback">XmNarmCallback</a>
		<td>XmCR_ARM
		<td>XButtonPressedEvent
	<tr valign="top">
		<td><a href="#XmNdocumentCallback">XmNdocumentCallback</a>
		<td>XmCR_HTML_DOCUMENT
		<td>NULL
	<tr valign="top">
		<td><a href="#XmNeventCallback">XmNeventCallback</a>
		<td>XmCR_HTML_EVENT,<br>XmCR_HTML_EVENTDESTROY
		<td>dynamic
	<tr valign="top">
		<td><a href="#XmNfocusCallback">XmNfocusCallback</a>
		<td>XmCR_FOCUS
		<td>XFocusInEvent
	<tr valign="top">
		<td><a href="#XmNformCallback">XmNformCallback</a>
		<td>XmCR_HTML_FORM
		<td>XButtonPressedEvent
	<tr valign="top">
		<td><a href="#XmNframeCallback">XmNframeCallback</a>
		<td>XmCR_HTML_FRAME,<br>
			XmCR_HTML_FRAMECREATE,<br>
			XmCR_HTML_FRAMEDESTROY
		<td>NULL
	<tr valign="top">
		<td><a href="#XmNimagemapCallback">XmNimagemapCallback</a>
		<td>XmCR_HTML_IMAGEMAP,
			XmCR_HTML_IMAGEMAPACTIVATE
		<td>undefined
	<tr valign="top">
		<td><a href="#XmNinputCallback">XmNinputCallback</a>
		<td>XmCR_INPUT
		<td>XKeyEvent
	<tr valign="top">
		<td><a href="#XmNlinkCallback">XmNlinkCallback</a>
		<td>XmCR_HTML_LINK
		<td>NULL
	<tr valign="top">
		<td><a href="#XmNlosingFocusCallback">XmNlosingFocusCallback</a>
		<td>XmCR_LOSING_FOCUS
		<td>XFocusOutEvent
	<tr valign="top">
		<td><a href="#XmNmotionTrackCallback">XmNmotionTrackCallback</a>
		<td>XmCR_HTML_MOTIONTRACK
		<td>XMotionEvent
	<tr>
</table>
	<p>

	XmNactivateCallback is activated when a BSelect press occurs
	over an anchor or imagemap.
	<p>

	XmNanchorTrackCallback is activated when the pointer is moved over an
	achor or imagemap.
	<p>

	XmNarmCallback is activated when a BSelect Press occurs when not over
	an anchor or imagemap.
	<p>

	XmNdocumentCallback is activated when a XmHTML Widget has parsed a
	document but before it is displayed.
	<p>

	XmNeventCallback is activated when a HTML4.0 event is encountered.
	<p>

	XmNfocusCallback is activated when a XmHTML Widget gains the focus.
	<p>

	XmNformCallback is activated when a document containing a HTML
	&lt;FORM&gt; is to be submitted.
	<p>

	XmNframeCallback is activated when a XmHTML Widget encounters a document
	containing one or more &lt;FRAMESET&gt; specifications. A XmHTML Widget
	will only be able to handle framesets if a function has been registed
	for this callback resource.
	<p>

	XmNimagemapCallback is actived in any of the following cases:
	<p>
	<ol>
	<li>a BSelect press occurs over an image with the ISMAP attribute set
		but the USEMAP attribute has not been set or refers to a server-side
		imagemap;
	<li>a remote client-side imagemap should be fetched.
	</ol>
	<p>

	XmNinputCallback is activated whenever keyboard events that are
	not served by any of the other callback resources or action routines are
	received.
	<p>

	XmNlinkCallback is activated when a document containing &lt;LINK&gt; 
	elements is loaded into the a XmHTML widget. It is activated only once for
	a document.
	<p>

	XmNlosingFocusCallback is activated when a XmHTML Widget loses the focus.

	XmNmotionTrackCallback complements the XmNanchorTrackCallback resource.
	It is activated when pointer movement does not take place over an anchor
	or imagemap.

</blockquote>

<h3><font face="helvetica,arial">Callback Structures</font></h3>

<blockquote>
	Each callback function is passed the following structure:

	<pre>typedef struct{
    int reason;     /* the reason the callback was called */
    XEvent *event;  /* points to event structure that triggered callback */
}XmAnyCallbackStruct;
	</pre>

	None of the fields in this structure (and any other callback structure
	for that matter) may be freed, unless explicitly noted otherwise.

	<p>
	In addition, several callback resources reference additional structures.

	<h4><font face="helvetica,arial">
		<a name="XmNactivateCallback">XmNactivateCallback</a>,
		<a name="XmNanchorTrackCallback">XmNanchorTrackCallback</a>
		</font></h4>

	XmNactivateCallback and XmNanchorTrackCallback reference the following
	structure:
	<p>

	<pre>typedef struct{
    int reason;             /* the reason the callback was called       */
    XEvent *event;          /* event structure that triggered callback  */
    URLType url_type;       /* type of url referenced                   */
    Cardinal line;          /* line number of the selected anchor       */
    String href;            /* pointer to the anchor value              */
    String target;          /* pointer to target value                  */
    String rel;             /* pointer to rel value                     */
    String rev;             /* pointer to rev value                     */
    String title;           /* pointer to title value                   */
    Boolean is_frame;       /* true when inside a frame                 */
    Boolean doit;           /* local anchor vetoing flag                */
    Boolean visited;        /* local anchor visited flag                */
    Boolean doc_modified;   /* document modification flag               */
}XmHTMLAnchorCallbackStruct;
	</pre>

	The <i>doit</i> member is only meaningfull when the callback reason is
	XmCR_ACTIVATE and the referenced anchor is a local (named) anchor. When
	set to <b>True</b>, the widget will scroll to the referenced anchor. 
	When this member is <b>False</b> (default), the widget will <b>not</b>
	scroll to the named anchor.
	<p>

	The <i>visited</i> member is only meaningfull when the callback reason is
	XmCR_ACTIVATE and the referenced anchor is a local (named) anchor. When
	set to <b>True</b>, the referenced anchor will be rendered using
	the XmNanchorVisitedForeground and XmNanchorVisitedUnderlineType
	resources. The default value for this member is <b>False</b>.
	<p>

	The <i>doc_modified</i> member should be set to <b>True</b> when
	an action taken during processing of this callback results in a
	modification of the currently displayed document. The default value
	for this member is <b>False</b>.
	<p>

	The XmNanchorTrackCallback callback is called twice for an anchor: once
	when the pointer is moved into an anchor and once when it is moved away
	from an anchor. In the latter case, all fields except <i>reason</i> and
	<i>event</i> will be NULL.
	<p>

	See <a href="GtURLTyp.html">XmHTMLGetURLType(3X)</a> for possible
	values and meaning of the <i>url_type</i> field.

	<h4><font face="helvetica,arial">
		<a name="XmNdocumentCallback">XmNdocumentCallback</a>
		</font></h4>
	XmNdocumentCallback references the following structure:
	<p>

	<pre>typedef struct{
    int reason;             /* the reason the callback was called       */
    XEvent *event;          /* always NULL for XmNdocumentCallback      */
    Boolean html32;         /* True if document was HTML 3.2 conforming */
    Boolean verified;       /* True if document has been verified       */
    Boolean balanced;       /* True if parser tree is balanced          */
    Boolean terminated;     /* True if parser terminated prematurely    */
    int pass_level;         /* current parser level count. Starts at 1  */
    Boolean redo;           /* perform another pass?                    */
}XmHTMLDocumentCallbackStruct, *XmHTMLDocumentPtr;
	</pre>

	The <i>verified</i> field is set to <b>True</b> when the internal parses 
	has successfully verified the HTML semantics of the loaded document, while
	the <i>balanced</i> field will be <b>True</b> when the parser has
	generated a balanced tree. A balanced tree is one in which all
	terminated HTML elements have their opening and closing members at the
	same level in the tree.

	The <i>pass_level</i> field contains the number of passes performed so far
	by the parser.
	<p>

	Setting the <i>redo</i> field to <b>True</b> will instruct the parser to
	make another pass on the current document. It is only effective when the
	parser failed to generate a balanced tree since using an unbalanced tree
	can lead to weird markup. When the <i>balanced</i> field is false, the
	default value for this field is <b>True</b>.
	<p>

	When no XmNdocumentCallback callback resource is installed, the internal
	HTML parses will make at most two passes on the current document.

	<h4><font face="helvetica, arial">
		<a name="XmNeventCallback">XmNeventCallback</a>
		</font></h4>

	XmNeventCallback references the following structure:
	<p>
	<pre>typedef struct{
    int reason;             /* the reason the callback was called       */
    XEvent *event;          /* event structure that triggered callback  */
    int type;               /* HTML4.0 event type, see below            */
    XtPointer data;         /* HTML4.0 event callback data              */
    Boolean doc_modified;   /* document modification flag               */
}XmHTMLEventCallbackStruct;
	</pre>

	Where <i>type</i> identifies a HTML4.0 event and <i>data</i> any data
	returned by the function installed on the
	<a href="#XmNeventProc">XmNeventProc</a> resource.
	<p>

	The <i>doc_modified</i> member should be set to <b>True</b> when
	an action taken during processing of an event results in a
	modification of the currently displayed document. Failing to update
	this member properly while the document is changed during event processing
	<b>will</b> lead to serious problems since XmHTML's internal data
	structures will then no longer refer to the currently displayed document.
	<p>

	The table shown below lists all events for which a modification of
	the document is supported during event processing.
	The default value for this member is <b>False</b>.

	<p>

	<i>type</i> can have any of the following values:
	<p>

	<center>
	<table border="1">
		<tr>
			<th>type value
			<th><a href="http://www.w3.org/TR/WD-html40/">HTML4.0</a>
					event
			<th>doc_modified allowed?
		</tr>
		<tr>
			<td>XmCR_HTML_LOAD
			<td>onLoad
			<td>No
		</tr>
		<tr>
			<td>XmCR_HTML_UNLOAD
			<td>onUnLoad
			<td>No
		</tr>
		<tr>
			<td>XmCR_HTML_SUBMIT
			<td>onSubmit
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_RESET
			<td>onReset
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_FOCUS
			<td>onFocus
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_BLUR
			<td>onBlur
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_SELECT
			<td>onSelect
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_CHANGE
			<td>onChange
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_CLICK
			<td>onClick
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_DOUBLE_CLICK
			<td>onDblClick
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_MOUSEDOWN
			<td>onMouseDown
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_MOUSEUP
			<td>onMouseUp
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_MOUSEOVER
			<td>onMouseOver
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_MOUSEMOVE
			<td>onMouseMove
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_MOUSEOUT
			<td>onMouseOut
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_KEYPRESS
			<td>onKeyPress
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_KEYDOWN
			<td>onKeyDown
			<td>Yes
		</tr>
		<tr>
			<td>XmCR_HTML_KEYUP
			<td>onKeyUp
			<td>Yes
		</tr>
		<tr>
		</tr>
	</table>
	</center>
	<p>

	The expected behavior depends on the value of the <i>reason</i> field:
	<p>
	<dl>
	<dt><b><font face="helvetica,arial">XmCR_EVENT</font></b>
	<dd>A HTML4.0 event occured on an element in the currently displayed
		document. The application should undertake any actions that
		correspond to the HTML4.0 event <i>type</i>. <i>data</i> identifies
		the data associated with this particular event (which can be
		different depending on the HTML tag that triggered this event).
	<p>

	<dt><b><font face="helvetica,arial">XmCR_EVENTDESTROY</font></b>
	<dd>This reason occurs as part of the document unloading process, e.i.,
		prior before a new document is loaded. Any application <i>data</i>
		stored to serve the HTML4.0 event <i>type</i> can be freed safely.
	</dl>
	<p>

	<h4><font face="helvetica,arial">
		<a name="XmNformCallback">XmNformCallback</a>
		</font></h4>

	XmNformCallback references the following structure:
	<p>

	<pre>typedef struct{
    int reason;             /* the reason the callback was called       */
    XEvent *event;          /* event structure that triggered callback  */
    String action;          /* URL or cgi-bin destination               */
    String enctype;         /* form encoding                            */
    int method;             /* Form Method, GET (0) or POST (1)         */
    int ncomponents;        /* no of components in this form            */
    XmHTMLFormDataPtr components;
    Boolean doc_modified;   /* document modification flag               */
}XmHTMLFormCallbackStruct, *XmHTMLFormPtr;
	</pre>

	Where the <i>XmHTMLFormDataPtr</i> field points to an array of structures
	of the following type:
	<p>

	<pre>typedef struct{
    componentType type;     /* Form component type  */
    String name;            /* component name       */
    String value;           /* component value      */
}XmHTMLFormDataRec, *XmHTMLFormDataPtr;
	</pre>

	The componentType type identifies the type of the form member that
	is to be submitted. Possible values are:
	<p>

	<pre>typedef enum{
    FORM_TEXT = 1,          /* textfield            */
    FORM_PASSWD,            /* password textfield   */
    FORM_CHECK,             /* checkbox             */
    FORM_RADIO,             /* radiobox             */
    FORM_RESET,             /* reset button         */
    FORM_FILE,              /* filelisting          */
    FORM_SELECT,            /* select parent        */
    FORM_OPTION,            /* select child         */
    FORM_TEXTAREA,          /* multiline edit field */
    FORM_IMAGE,             /* drawbutton           */
    FORM_HIDDEN,            /* hidden input         */
    FORM_SUBMIT             /* submit button        */
}componentType;
	</pre>
	<p>

	The <i>doc_modified</i> member should be set to <b>True</b> when
	an action taken during processing of this callback results in a
	modification of the currently displayed document. The default value
	for this member is <b>False</b>.
	<p>

	<h4><font face="helvetica,arial">
		<a name="XmNframeCallback">XmNframeCallback</a>
		</font></h4>

	XmNframeCallback references the following structure:
	<p>

	<pre>typedef struct{
    int reason;         /* the reason the callback was called       */
    XEvent *event;      /* event structure that triggered callback  */
    String src;         /* requested document                       */
    String name;        /* frame name                               */
    Widget html;        /* XmHTML widget id                         */
    Boolean doit;       /* destroy/create vetoing flag              */
}XmHTMLFrameCallbackStruct, *XmHTMLFramePtr;
	</pre>

	The expected behavior depends on the value of the <i>reason</i> field:
	<p>

	<dl>
	<dt><b><font face="helvetica,arial">XmCR_HTML_FRAMECREATE</font></b>
	<dd>A XmHTML Widget is about to create a xmHTMLWidgetClass widget
		(referred to as a <i>frame</i>) to be used as part of a HTML frameset.
		<p>

		The <i>src</i> field contains the URL where a source document destined
		for this frame can be obtained. The <i>name</i> field contains
		the name given to this frame by the author of the document. If no name
		has been provided in the frameset definition, XmHTML will use
		<tt>_frame</tt> appended with a rank number as a default name. 
		<p>

		The <i>doit</i> field is set to <b>True</b> by default. When this
		field is set to <b>False</b> and the <i>html</i> field (which is
		initially NULL) is set to contain the id of a xmHTMLWidgetClass widget,
		XmHTML will use this widget as a frame and will not create a new one
		when this callback function returns. When the <i>doit</i> field is
		unchanged, or when the provided widget ID does not identify a Widget
		of class xmHTMLWidgetClass, XmHTML will create a frame.
		<p>

		Each frame created by XmHTML in response to a HTML frameset will be a
		child of the XmHTML widget in which the original document was loaded.
	<p>

	<dt><b><font face="helvetica,arial">XmCR_HTML_FRAME</font></b>
	<dd>A XmHTML Widget XmHTML has created a frame (or prepared the widget
		provided by the previous callback reason). The <i>src</i> and
		<i>name</i> field are unchanged, while the <i>html</i> field
		contains a valid widget id.
		<p>

		This callback reason allows one to (amongst others) add callbacks
		(most noticeably a XmNactivateCallback) and resources (such as a
		XmNimageProc handler) to this newly created or reused widget.
	<p>

	<dt><b><font face="helvetica,arial">XmCR_HTML_FRAMEDESTROY</font></b>
	<dd>A XmHTML Widget is about to destroy a frame. The <i>src, name</i>
		and <i>html</i> fields identify the frame that is to be destroyed.
		Modifying the value of the <i>doit</i> field from <b>True</b> (default)
		to <b>False</b> will veto the destruction of this frame, and
		subsequently this frame can be reused at a later stage. 
	</dl>
	<p>

	The <i>name</i> field is rather important for navigating between different
	frames in a frameset: anchors can reference to another frame by using the
	<i>target</i> attribute on the &lt;A&gt; tag. Knowing this, the reasons
	for this type of approach becomes apparent: to allow navigation between
	different frames in a frameset, one should not only know the name of the
	referenced frame but also the widget id of the corresponding frame.
	And this is exactly what this approach provides.

	<h4><font face="helvetica,arial">
		<a name="XmNimagemapCallback">XmNimagemapCallback</a>
		</font></h4>

	XmNimagemapCallback references the following structure:
	<p>

	<pre>typedef struct{
    int reason;           /* the reason the callback was called */
    XEvent *event;        /* points to event structure that triggered callback */
    int x,y;              /* pointer position relative to the upper-left
                           * corner of the image.
                           */
    String image_name;    /* name of referenced image  */
    String map_name;      /* name of imagemap to fetch */
    String map_contents;  /* contents of fetched imagemap */
}XmHTMLImagemapCallbackStruct, *XmHTMLImagemapCallbackStructPtr;
	</pre>

	The expected behavior depends on the value of the <i>reason</i> field:
	<p>

	<dl>
	<dt><b><font face="helvetica,arial">XmCR_HTML_IMAGEMAPACTIVATE</font></b>
	<dd>
		<p>
		<b><font face="helvetica,arial" size="+3" color="darkred">THIS REASON
			IS UNIMPLEMENTED</font></b>
		<p>
		user clicked on an image. All fields except <i>map_name</i> are valid.
		x and y are relative to the upper-left corner of the image. Only
		invoked when an image has it's ismap attribute set and no client-side
		usemap is present for this image.

	<p>

	<dt><b><font face="helvetica,arial">XmCR_HTML_IMAGEMAP</font></b>
	<dd>an image requires an external imagemap. Valid fields are
		<i>image_name</i> and <i>map_name</i>. The latter contains the
		location of the imagemap to fetch. If the contents of this imagemap
		are set in the <i>map_contents</i> field, it will be copied by the
		widget. Alternatively, one could also use the
		<a href="ImImgMap.html">XmHTMLAddImagemap</a> convenience 
		function to set an imagemap into the widget.
	</dl>


	<h4><font face="helvetica,arial">
		<a name="XmNlinkCallback">XmNlinkCallback</a>
		</font></h4>

	XmNlinkCallback references the following structure:
	<p>

	<pre>typedef struct{
    int reason;                 /* the reason the callback was called       */
    XEvent *event;              /* event structure that triggered callback  */
    int num_link;               /* number of LINK info to process           */
    XmHTMLLinkDataPtr link;     /* array of LINK info to process            */
}XmHTMLLinkCallbackStruct, *XmHTMLLinkPtr;
	</pre>

	Where the <i>XmHTMLLinkDataPtr</i> field points to an array of structures
	of the following type:

	<pre>typedef struct{
    String url;             /* value of URL tag     */
    String rel;             /* value of REL tag     */
    String rev;             /* value of REV tag     */
    String title;           /* value of TITLE tag   */
}XmHTMLLinkDataRec, *XmHTMLLinkDataPtr;
	</pre>

</blockquote>

<h3><font face="helvetica,arial">Translations</font></h3>

<blockquote>
The translations for XmHTML include those from Manager, as well as the
following.
<p>

<center>
<table border=1 align=center>
<tr valign=top>
	<th>Virtual Event
	<th>Actual Event
	<th>Action

<tr valign=top>
	<td nowrap>BSelect Press
	<td nowrap>None&lt;Btn1&gt;Press
	<td>extend-start()

<tr valign=top>
	<td nowrap>BDrag Press	
	<td nowrap>None&lt;Btn2&gt;Press
	<td>extend-start()

<tr valign=top>
	<td nowrap>BSelect Motion
	<td nowrap>None&lt;Btn1&gt;Motion
	<td>extend-adjust()

<tr valign=top>
	<td nowrap>BDrag Motion
	<td nowrap>None&lt;Btn2&gt;Motion
	<td>extend-adjust()

<tr valign=top>
	<td nowrap>BSelect Release
	<td nowrap>None&lt;Btn1&gt;Release
	<td>extend-end()

<tr valign=top>
	<td nowrap>BDrag Release
	<td nowrap>None&lt;Btn1&gt;Release
	<td>extend-end()

<tr valign=top>
	<td>Motion
	<td>Motion
	<td>track-motion()

<tr valign=top>
	<td>KHelp
	<td nowrap>None&lt;Key&gt;osfHelp
	<td>ManagerGadgetHelp()

<tr valign=top>
	<td>KPageUp
	<td nowrap>None&lt;Key&gt;osfPageUp
	<td>page-up-or-left(0)

<tr valign=top>
	<td>KPageDown
	<td nowrap>None&lt;Key&gt;osfPageDown
	<td>page-down-or-right(0)

<tr valign=top>
	<td>KPageLeft
	<td nowrap>!Ctrl&lt;Key&gt;osfPageUp
	<td>page-up-or-left(1)

<tr valign=top>
	<td>KPageRight
	<td nowrap>!Ctrl&lt;Key&gt;osfPageDown
	<td>page-down-or-right(1)

<tr valign=top>
	<td>KUp	
	<td nowrap>None&lt;Key&gt;osfUp
	<td>increment-up-or-left(0)

<tr valign=top>
	<td>KDown
	<td nowrap>None&lt;Key&gt;osfDown
	<td>increment-down-or-right(0)

<tr valign=top>
	<td>KLeft
	<td nowrap>None&lt;Key&gt;osfLeft
	<td>increment-up-or-left(1)

<tr valign=top>
	<td>KRight
	<td nowrap>None&lt;Key&gt;osfRight
	<td>increment-down-or-right(1)

<tr valign=top>
	<td>KBeginData
	<td nowrap>!Ctrl&lt;Key&gt;osfBeginLine
	<td>top-or-bottom(0)

<tr valign=top>
	<td>KEndData
	<td nowrap>!Ctrl&lt;Key&gt;osfEndLine
	<td>top-or-bottom(1)

<tr valign=top>
	<td nowrap>Press
	<td nowrap>&lt;Key&gt;Press
	<td>process-html-input()

<tr valign=top>
	<td nowrap>Release
	<td nowrap>&lt;Key&gt;Release
	<td>process-html-input()
<tr>
</table>
</center>
<p>

These translations mask off any key and button modifiers (except where
noted otherwise), and as such application programmers can use any modifiers
on the events shown above for their own purposes.

</blockquote>

<h3><font face="helvetica,arial">Action Routines</font></h3>

<blockquote>
XmHTML defines the following action routines:

<dl>
<dt>extend-adjust()
<dd>Selects text that is between the pointer anchor and the current pointer 
	location, while deselecting text that is outside this area. 
	As a result of this action, when the pointer moves past lines of text, 
	these lines are selected and the current line is selected up to the 
	position of the pointer.
<p>

<dt>extend-end()
<dd>Ends the selection performed by extend-adjust.
	When the current selection is an exclusive HTML anchor, this action routine
	also invokes the list of callbacks specified by XmNactivateCallback.
<p>

<dt>extend-start()
<dd>Invalidates any previous selection, sets the pointer anchor and prepares 
	for selecting text via the extend-adjust action. This action routine
	invokes the list of callbacks specified by XmNarmCallback. 
<p>

<dt>increment-up-or-left(flag)
<dd>Moves the visible area by one increment - upward if <i>flag</i> is 0;
to the left if <i>flag</i> is 1.
<p>

<dt>increment-down-or-right(flag)
<dd>Moves the visible area by one increment - downward if <i>flag</i> is 0;
to the right if <i>flag</i> is 1.
<p>

<dt>page-up-or-left(flag)
<dd>Moves the visible area by one page - upward if <i>flag</i> is 0;
to the left if <i>flag</i> is 1.
<p>

<dt>page-down-or-right(flag)
<dd>Moves the visible area by one page - downward if <i>flag</i> is 0;
to the right if <i>flag</i> is 1.
<p>

<dt>process-html-input()
<dd>This action routine processes all remaining keyboard events and invokes
the list of callbacks specified by XmNinputCallback.
<p>

<dt>top-or-bottom(flag)
<dd>Moves the visible area - to the top of the text if <i>flag</i> is 0;
to the bottom of the text if <i>flag</i> is 1.
<p>

<dt>track-motion
<dd>This action routine processes any pointer movement events.
When pointer movement takes place over a HTML anchor, the list of callbacks 
specified by XmNanchorTrackCallback is invoked, otherwise it invokes the list 
of callbacks specified by XmNmotionTrackCallback.
</dl>
<p>

</blockquote>

<h3><font face="helvetica,arial">Additional Behavior</font></h3>

<blockquote>
XmHTML has additional behavior associated with &lt;Leave&gt; and
&lt;FocusOut&gt; which invokes the list of callbacks specified by
XmNanchorTrackCallback. Also, XmHTML attaches Manager's
<i>ManagerGadgetHelp()</i> action routine to the workWindow.
</blockquote>

<h3><font face="helvetica,arial">See Also</font></h3>

<blockquote>
	Core(3X), Composite(3X), Constraint(3X), Manager(3X),
</blockquote>

<hr noshade size="2" width="25%">
<i><font size="-1">
XmHTML, September 1, 1998
</font></i>
</body>
</html>