mi32/xewbasic.h

Go to the documentation of this file.

/***
** Copyright 1992, 1993, 1994 by Markku Savela and
** Technical Research Centre of Finland
 *
 * \if NODOC
 * $Log: xewbasic.h_v $
 * Revision 1.7  2011/11/08 13:33:04  mju
 * Remove legacy inclusion test.
 *
 * Revision 1.6  2003/09/15 13:49:56  fileserver!dwilliss
 * Doxygen
 *
 * \endif
*/

#ifndef INC_MI32_XEWBASIC_H
#define INC_MI32_XEWBASIC_H

#include <X11/Xlib.h>
#include <X11/Intrinsic.h>
#include <X11/StringDefs.h>
#include <X11/Xmu/Converters.h>


#ifndef _XFUNCPROTOBEGIN
#  define _XFUNCPROTOBEGIN
#  define _XFUNCPROTOEND
#endif

/* Parameters:

 Name         Class     RepType     Default Value
 ----         -----     -------     -------------
 background      Background      Pixel    XtDefaultBackground
 border          BorderColor  Pixel    XtDefaultForeground
 borderWidth        BorderWidth  Dimension   1
 colormapUse         ColormapUse        XeColormapUse   XeColormapUse_SHARED
 colormapInstall     ColormapInstall    Boolean         False
 colorMode           ColorMode          XeColorMode     XeColorMode_COLOR
 contentFile         ContentFile        String          NULL
 contentFilter       ContentFilter      String          NULL
 contentFormat       ContentFormat      XeContentFormat XeContentFormat_UNKNOWN
 contentLoaded       ContentLoaded      Boolean         False
 contentLength       ContentLength      int            0
 contentOffset       ContentOffset      int            0
 contentStream       ContentStream      FILE *          NULL
 contentString       ContentString      Pointer         NULL
 destroyCallback     Callback    Pointer     NULL
 exposeCallback      ExposeCallback     Pointer         NULL
 exportCallback      ExportCallback     Pointer         NULL
 cursor              Cursor             Cursor          None
 foreground      Foreground      Pixel    XtDefaultForeground
 height               Height     Dimension   0
 importCallback      importCallback     Pointer         NULL
 mappedWhenManaged   MappedWhenManaged Boolean     True
 maxColors           MaxColors          int             MAXINT
 mirrorImage         MirrorImage        Boolean         False
 notifyCallback      NotifyCallback     Pointer         NULL
 resize              Resize             Boolean         True
 scaling             Scaling            XeScaling       XeScaling_WIDTH
 rotation            Rotation           int             0
 useShm              UseShm             Boolean         False
 visual              Visual             Visual *        NULL
 width           Width     Dimension   0
 x         Position     Position 0
 y         Position     Position 0
*/

typedef enum {
   XeContentFormat_UNKNOWN,
   XeContentFormat_ISO2022,
   XeContentFormat_TIFF,   
   XeContentFormat_JPEG,   
   XeContentFormat_GIF, 
   XeContentFormat_CGM, 
   XeContentFormat_H261,   
   XeContentFormat_AUDIO,  
   XeContentFormat_ODIF,   
   XeContentFormat_MPEG,   
   /* Start of addition made by barberjd (Jim Barber) 15th March 1994 */
   XeContentFormat_RLE, 
   /* End of addition made by barberjd */
   XeContentFormat_PBM  
    } XeContentFormat;

typedef enum {
   XeScaling_NONE,      
   XeScaling_WIDTH,  
   XeScaling_HEIGHT, 
   XeScaling_MAXASPECT, 
   XeScaling_FITAREA 
   } XeScaling;

typedef enum {
   XeColormapUse_SHARED,
   XeColormapUse_SHAREDOWN,
   XeColormapUse_OPTIONAL,
   XeColormapUse_PRIVATE
   } XeColormapUse;

typedef enum
    {
   XeColorMode_NONE, 
   XeColorMode_MONO, 
   XeColorMode_GRAY, 
   XeColorMode_COLOR 
    } XeColorMode;

/*
** XeDither
** is not really a Basic resource, but is used by at least
** Raster and Video, and thus needs to be defined for both
** of them.
**
** Specify whether dithering algorithm is to be used.
*/
typedef enum {
   XeDither_NONE,    
   XeDither_FS4      
   } XeDither;

/*
** XeColorQuantize
** is not really a Basic resource, but is used by at least
** Raster and Video, and thus needs to be defined for both
** of them.
**
** Specify how 24bit colors are to be presented on pseudocolor
** displays.
*/
typedef enum {
   XeColorQuantize_FAST,   
   XeColorQuantize_HECKBERT,
   XeColorQuantize_PPMQUANT,
   XeColorQuantize_JPEG 
   } XeColorQuantize;

/*
** Known callback reasons in Xe widgets
*/
typedef enum {
   XeCR_UNKNOWN,     
   XeCR_NOTIFY,      
   XeCR_NOTIFY_AREA, 
   XeCR_EXPOSE,      
   XeCR_MODIFY_TEXT, 
   XeCR_LAYOUT_CHANGE_TAG, 
   XeCR_LAYOUT_BEGIN_LINE, 
   XeCR_ANIMATION_DONE, 
   XeCR_ANIMATION_FRAME,   
   XeCR_EXPORT,      
   XeCR_IMPORT    
   } XeCR;

/*
** XeCallData
** is the general structure that is passed to all Xew callbacks in
** Xew. Individual widget classes may have further extra fields and
** have an alternate definition for the structure and different
** callbacks, but the beginning always matches this structure.
**
** NOTE: The callback reason codes will be globally unique across
**    all Xe widgets (the reason code alone can be used to decide
**    about the actual structure that applies to call_data,
**    regardless of the source widget of the callback).
*/
typedef struct XeCallbackData {
   int reason;    
   } XeCallbackData;

/*
** XeNotifyCallData
** is the universal default data for the notify callback.
*/
typedef struct XeNotifyCallbackData {
   int reason;    
   XEvent *event;    
   String *params;      
   Cardinal num_params; 
   } XeNotifyCallbackData;

/*
** XeNotifyAreaCallbackData
** is the data supplied for the XeCR_NOTIFY_AREA callback. This
** callback is made via general XtNnotifyCallback. The widget uses
** this callback when it detects that the area of interest shifts
** outside the current parent window pounds (like moving the cursor
** out of displayed area in Text Widget). This information can be
** used to control vieports, portholes and similar constructs.
*/
typedef struct XeNotifyAreaCallbackData {
   int reason;    
   XRectangle area;  
   XRectangle visible;  
   } XeNotifyAreaCallbackData;

/*
** XeExposeCallbackData
** is the data supplied for the XeCR_EXPOSE callback. This callback
** is made via XtNexposeCallback after all of the widgets own
** expose processing has been completed.
*/
typedef struct XeExposeCallbackData {
   int reason;    
   XExposeEvent *event; 
   Region region;    
   } XeExposeCallbackData;

/*
** XeExportCallbackData
** is the data supplied for the XeCR_EXPORT callback. This callback
** is made from the widget ConvertSelection method (see description
** of XtConvertSelectionProc for the semantics of selection, target,
** type, value, length and format fields). Upon return from the
** callback the return fields are copied to the corresponding
** parameters of the XtConvertSelectionProc.
*/
typedef struct XeExportCallbackData {
   int reason;    
   Time time;     
   Atom selection;      
   Atom target;      
   Atom type;     
   XtPointer value;  
   unsigned int length; 
   int format;    
   } XeExportCallbackData;

/*
** XeImportCallbackData
** is the data supplied for the XeCR_IMPORT callback. This callback
** is made from the widget SelectionReceived method (see description
** of XtSelectionCallbackProc for the semantics of selection, type
** value, length and format fields).
*/
typedef struct XeImportCallbackData {
   int reason;    
   Atom selection;      
   Atom type;     
   XtPointer value;  
   unsigned int length; 
   int format;    
   } XeImportCallbackData;

/* New fields */
#define XtNcolormapUse "colormapUse"
#define XtCColormapUse "ColormapUse"
#define XtRXeColormapUse "XeColormapUse"
#define XtNcolormapInstall "colormapInstall"
#define XtCColormapInstall "ColormapInstall"
#define XtNcolorMode "colorMode"
#define XtCColorMode "ColorMode"
#define XtRXeColorMode "XeColorMode"
#define XtNcolorQuantize "colorQuantize"
#define XtCColorQuantize "ColorQuantize"
#define XtRXeColorQuantize "XeColorQuantize"
#define XtNcursor "cursor"
#define XtNcontentFile "contentFile"
#define XtCContentFile "ContentFile"
#define XtNcontentFilter "contentFilter"
#define XtCContentFilter "ContentFilter"
#define XtNcontentFormat "contentFormat"
#define XtCContentFormat "ContentFormat"
#define XtRXeContentFormat "XeContentFormat"
#define XtNcontentLoaded "contentLoaded"
#define XtCContentLoaded "ContentLoaded"
#define XtNcontentStream "contentStream"
#define XtCContentStream "ContentStream"
#define XtNcontentString "contentString"
#define XtCContentString "contentString"
#define XtNcontentLength "contentLength"
#define XtCContentLength "ContentLength"
#define XtNcontentOffset "contentOffset"
#define XtCContentOffset "ContentOffset"
#define XtNdither "dither"
#define XtCDither "Dither"
#define XtRXeDither "XeDither"
#define XtNexposeCallback "exposeCallback"
#define XtCExposeCallback "ExposeCallback"
#define XtNexportCallback "exportCallback"
#define XtCExportCallback "ExportCallback"
#define XtNimportCallback "importCallback"
#define XtCImportCallback "ImportCallback"
#define XtNmaxColors "maxColors"
#define XtCMaxColors "MaxColors"
#define XtNmirrorImage "mirrorImage"
#define XtCMirrorImage "MirrorImage"
#define XtNnotifyCallback "notifyCallback"
#define XtCNotifyCallback "NotifyCallback"
#define XtNrotation "rotation"
#define XtCRotation "Rotation"
#define XtNscaling "scaling"
#define XtCScaling "scaling"
#define XtRXeScaling "XeScaling"
#define XtRHorizontalValue "HorizontalValue"
#define XtRVerticalValue "VerticalValue"
#define XtNuseShm "useShm"
#define XtCUseShm "UseShm"
#ifndef XtNvisual
#define XtNvisual "visual"
#endif
#ifndef XtCVisual
#define XtCVisual "Visual"
#endif

/* Class record constants */

extern WidgetClass xeBasicWidgetClass;

typedef struct _XeBasicClassRec *XeBasicWidgetClass;
typedef struct _XeBasicRec      *XeBasicWidget;



#endif  // INC_MI32_XEWBASIC_H

---