mi32/xmhtml.h

Go to the documentation of this file.

/*****
* mi32/xmhtml.h : XmHTML Widget public header file
*
* This file Version  $Revision: 1.18 $
*
* Creation date:     Tue Nov 19 23:18:37 GMT+0100 1996
* Last modification:    $Date: 2006/04/12 14:51:05 $
* By:             $Author: dwilliss $
* Current State:     $State: Exp $
*
* Author:            newt
* (C)Copyright 1995-1996 Ripley Software Development
* All Rights Reserved
*
* This file is part of the XmHTML Widget Library.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
*****/

#ifndef INC_MI32_XMHTML_H
#define INC_MI32_XMHTML_H

/*****
* $Source: \\\\fileserver\\fileserver\\src\\tnt72\\incmi32\\xmhtml.h_v $
*****/
/*****
* ChangeLog 
* $Log: xmhtml.h_v $
* Revision 1.18  2006/04/12 14:51:05  dwilliss
* use win32 instead of winnt
*
* Revision 1.17  2005/03/31 16:57:22  fileserver!dwilliss
* Rename one of our types to MIUNICODE because it conflicted with a Microsoft #define
*
* Revision 1.16  2003/09/15 13:49:56  fileserver!dwilliss
* Doxygen
*
* Revision 1.15  2001/05/09 21:30:03  dwilliss
* oops.  typo
*
* Revision 1.14  2001/05/09 21:17:31  dwilliss
* Fix extern problem on Mac OS X
*
* Revision 1.13  2001/05/09 16:57:27  common
* try again
*
* Revision 1.12  2001/05/09 16:55:21  common
* fix for Mac OS X
*
* Revision 1.11  2000/08/16 17:37:24  msmith
* header documentation
*
* Revision 1.10  1999/03/24 17:55:41  dwilliss
* *** empty log message ***
*
* Revision 1.9  1999/02/18 21:04:42  dwilliss
* *** empty log message ***
*
* Revision 1.8  1999/02/18 20:56:42  dwilliss
* Need to export stuff on the Mac too, not just Windows
*
* Revision 1.7  1998/12/31 16:45:12  dwilliss
* Checking if CHAR is already typedef'd does no good if we never
* define the thing we're ifdef'ing
*
* Revision 1.6  1998/10/09 19:45:50  dwilliss
* added a protottype for a hack
*
 * Revision 1.5  1998/09/16  17:09:44  coffee!dwilliss
 * *** empty log message ***
 *
 * Revision 1.4  1998/09/16  17:05:33  coffee!dwilliss
 * .]
 *
 * Revision 1.3  1998/09/16  16:48:35  coffee!dwilliss
 * Update to 1.1.5
 *
* Revision 1.21  1998/04/27 06:56:31  newt
* Updated version number
*
* Revision 1.20  1998/04/04 06:27:53  newt
* XmHTML Beta 1.1.3
*
* Revision 1.19  1997/10/26 23:49:52  newt
* Moved internal symbol defines to XmHTMLP.h
*
* Revision 1.18  1997/10/23 00:24:44  newt
* XmHTML Beta 1.1.0 release
*
* Revision 1.17  1997/08/31 17:32:43  newt
* log edit
*
* Revision 1.16  1997/08/30 00:40:16  newt
* Changed proto's for XmHTMLImageReplace and XmHTMLImageUpdate. They now
* return an XmImageStatus instead of void.
*
* Revision 1.15  1997/08/01 12:54:55  newt
* Progressive image loading changes.
*
* Revision 1.14  1997/05/28 01:41:04  newt
* Added the XmHTMLImageGZFSupported, XmHTMLGIFtoGZF, XmHTMLGifReadOK and
* XmHTMLGifGetDataBlock convienience routines to convert GIF images to an
* alternate format. Added the XmHTMLAllocColor and XmHTMLFreeColor protos for
* easy color allocation. Modified the XmImageCreate routines to use a
* XmImageConfig structure.
*
* Revision 1.13  1997/04/29 14:22:35  newt
* Completely revised due to XmHTMLParserObject integration
*
* Revision 1.12  1997/04/03 05:31:30  newt
* XmHTMLFrameGetChild proto. XmIMAGE_SHARED_DATA option bit added.
*
* Revision 1.11  1997/03/28 07:06:14  newt
* XmNframeCallback, XmHTMLFrameCallbackStruct. XmHTMLParserCallback changes.
*
* Revision 1.10  1997/03/20 08:05:02  newt
* XmHTMLImageFreeImageInfo, XmNrepeatDelay
*
* Revision 1.9  1997/03/11 19:50:27  newt
* Changes in XmImageInfo; grouped and renamed convenience functions
*
* Revision 1.8  1997/03/04 18:45:55  newt
* XmNimagemapBoundingBoxForeground and XmCImagemapDrawBoundingBoxes 
* resources added
*
* Revision 1.7  1997/03/04 00:56:30  newt
* Delayed Image Loading: added the delayed field to the XmImageInfo structure. 
* Removed a number of obsolete defines
*
* Revision 1.6  1997/03/02 23:07:10  newt
* Image/Imagemap related changes. XmHTMLAnchorCallbackStruct changed
*
* Revision 1.5  1997/02/11 02:01:26  newt
* Added the XmNhandleShortTags resource
*
* Revision 1.4  1997/02/04 02:55:57  newt
* added the basefont element
*
* Revision 1.3  1997/01/09 06:55:53  newt
* expanded copyright marker
*
* Revision 1.2  1997/01/09 06:47:58  newt
* New resource: XmNparserCallback and corresponding error structure/defines
*
* Revision 1.1  1996/12/19 02:17:14  newt
* Initial Revision
*
*****/ 
/*****
* Public interfaces are listed at the end of this file
*****/

#ifndef _XmHTML_h_
#define _XmHTML_h_

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

/* used by Imake to get Shared library version numbering */
#ifndef _LIBRARY

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

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


#if defined(WIN32) || defined(USEDLLS)
#ifdef XMHTML_DLL
#if !defined(MAC_OSX)
#define XMHTMLEXPORT __declspec(dllexport)
#endif   
#else

#if defined(MAC_OSX)
#define XMHTMLEXPORT extern
#else
#define XMHTMLEXPORT extern __declspec(dllimport)
#endif   
#endif   
#else
#define XMHTMLEXPORT extern
#endif

#ifndef XMHTMLEXPORT
#define XMHTMLEXPORT
#endif


#ifndef CHAR_ALREADY_TYPEDEFED
#define CHAR_ALREADY_TYPEDEFED
#ifdef CHAR
#undef CHAR
#endif
#ifdef MIUNICODE
typedef unsigned short CHAR;
#else
typedef unsigned char CHAR;
#endif 
#endif 

_XFUNCPROTOBEGIN     

#ifdef __cplusplus
extern "C" {
#endif

/* XmHTML type defines */
typedef struct _XmHTMLClassRec *XmHTMLWidgetClass;
typedef struct _XmHTMLRec *XmHTMLWidget;

/*****
* VMS works differently here: it defines externalref to globalref,
* so guard against incorrectly overriding the externaldef define.
*****/
#ifdef VMS
externalref WidgetClass xmHTMLWidgetClass;
#else
XMHTMLEXPORT WidgetClass xmHTMLWidgetClass;
#endif

/* XmHTML Widget subclassing macro */
#ifndef XmIsHTML
#define XmIsHTML(w)  XtIsSubclass(w, xmHTMLWidgetClass)
#endif 

/********    Public Function Declarations    ********/

/*****
* Convenience/public functions
* There are six categories:
* - image related
* - anchor related
* - text related
* - tag analyzers
* - object related
* - functions that don't fit in any of the above three
*****/

/*****
* Image related convenience 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
   );

/*****
* Special image functions
*****/

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                     
   );

/*****
* Text related convenience functions
*****/

/* This macro sets the given text into a HTML widget */
#define XmHTMLTextSet (WIDGET,TEXT) XtVaSetValues((WIDGET), \
      XmNvalue, (TEXT), NULL)

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             
   );

/*****
* Tag analyzers.
* These routines allow you to filter values out of the attributes 
* attached to a HTML element.
*****/

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                        
   );

#ifndef GENERATING_DOXYGEN_OUTPUT

/*****
* Object related convenience functions.
* These functions allow one to define custom HTML elements to XmHTML.
*****/

/* define a new element to the HTML parser */
XMHTMLEXPORT XmHTMLElementId XmHTMLObjectDefine (
   String element,
   Boolean terminated,
   unsigned long attribute_flags,
   XtPointer user_data
   );

/* undefine a previously defined element */
XMHTMLEXPORT XmHTMLObjectStatus XmHTMLObjectUndefine (
   XmHTMLElementId element_id
   );

/* reconfigure the given object (change position and/or size) */
XMHTMLEXPORT XmHTMLObjectStatus XmHTMLObjectReconfigure (
   Widget w,
   XmHTMLObjectId object_id,
   int x,
   int y,
   Dimension width, 
   Dimension height
   );

/* show/hide the given object */
XMHTMLEXPORT XmHTMLObjectStatus XmHTMLObjectShow (
   Widget w,
   XmHTMLObjectId object_id,
   Boolean show
   );

/* raise the given object from the currently displayed document */
XMHTMLEXPORT XmHTMLObjectStatus XmHTMLObjectRaise (
   Widget w,
   XmHTMLObjectId object_id
   );

/* lower the given object into the currently displayed document */
XMHTMLEXPORT XmHTMLObjectStatus XmHTMLObjectLower (
   Widget w,
   XmHTMLObjectId object_id
   );

/* Create an external object corresponding to a previously defined element */
XMHTMLEXPORT XmHTMLObjectId XmHTMLObjectCreate (
   XmHTMLElementId element_id
   );

/* Destroy an external object */
XMHTMLEXPORT void XmHTMLObjectDestroy (
   XmHTMLObjectId object_id
   );

/* register an external object for use with XmHTML */
XMHTMLEXPORT XmHTMLObjectStatus XmHTMLObjectRegister (
   Widget w,
   XmHTMLObjectId object_id
   );

/* unregister a previously registered object from XmHTML */
XMHTMLEXPORT XmHTMLObjectStatus XmHTMLObjectUnregister (
   Widget w,
   XmHTMLObjectId object_id
   );

/* fetch the element data from the given object */
XMHTMLEXPORT XmHTMLElementId XmHTMLObjectGetElement (
   Widget w,
   XmHTMLObjectId object_id
   );

#endif 

/*****
* Miscelleneous convenience functions
*****/

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*
   );

#ifdef __cplusplus
}
#endif

_XFUNCPROTOEND

#endif 

/* Don't add anything after this endif! */
#endif 

#endif  // INC_MI32_XMHTML_H

---