Zm.h

/* Zm.h */
/* $Revision: 1.22 $    Zm.h    $Date: 2009/08/17 10:26:30 $ */
#ifndef __Zm_h
#define __Zm_h

#include <time.h>

#include <X11/cursorfont.h>
#include <X11/Intrinsic.h>
#include <Xm/Xm.h>
#include <Xm/TextF.h>

#include <mix/Types.h>


#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */

/***********************************************************************
 *  Macro for quick definition of a callback
 ***********************************************************************/
#define ZmDefineCB(NameCB)  void    NameCB (Widget w, \
                        XtPointer pUserData, \
                        XtPointer pCallData)

/*************************************************************
 * Application specific and commonly used dialogs.
 *************************************************************/

/* Status of dialog completition */
typedef enum
{
  ZmNONE,       /* no actions has been done */
  ZmOK_PRESSED,     /* default OK action has been done */
  ZmCANCEL_PRESSED, /* default CANCEL action has benn done */
  ZmEMPTY       /* insufficient data */

}   ZmDialogCompletition;


/*************************************************************
 * Process some events by XToolkit and Motif.
 *************************************************************/

#define ZM_EVENTS_NUMBER    15

void    ZmProcessEvents (Widget w, int nEvents);


/*************************************************************
 * Changing button states: Arm/Disarm, Sensitive/Insensitive.
 *************************************************************/
void    ChangeArmState (Widget w);
void    SetSensitivity (Widget w, Logic flag);


/***********************************************************************
 * The function composes the list of top level windows resides on
 * given display.  Returns number of windows and list of them in
 * *tlist, which must be free() after usage.
 ***********************************************************************/
unsigned    XListToplevelWindows (Display* dpy, Window root,
                      Window** tlist);


/***********************************************************************
 * The function checks for given window id existance.  Only toplevel
 * windows are can be checked in this manner.  "Toplevel" means
 * WM-managed.
 ***********************************************************************/
Logic       XCheckToplevelWindow (Display* dpy, Window wid);


/*************************************************************
 * Format to XmString directly.
 *************************************************************/

#define XMPRINTF_BUFSIZE    1024

XmString    xmprintf (const char* format, ...);


/***********************************************************************
 * Find the toplevel from the given widget.
 ***********************************************************************/
Widget      ZmToplevel (Widget w);

/*************************************************************
 * Print to stdout reverse path to given widget just for debug
 *************************************************************/
void    ZmFullWidgetName (Widget w);

/*************************************************************
 * Set bitmap as an icon for label and button.
 *************************************************************/
void    ZmAssignIconFromBitmapData (Widget w, char* data,
                    int width, int height);

/* Structure for inlined bitmaps representation */
typedef struct {
  char  *data;
  int   width;
  int   height;
}   ZmBitmapSource;

#define ZmInlineXBM(root)   root##_bits,root##_width,root##_height

#define ZmAssignIconFromBitmap(w,root)  \
    ZmAssignIconFromBitmapData(w,root##_bits,root##_width,root##_height)

/*************************************************************
 * XmTextField utilities
 *************************************************************/

/* Compose entered value with old one in XmTextField. 
   Return temporary allocated buffer. */
char*   ZmTextFieldNewValue (const XmTextVerifyPtr verify,
                 const char* prevValue);

typedef enum
{
  ZmTEXT_ACCEPT,    /* good text contents */
  ZmTEXT_REJECT,    /* bad text contents */
  ZmTEXT_BAD_REASON,    /* can't handle given reason */
  ZmTEXT_BAD_CALL   /* calling error */

}   ZmTextVerified;

/* Verify entered characters for validity as a seismic
   modification name */
ZmTextVerified  ZmVerifyModText (Widget wTextField,
                 XmTextVerifyPtr verify);


/*************************************************************
 * Cursor API
 * X cursors: XC_watch
 *************************************************************/

/* Set cursor in given window. */
void    ZmSetCursor (Display* dpy, Window wid, unsigned int xcursor);

/* Set cursor in given widget. */
void    ZmSetCursorInWidget (Widget w, unsigned int xcursor);

/* Reset cursor in given window. */
void    ZmResetCursor (Display* dpy, Window wid);

/* Reset cursor in given widget. */
void    ZmResetCursorInWidget (Widget w);

/* Free all cursors. */
void    ZmFreeAllCursors (Display* dpy);


/*************************************************************
 * Save image to raster file.
 *************************************************************/

typedef struct
{
  char  *szPictureName; 
  char  *szDescription; 
  char  *szDateTime;    
}   ZmImageRemarks;


ErrCode ZmWriteImageToTIFF (const char* path,
                Display* dpy, Drawable did, XRectangle* area,
                ZmImageRemarks* remarks);

ErrCode ZmWriteImageToPNG (const char* path,
               Display* dpy, Drawable did, XRectangle* area,
               ZmImageRemarks* remarks);

void    ZmSaveImage (Widget wParent, Drawable did, XRectangle* area,
             const char* szDescription);


/*************************************************************
 * Operations over drawables.
 *************************************************************/

Pixmap  ZmCreateAndCopyPixmap (Display* dpy, Drawable src);

void    ZmFillDrawable (Display* dpy, Drawable dst, const char* color);

void    ZmCopyDrawable (Display* dpy, Drawable dst, Drawable src);


/*************************************************************
 * Progress indicator API
 * (implemented as a wrapper over ZmProgress).
 *************************************************************/

typedef void*   ProgressStruct;

typedef enum
  {
    PROGRESS_RUNNING = 0,   
    PROGRESS_COMPLETED,     
    PROGRESS_BREAK,     
    PROGRESS_ERROR      
  } ProgressState;

typedef float   ZmPrMeter;

ProgressState   ZmCreateProgressIndicator (ProgressStruct* ps,
                       Widget wParent, /*Logic modalness,*/
                       double begin_v, double end_v);

void    ZmDestroyProgressIndicator (ProgressStruct* ps);

ProgressState   ZmProgressStep (ProgressStruct* ps, double step_v);

void    ZmProgressMsg (ProgressStruct* ps, const char* fmt, ...);

void    Fortran(prgindstep)(float* step_v, int* state);


#ifdef __DefaultProgressIndicator
/* real definition */
#define ZmEXTERN_VAR
#else /* __DefaultProgressIndicator */
/* declaration */
#define ZmEXTERN_VAR    extern
#endif /* __DefaultProgressIndicator */

ZmEXTERN_VAR ProgressStruct psDefaultProgress;

#undef ZmEXTERN_VAR


#ifdef __cplusplus
};
#endif /* __cplusplus */

#endif /* Zm.h */