Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

mi32/xmhtml.h File Reference

#include <X11/Intrinsic.h>
#include <Xm/Xm.h>
#include <mi32/html.h>

Include dependency graph for xmhtml.h:

Include dependency graph

Go to the source code of this file.

Defines

#define XmHTMLVERSION   1
#define XmHTMLREVISION   1
#define XmHTMLUPDATE_LEVEL   5
#define XmHTMLVersion   (XmHTMLVERSION * 1000 + XmHTMLREVISION * 100 + XmHTMLUPDATE_LEVEL)
#define XmHTMLVERSION_STRING   "XmHTML Beta Version 1.1.5 (C)Ripley Software Development"
#define XMHTMLEXPORT   extern
#define XmIsHTML(w)   XtIsSubclass(w, xmHTMLWidgetClass)
#define XmHTMLTextSet

Typedefs

typedef unsigned char CHAR
typedef _XmHTMLRec * XmHTMLWidget

Functions

XMHTMLEXPORT XmImageInfo * XmHTMLImageDefaultProc (Widget w, String file, unsigned char *buf, int size)
XMHTMLEXPORT unsigned char XmHTMLImageGetType (String file, unsigned char *buf, int size)
XMHTMLEXPORT Boolean XmHTMLImageJPEGSupported (void)
XMHTMLEXPORT Boolean XmHTMLImagePNGSupported (void)
XMHTMLEXPORT Boolean XmHTMLImageGZFSupported (void)
XMHTMLEXPORT XmImageStatus XmHTMLImageReplace (Widget w, XmImageInfo *image, XmImageInfo *new_image)
XMHTMLEXPORT XmImageStatus XmHTMLImageUpdate (Widget w, XmImageInfo *image)
XMHTMLEXPORT void XmHTMLImageFreeAllImages (Widget w)
XMHTMLEXPORT void XmHTMLImageAddImageMap (Widget w, String image_map)
XMHTMLEXPORT void XmHTMLImageFreeImageInfo (Widget w, XmImageInfo *info)
XMHTMLEXPORT int XmHTMLImageGetImageInfoSize (XmImageInfo *info)
XMHTMLEXPORT void XmHTMLImageProgressiveSuspend (Widget w)
XMHTMLEXPORT void XmHTMLImageProgressiveContinue (Widget w)
XMHTMLEXPORT void XmHTMLImageProgressiveKill (Widget w)
XMHTMLEXPORT XmImage * XmImageCreate (Widget w, String file, Dimension width, Dimension height, XmImageConfig *config)
XMHTMLEXPORT XmImage * XmImageCreateFromInfo (Widget w, XmImageInfo *info, Dimension width, Dimension height, XmImageConfig *config)
XMHTMLEXPORT void XmImageDestroy (XmImage *image)
XMHTMLEXPORT int XmImageSetBackgroundImage (XmImage *src, Drawable dest, int src_x, int src_y, int width, int height, int dest_x, int dest_y)
XMHTMLEXPORT int XmImageDrawImage (XmImage *image, Drawable dest, int src_x, int src_y, int dest_x, int dest_y)
XMHTMLEXPORT Boolean XmImageExport (XmImageInfo *info, String file, Dimension width, Dimension height, unsigned char type)
XMHTMLEXPORT Boolean XmHTMLGIFtoGZF (String infile, unsigned char *buf, int size, String outfile)
XMHTMLEXPORT int XmHTMLAnchorGetId (Widget w, String anchor)
XMHTMLEXPORT void XmHTMLAnchorScrollToId (Widget w, int anchor_id)
XMHTMLEXPORT void XmHTMLAnchorScrollToName (Widget w, String anchor)
XMHTMLEXPORT Boolean XmHTMLAnchorVisibleByName (Widget w, String anchor)
XMHTMLEXPORT Boolean XmHTMLAnchorVisibleById (Widget w, int anchor_id)
XMHTMLEXPORT void XmHTMLAnchorReEval (Widget w, String href, Boolean visited)
XMHTMLEXPORT void XmHTMLTextScrollToLine (Widget w, int line)
XMHTMLEXPORT void XmHTMLTextSetString (Widget w, String text)
XMHTMLEXPORT void XmHTMLTextSetStringWithLength (Widget w, String text, size_t len)
XMHTMLEXPORT String XmHTMLTextGetSource (Widget w)
XMHTMLEXPORT String XmHTMLTextGetString (Widget w)
XMHTMLEXPORT String XmHTMLTextGetFormatted (Widget w, unsigned char papertype, XmHTMLPaperSize *paperdef, unsigned char type, unsigned char PSoptions)
XMHTMLEXPORT String XmHTMLTextGetSelection (Widget w)
XMHTMLEXPORT void XmHTMLTextClearSelection (Widget w, Time time)
XMHTMLEXPORT Boolean XmHTMLTextSetSelection (Widget w, XmHTMLTextPosition first, XmHTMLTextPosition last, Time time)
XMHTMLEXPORT void XmHTMLTextSetHighlight (Widget w, XmHTMLTextPosition first, XmHTMLTextPosition last, XmHighlightMode mode)
XMHTMLEXPORT Boolean XmHTMLTextCopy (Widget w, Time time)
XMHTMLEXPORT Boolean XmHTMLTextShowPosition (Widget w, XmHTMLTextPosition position)
XMHTMLEXPORT XmHTMLTextFinder XmHTMLTextFinderCreate (Widget w)
XMHTMLEXPORT void XmHTMLTextFinderDestroy (XmHTMLTextFinder finder)
XMHTMLEXPORT Boolean XmHTMLTextFinderSetPattern (XmHTMLTextFinder finder, String to_find)
XMHTMLEXPORT Boolean XmHTMLTextFinderSetPatternFlags (XmHTMLTextFinder finder, int flags, Boolean ignore_case, XmHTMLDirection direction)
XMHTMLEXPORT int XmHTMLTextFinderGetError (XmHTMLTextFinder finder)
XMHTMLEXPORT String XmHTMLTextFinderGetErrorString (XmHTMLTextFinder finder)
XMHTMLEXPORT XmHTMLRegexStatus XmHTMLTextFindString (Widget w, XmHTMLTextFinder finder)
XMHTMLEXPORT void XmHTMLTextFinderReset (XmHTMLTextFinder finder)
XMHTMLEXPORT Boolean XmHTMLTextFindToPosition (Widget w, XmHTMLTextFinder finder, XmHTMLTextPosition *start, XmHTMLTextPosition *end)
XMHTMLEXPORT int XmHTMLTagGetNumber (String attributes, String tag, int default_value)
XMHTMLEXPORT int XmHTMLTagCheckNumber (String attributes, String tag, int default_value)
XMHTMLEXPORT String XmHTMLTagGetValue (String attributes, String tag)
XMHTMLEXPORT Boolean XmHTMLTagCheck (String attributes, String tag)
XMHTMLEXPORT Boolean XmHTMLTagCheckValue (String attributes, String tag, String check)
XMHTMLEXPORT int XmHTMLGetVersion (void)
XMHTMLEXPORT URLType XmHTMLGetURLType (String href)
XMHTMLEXPORT String XmHTMLGetTitle (Widget w)
XMHTMLEXPORT XmHTMLInfoStructure * XmHTMLXYToInfo (Widget w, int x, int y)
XMHTMLEXPORT XmHTMLDocumentInfo * XmHTMLGetDocumentInfo (Widget w)
XMHTMLEXPORT void XmHTMLFreeDocumentInfo (XmHTMLDocumentInfo *doc_info)
XMHTMLEXPORT Boolean XmHTMLGetHeadAttributes (Widget w, XmHTMLHeadAttributes *head, unsigned char mask_bits)
XMHTMLEXPORT Widget XmHTMLFrameGetChild (Widget w, String name)
XMHTMLEXPORT Widget XmCreateHTML (Widget parent, String name, ArgList arglist, Cardinal argcount)
XMHTMLEXPORT void XmHTMLRedisplay (Widget w)
XMHTMLEXPORT XmHTMLFontCacheInfo * XmHTMLGetFontCacheInfo (Widget w)
XMHTMLEXPORT void XmHTMLFreeFontCacheInfo (XmHTMLFontCacheInfo *info)
XMHTMLEXPORT Pixel XmHTMLAllocColor (Widget w, String color, Pixel def_pixel)
XMHTMLEXPORT void XmHTMLFreeColor (Widget w, Pixel pixel)
XMHTMLEXPORT void _XmHTMLSetTkaOverrideFunc (void(*)(void *, void *), void *)

Variables

typedef_XFUNCPROTOBEGIN struct
_XmHTMLClassRec * 		XmHTMLWidgetClass
XMHTMLEXPORT WidgetClass xmHTMLWidgetClass

Define Documentation

#define XMHTMLEXPORT   extern
 

Definition at line 202 of file xmhtml.h.

#define XmHTMLREVISION   1
 

Definition at line 164 of file xmhtml.h.

#define XmHTMLTextSet
 

Value:

(WIDGET,TEXT) XtVaSetValues((WIDGET), \
      XmNvalue, (TEXT), NULL)

Definition at line 536 of file xmhtml.h.

#define XmHTMLUPDATE_LEVEL   5
 

Definition at line 165 of file xmhtml.h.

#define XmHTMLVersion   (XmHTMLVERSION * 1000 + XmHTMLREVISION * 100 + XmHTMLUPDATE_LEVEL)
 

Definition at line 166 of file xmhtml.h.

#define XmHTMLVERSION   1
 

Definition at line 163 of file xmhtml.h.

#define XmHTMLVERSION_STRING   "XmHTML Beta Version 1.1.5 (C)Ripley Software Development"
 

Definition at line 172 of file xmhtml.h.

#define XmIsHTML (  w   )     XtIsSubclass(w, xmHTMLWidgetClass)
 

XmIsHTML.

Definition at line 244 of file xmhtml.h.

Typedef Documentation

typedef unsigned char CHAR
 

UNICODE < CHAR_ALREADY_TYPEDEFED.

Definition at line 219 of file xmhtml.h.

typedef struct _XmHTMLRec* XmHTMLWidget
 

Definition at line 230 of file xmhtml.h.

Function Documentation

XMHTMLEXPORT void _XmHTMLSetTkaOverrideFunc (  void(*  )(void *, void *),
void * 
) 
 

Function that won't be needed once we can specify a tka as a resource.

Returns:
nothing

XMHTMLEXPORT Widget XmCreateHTML (  Widget  parent,
String  name,
ArgList  arglist,
Cardinal  argcount
) 
 

Creates an XmHTML widget.

Returns:
a newly created widget This routine exits if parent is NULL or a subclass
Parameters:
parent  widget to act as parent for this new XmHTMLWidget
name  name for the new widget
arglist  arguments for this new XmHTMLWidget
argcount  number of arguments

XMHTMLEXPORT Pixel XmHTMLAllocColor (  Widget  w,
String  color,
Pixel  def_pixel
) 
 

Allocates the named color and takes the XmNmaxImageColors resource into account.

Returns:
allocated pixel upon success or def_pixel upon failure
Parameters:
w  XmHTMLWidget id
color  colorname, either symbolic or an RGB triplet
def_pixel  pixel to return when allocation of "color fails

XMHTMLEXPORT int XmHTMLAnchorGetId (  Widget  w,
String  anchor
) 
 

Returns the internal id of an anchor.

Returns:
the id upon success, -1 if not found Anchor related convenience functions These routines can be used to jump to named anchors.
Parameters:
w  XmHTMLWidget
anchor  anchor to locate

XMHTMLEXPORT void XmHTMLAnchorReEval (  Widget  w,
String  href,
Boolean  visited
) 
 

Checks an HTML instance against a current href name.

Returns:
nothing Checks an HTML instance against a current href name and alters any matching anchors to visited and causes a refesh. If visited is True, the matching anchor is rendered as visited. If it's False, it will be rendered as not visited.
Parameters:
w  html widget
href  current anchors reference
visited  href visited

XMHTMLEXPORT void XmHTMLAnchorScrollToId (  Widget  w,
int  anchor_id
) 
 

Moves the text with the current anchor on top.

Returns:
nothing
Parameters:
w  XmHTMLWidget
anchor_id  internal anchor id to scroll to

XMHTMLEXPORT void XmHTMLAnchorScrollToName (  Widget  w,
String  anchor
) 
 

Moves the text with the current anchor on top.

Returns:
nothing
Parameters:
w  XmHTMLWidget
anchor  anchor to scroll to

XMHTMLEXPORT Boolean XmHTMLAnchorVisibleById (  Widget  w,
int  anchor_id
) 
 

Figure out if the given anchor is in the visible area.

Returns:
true when anchor is visible, false if not.
Parameters:
w  XmHTMLWidget id
anchor_id  ID of anchor for which to test visibility

XMHTMLEXPORT Boolean XmHTMLAnchorVisibleByName (  Widget  w,
String  anchor
) 
 

Figure out if the given anchor is in the visible area.

Returns:
true when anchor is visible, false if not.
Parameters:
w  XmHTMLWidget id
anchor  NAME of anchor for which to test visibility

XMHTMLEXPORT Widget XmHTMLFrameGetChild (  Widget  w,
String  name
) 
 

Returns the Widget id of a frame child given it's name.

Returns:
if found, the widget id of the requested fram, NULL otherwise
Parameters:
w  XmHTMLWidget
name  name of frame to locate

XMHTMLEXPORT void XmHTMLFreeColor (  Widget  w,
Pixel  pixel
) 
 

Releases an allocated pixel.

Returns:
nothing
Parameters:
w  XmHTMLWidget id
pixel  pixel to be freed

XMHTMLEXPORT void XmHTMLFreeDocumentInfo (  XmHTMLDocumentInfo *  doc_info  ) 
 

Frees an XmHTMLDocumentInfo structure.

Returns:
nothing
Parameters:
doc_info  structure to be freed

XMHTMLEXPORT void XmHTMLFreeFontCacheInfo (  XmHTMLFontCacheInfo *  info  ) 
 

Frees the given font cache info.

Returns:
nothing
Parameters:
info  font cache info to free

XMHTMLEXPORT XmHTMLDocumentInfo* XmHTMLGetDocumentInfo (  Widget  w  ) 
 

Returns a list of all images and anchors found in the currently displayed page.

Returns:
a new XmHTMLDocumentInfo structure on success or NULL on failure
Parameters:
w  XmHTMLWidget id

XMHTMLEXPORT XmHTMLFontCacheInfo* XmHTMLGetFontCacheInfo (  Widget  w  ) 
 

Returns info about the font cache for display of the given widget.

Returns:
font cache info
Parameters:
w  Widget for which to get font cache info

XMHTMLEXPORT Boolean XmHTMLGetHeadAttributes (  Widget  w,
XmHTMLHeadAttributes *  head,
unsigned char  mask_bits
) 
 

Fills the given HeadAttributes with the requested document.

Returns:
true when a <head></head> block is present, false if not When mask_bits only contains HeadClear, the given attribute structure is wiped clean and this function will return False immediatly. The only exception concerns the <!DOCTYPE> tag and the HeadDocType mask bit: if this bit is set, the value of this tag is returned whether or not a head is present.
Parameters:
w  XmHTMLWidget id
head  structure to fill
mask_bits  indicates what members to fill

XMHTMLEXPORT String XmHTMLGetTitle (  Widget  w  ) 
 

Returns the value of the <title></title> element.

Returns:
value of the title upon success, NULL on failure
Parameters:
w  XmHTMLWidget in question

XMHTMLEXPORT URLType XmHTMLGetURLType (  String  href  ) 
 

Tries to figure out what type of url the given href is.

Returns:
type of url when we know it, ANCHOR_UNKNOWN otherwise
Parameters:
href  url specification

XMHTMLEXPORT int XmHTMLGetVersion (  void   ) 
 

Returns the version number of XmHTML.

Returns:
version number of this library

XMHTMLEXPORT Boolean XmHTMLGIFtoGZF (  String  infile,
unsigned char *  buf,
int  size,
String  outfile
) 
 

Converts a Compuserve gif image to a GZF image.

return True when conversion was successfull. False if something failed.

Parameters:
infile  name of giffile
buf  giffile data
size  size of buffer (if any)
outfile  name of destination file

XMHTMLEXPORT void XmHTMLImageAddImageMap (  Widget  w,
String  image_map
) 
 

Add the given imagemap to an HTML widget.

Returns:
nothing
Parameters:
w  widget
image_map  raw html data containinf the imagemap to parse

XMHTMLEXPORT XmImageInfo* XmHTMLImageDefaultProc (  Widget  w,
String  file,
unsigned char *  buf,
int  size
) 
 

XmHTML default image loading procedure.

Returns:
An XmImageInfo structure on success or NULL on failure
Parameters:
w  Widget ID
file  full name and location of image to load
buf  image data
size  length of buf

XMHTMLEXPORT void XmHTMLImageFreeAllImages (  Widget  w  ) 
 

Releases all allocated images and associated structures.

Returns:
nothing
Parameters:
w  XmHTMLWidget for which to free all images

XMHTMLEXPORT void XmHTMLImageFreeImageInfo (  Widget  w,
XmImageInfo *  info
) 
 

Free the given XmImageInfo structure.

Returns:
nothing
Parameters:
info  image to free

XMHTMLEXPORT int XmHTMLImageGetImageInfoSize (  XmImageInfo *  info  ) 
 

Returns the size of the given XmImageInfo structure.

Returns:
size of the given XmImageInfo structure Note: This function is used both by us and the caching routines
Parameters:
info  ptr to an XmImageInfo structure

XMHTMLEXPORT unsigned char XmHTMLImageGetType (  String  file,
unsigned char *  buf,
int  size
) 
 

Determine the type of a given image.

Returns:
The image type if supported, IMAGE_UNKNOWN otherwise
Parameters:
file  name of image file to check

XMHTMLEXPORT Boolean XmHTMLImageGZFSupported (  void   ) 
 

Check if GZF support is available.

Returns:
True if support is available. False if not.

XMHTMLEXPORT Boolean XmHTMLImageJPEGSupported (  void   ) 
 

Check if JPEG support is available (this is a compile time option).

Returns:
True if support is available. False if not.

XMHTMLEXPORT Boolean XmHTMLImagePNGSupported (  void   ) 
 

Check if PNG support is available.

Returns:
True if support is available. False if not.

XMHTMLEXPORT void XmHTMLImageProgressiveContinue (  Widget  w  ) 
 

Reactivate progressive image loading.

Returns:
nothing

XMHTMLEXPORT void XmHTMLImageProgressiveKill (  Widget  w  ) 
 

Terminate progressive image loading.

Returns:
nothing

XMHTMLEXPORT void XmHTMLImageProgressiveSuspend (  Widget  w  ) 
 

Suspend progressive image loading.

Returns:
nothing

XMHTMLEXPORT XmImageStatus XmHTMLImageReplace (  Widget  w,
XmImageInfo *  image,
XmImageInfo *  new_image
) 
 

Replaces the XmImageInfo structure with a new one.

Returns:
XmIMAGE_ALMOST if replacing this image requires a recomputation of the document layout, XmIMAGE_OK if not and some other value upon error.
Parameters:
w  XmHTMLWidget
image  XmImageInfo structure to be replaced, must be known by XmHTML
new_image  new XmImageInfo structure

XMHTMLEXPORT XmImageStatus XmHTMLImageUpdate (  Widget  w,
XmImageInfo *  image
) 
 

Updates an image.

Returns:
XmIMAGE_ALMOST if updating this image requires a recomputation of the document layout, XmIMAGE_OK if not and some other value upon error.
Parameters:
w  XmHTMLWidget
image  image info representing the image to be updated.

XMHTMLEXPORT void XmHTMLRedisplay (  Widget  w  ) 
 

Forces a layout recomputation of the currently loaded document.

Returns:
nothing Note: this function is mostly usedful in combination with the image updating and/or replacing routines.
Parameters:
w  Widget for which to redo layout computation

XMHTMLEXPORT Boolean XmHTMLTagCheck (  String  attributes,
String  tag
) 
 

Check whether the given tag exists in the attributes of an HTML element.

Returns:
true if tag is found, false otherwise
Parameters:
attributes  attributes from an HTML element
tag  tag to look for

XMHTMLEXPORT int XmHTMLTagCheckNumber (  String  attributes,
String  tag,
int  default_value
) 
 

Retrieves the numerical value of the given tag.

Returns:
if tag exists, the value of this tag, def otherwise If the returned no is negative, the specified value was a relative number. Otherwise it's an absolute number.
Parameters:
attributes  attributes from an HTML element
tag  tag to look for
default_value  default value if tag is not found

XMHTMLEXPORT Boolean XmHTMLTagCheckValue (  String  attributes,
String  tag,
String  check
) 
 

GENERATING_DOXYGEN_OUTPUT.

Returns:
true if tag exists and has the correct value, false otherwise
Parameters:
attributes  attributes from an HTML element
tag  tag to look for
check  value to check

XMHTMLEXPORT int XmHTMLTagGetNumber (  String  attributes,
String  tag,
int  default_value
) 
 

Retrieves the numerical value of the given tag.

Returns:
if tag exists, the value of this tag, def otherwise
Parameters:
attributes  attributes from an HTML element
tag  tag to look for
default_value  default value if tag is not found

XMHTMLEXPORT String XmHTMLTagGetValue (  String  attributes,
String  tag
) 
 

Looks for the specified tag in the given list of attributes.

Returns:
if tag exists, the vaue of this tag, NULL otherwise return value is always malloc'd; caller must free it
Parameters:
attributes  attributes from an HTML element
tag  tag to look for

XMHTMLEXPORT void XmHTMLTextClearSelection (  Widget  w,
Time  time
) 
 

Clears the selection.

Returns:
nothing (UNIMPLEMENTED)
Parameters:
w  XmHTMLWidget id

XMHTMLEXPORT Boolean XmHTMLTextCopy (  Widget  w,
Time  time
) 
 

Copies text.

Returns:
false (UNIMPLEMENTED, always returns false)
Parameters:
w  XmHTMLWidget id

XMHTMLEXPORT XmHTMLTextFinder XmHTMLTextFinderCreate (  Widget  w  ) 
 

Create a new Finder Context suitable for searching the contents of an HTML Widget.

Returns:
a new Finder context
Parameters:
w  XmHTMLWidget id

XMHTMLEXPORT void XmHTMLTextFinderDestroy (  XmHTMLTextFinder  finder  ) 
 

Destroys a finder context and frees any resources allocated.

Returns:
nothing
Parameters:
finder  finder to be destroyed

XMHTMLEXPORT int XmHTMLTextFinderGetError (  XmHTMLTextFinder  finder  ) 
 

Returns error code of the last known regex error.

Returns:
error code of last known regex error
Parameters:
finder  current Finder Context

XMHTMLEXPORT String XmHTMLTextFinderGetErrorString (  XmHTMLTextFinder  finder  ) 
 

Returns a description of the last known regex error.

Returns:
a newly allocated string that must be freed by the caller
Parameters:
finder  current Finder Context

XMHTMLEXPORT void XmHTMLTextFinderReset (  XmHTMLTextFinder  finder  ) 
 

Rewinds the finder to it's starting position and clears the pattern buffer.

Returns:
nothing
Parameters:
finder  finder to be reset

XMHTMLEXPORT Boolean XmHTMLTextFinderSetPattern (  XmHTMLTextFinder  finder,
String  to_find
) 
 

Sets the search pattern in a finder.

Returns:
true when pattern was successfully set, false if not
Parameters:
finder  finder to be updated
to_find  test to be searched

XMHTMLEXPORT Boolean XmHTMLTextFinderSetPatternFlags (  XmHTMLTextFinder  finder,
int  flags,
Boolean  ignore_case,
XmHTMLDirection  direction
) 
 

Allows users to fine-tune the pattern-compiler by providing their own regcomp flags.

Returns:
true when flags have been successfully changed, false if not Note: Validity checking of the provided flags is rather impossible, so the caller better be sure that the flags are correct or regcomp will fail miserably.
Parameters:
finder  current Finder Context
flags  regcomp flags to be used
ignore_case  if true, case is ignored when searching
direction  search direction

XMHTMLEXPORT XmHTMLRegexStatus XmHTMLTextFindString (  Widget  w,
XmHTMLTextFinder  finder
) 
 

Find the first appearance of the compiled pattern in the current text.

Returns:
XmREG_MATCH if a match was found, XmREG_NOMATCH if no match was found and XmREG_ERROR on error
Parameters:
w  XmHTMLWidget id
finder  current finder id

XMHTMLEXPORT Boolean XmHTMLTextFindToPosition (  Widget  w,
XmHTMLTextFinder  finder,
XmHTMLTextPosition *  start,
XmHTMLTextPosition *  end
) 
 

Determines if there is a matching word in the specified range.

Returns:
true if a matching word is found, false if not
Parameters:
w  XmHTMLWidget id
finder  current finder id
start  starting position
end  ending position

XMHTMLEXPORT String XmHTMLTextGetFormatted (  Widget  w,
unsigned char  papertype,
XmHTMLPaperSize *  paperdef,
unsigned char  type,
unsigned char  PSoptions
) 
 

Returns a formatted copy of the current document.

Returns:
a string which needs to be freed by the caller
Parameters:
w  XmHTMLWidget id
papertype  type of paper to use (any of the XmHTMLTEXT_PAPERSIZE enums)
paperdef  size of paper for custom stuff, or default overrides
type  type of output wanted, plain, formatted or PS
PSoptions  options to use when creating postscript output

XMHTMLEXPORT String XmHTMLTextGetSelection (  Widget  w  ) 
 

Returns a copy of the current document.

Returns:
NULL (UNIMPLEMENTED, always returns NULL)
Parameters:
w  XmHTMLWidget id

XMHTMLEXPORT String XmHTMLTextGetSource (  Widget  w  ) 
 

Returns a copy of the original, unmodified document.

Returns:
a *pointer* to the original text, or NULL when w isn't a subclass of XmHTML ot there wasn't a current document
Parameters:
w  XmHTMLWidget in question

XMHTMLEXPORT String XmHTMLTextGetString (  Widget  w  ) 
 

Composes a text buffer consisting of the parser output.

Returns:
an allocated buffer containing the composed text upon success, NULL on failure this return buffer is not necessarily equal to the original document as the document verification and repair routines are capable of modifying the original rather heavily
The return value from this function must be freed by the caller. Typical use of this function is to set this buffer into the widget when the parser failed to verify the document as it might well be that a next parser pass on the original document does produce an HTML3.2 conforming and verified document.
Parameters:
w  XmHTMLWidget in question

XMHTMLEXPORT void XmHTMLTextScrollToLine (  Widget  w,
int  line
) 
 

Scrolls the widget to the given line number.

Returns:
nothing
Parameters:
w  widget to scroll
line  line number to scroll to

XMHTMLEXPORT void XmHTMLTextSetHighlight (  Widget  w,
XmHTMLTextPosition  first,
XmHTMLTextPosition  last,
XmHighlightMode  mode
) 
 

Sets the highlight between the specified positions.

Returns:
nothing
Parameters:
w  XmHTMLWidget id
first  first text position
last  last text position

XMHTMLEXPORT Boolean XmHTMLTextSetSelection (  Widget  w,
XmHTMLTextPosition  first,
XmHTMLTextPosition  last,
Time  time
) 
 

Sets the selection between the specified positions.

Returns:
false (UNIMPLEMENTED, always returns false)
Parameters:
w  XmHTMLWidget id
first  first text position
last  last text position

XMHTMLEXPORT void XmHTMLTextSetString (  Widget  w,
String  text
) 
 

Sets the given text into the given HTML widget.

Returns:
nothing clears any previous text and sets the new text
Parameters:
w  XmHTMLWidget in question
text  text to set

XMHTMLEXPORT void XmHTMLTextSetStringWithLength (  Widget  w,
String  text,
size_t  len
) 
 

Sets the given text into the given HTML widget.

Returns:
nothing depending on current loading type, loads an entire document, continue where we left off, append new text and then continue, suspend or abort document load.
same as XmHTMLTextSetString with one fundamental difference: text doesn't have to be NULL terminated. The size of the input string is instead given by len. If text is NULL or len is 0, the current contents are cleared.
Parameters:
w  XmHTMLWidget in question
text  text to set, doesn't have to be NULL terminated
len  size of input string.

XMHTMLEXPORT Boolean XmHTMLTextShowPosition (  Widget  w,
XmHTMLTextPosition  position
) 
 

Displays the position.

Returns:
false (UNIMPLEMENTED, always returns false)
Parameters:
w  XmHTMLWidget id
position  text position

XMHTMLEXPORT XmHTMLInfoStructure* XmHTMLXYToInfo (  Widget  w,
int  x,
int  y
) 
 

Retrives the contents of an image and/or anchor ath the given cursor position.

Returns:
a filled XmHTMLInfoStructure when the pointer whas pressed on an image and/or anchor, NULL if not Note: The return value, nor one of its members may be free by the caller.
Parameters:
w  XmHTMLWidget id
x  x-location of pointer, relative to left side of workArea
y  y-location of pointer, relative to top side of workArea

XMHTMLEXPORT XmImage* XmImageCreate (  Widget  w,
String  file,
Dimension  width,
Dimension  height,
XmImageConfig *  config
) 
 

Creates and fills an image structure without bothering XmHTML.

Returns:
a newly created image, all fields filled. Create and return a XmImage for use other than with XmHTML. When width and height are non-zero, the image read is scaled to the specified dimensions.
Parameters:
w  widget id
file  image filename
width  requested image width
height  requested image height
config  XmImage configuration

XMHTMLEXPORT XmImage* XmImageCreateFromInfo (  Widget  w,
XmImageInfo *  info,
Dimension  width,
Dimension  height,
XmImageConfig *  config
) 
 

Creates and fills and image structure without bothering XmHTML.

Returns:
a newly created image, all fields filled Create an XmImage from the given XmImageInfo. When the image type is IMAGE_UNKNOWN, but the url field represents a local file, this routine calls XmImageCreate with the url field as the file argument. Only honors the ImageFrameSelect, ImageCreateGC and ImageBackground XmImageConfig flag and appropriate fields of that structure.
Parameters:
w  widget id
info  XmImageInfo structure
width  requested image width
height  requested image height
config  XmImage configuration

XMHTMLEXPORT void XmImageDestroy (  XmImage *  image