home *** CD-ROM | disk | FTP | other *** search
/ RISC DISC 1 / RISC_DISC_1.iso / pd_share / code / pascal / !Pascal / h / saveas < prev    next >
Encoding:
Text File  |  1992-02-09  |  3.1 KB  |  76 lines
  1. (* Title:   saveas.h
  2.  * Purpose: export of data by dragging icon from dialogue box
  3.  *
  4.  *)
  5.  
  6. #ifndef __saveas_h
  7. #define __saveas_h
  8.  
  9. #ifndef __xfersend_h
  10. #include "xfersend.h"
  11. #endif
  12.  
  13.  
  14. (* ----------------------------- saveas -------------------------------------
  15.  * Description:   Displays a dialogue box, for the user to export application
  16.  *                data.
  17.  *
  18.  * Parameters:    int filetype -- type of file to save to
  19.  *                char *name -- suggested file name
  20.  *                int estsize -- estimated size of the file
  21.  *                xfersend_saveproc -- caller-supplied function for saving
  22.  *                                     application data to a file
  23.  *                xfersend_sendproc -- caller-supplied function for RAM
  24.  *                                     data transfer (if application is able
  25.  *                                     to do this)
  26.  *                xfersend_printproc -- caller-supplied function for printing
  27.  *                                      application data, if "save icon" is
  28.  *                                      dragged onto printer application
  29.  *                void *handle -- handle to be passed to handler functions
  30.  * Returns:       TRUE if data exported successfully.
  31.  * Other Info:    This function displays a dialogue box with the following
  32.  *                fields:
  33.  *                     i) a sprite icon appropriate to the given file type
  34.  *                    ii) the suggested filename
  35.  *                   iii) an OK button
  36.  *                (Note: a template called "xfer_send" must be in the
  37.  *                application's templates file to use this function, set up
  38.  *                as in the !Edit, !Draw and !Paint applications)
  39.  *                Xfersend deals with the complexities of message-passing
  40.  *                protocols to achieve the data transfer. Refer to the
  41.  *                typedefs in xfersend.h for an explanation of what the
  42.  *                three caller-supplied functions should do.
  43.  *                If you pass 0 as the xfersend_sendproc, then no in-core
  44.  *                data transfer will be attempted
  45.  *                If you pass 0 as the xfersend_printproc, then the file
  46.  *                format for printing is assumed to be the same as for saving
  47.  *                The estimated file size is not essential, but may improve
  48.  *                performance.
  49.  *
  50.  *)
  51. procedure saveas(filetype : integer;
  52.                 name : string;
  53.                 estsize : integer;
  54.                 saveproc : xfersend_saveproc;
  55.                 sendproc : xfersend_sendproc;
  56.                 printproc : xfersend_printproc;
  57.                 handle : pointer) : boolean; extern;
  58.  
  59.  
  60. (* ----------------------- saveas_read_leafname_during_send -----------------
  61.  * Description:   Gets the "leaf" of the file name in the "filename" field
  62.  *                of the "xfer-send" dialogue box.
  63.  *
  64.  * Parameters:    char *name -- buffer to put file name in
  65.  *                int length -- size in bytes of supplied buffer
  66.  * Returns:       void.
  67.  * Other Info:    none.
  68.  *
  69.  *)
  70. procedure saveas_read_leafname_during_send(name : string;
  71.                                            length : integer); extern;
  72.  
  73. #endif
  74.  
  75. (* end saveas.h *)
  76.