(* 
 * Title:   dboxquery.h
 * Purpose: display a dialogue box to ask a question, and get reply.
 *
 *)

#ifndef __dboxquery_h
#define __dboxquery_h

(* ----------------------------- dboxquery --------------------------------
 * Description:   Displays a dialogue box, with YES and NO buttons, and a 
 *                question, and gets reply.
 *
 * Parameters:    char *question -- the question to be asked
 * Returns:       reply by user.
 * Other Info:    Question can be up to 120 chars long, 3 lines of 40 chars
 *                RETURN will reply "yes"; ESCAPE or CLOSE event will
 *                reply "cancel". Note: a call of dbox_query(0), will
 *                reserve space for the dbox and return with no display
 *                This will mean that space is always available for
 *                important things like asking to quit!!
 *                The template for the dialogue box should have the following
 *                attributes:
 *                   window flags -- moveable, auto-redraw
 *                                   Also advisable to have a title icon
 *                                   containing the name of your program
 *                                   (or other suitable text)
 *                   icon #1 -- the message icon -- should have indirected
 *                                                  text flag set, with
 *                                                  buton type "never"
 *                   icon #0 -- the "YES" icon --   should be text icon
 *                                                  with text string set to
 *                                                  "YES"; button type should
 *                                                  be "menu icon"
 *                   icon #2 -- the "NO" icon  --   should be text icon
 *                                                  with text string set to
 *                                                  "NO"; button type should
 *                                                  be "menu icon"
 *
 *                See "query" dialogue box in !Edit for an example.
 *
 *)  
  

(* return type for dboxquery *)

const dboxquery_YES    = 1;
      dboxquery_NO     = 2;
      dboxquery_CANCEL = 3;

type dboxquery_REPLY_ptr = ^dboxquery_REPLY;
     dboxquery_REPLY = integer;

function dboxquery(question : string) : dboxquery_REPLY; extern;

#endif

(* end dboxquery.h *)
