mdw@git.distorted.org.uk Git - ssr/blob - StraySrc/Libraries/Steel/h/saveas

   1 /*
   2  * saveas
   3  *  Handler for a save dbox under new dbox system
   4  *
   5  * v. 1.00 (9 August 1991)
   6  *
   7  * © 1991-1998 Straylight
   8  */
   9
  10 /*----- Licensing note ----------------------------------------------------*
  11  *
  12  * This file is part of Straylight's Steel library.
  13  *
  14  * Steel is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2, or (at your option)
  17  * any later version.
  18  *
  19  * Steel is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with Steel.  If not, write to the Free Software Foundation,
  26  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  27  */
  28
  29 #ifndef __saveas_h
  30 #define __saveas_h
  31
  32 #ifndef __xfersend_h
  33 #include "xfersend.h"
  34 #endif
  35
  36 /*
  37  * void saveas
  38  * (
  39  *   char *title,
  40  *   char *name,
  41  *   int filetype,
  42  *   int estsize,
  43  *   xfersend_saveproc saveproc,
  44  *   xfersend_sendproc sendproc,
  45  *   xfersend_printproc printproc,
  46  *   void *handle
  47  * )
  48  *
  49  * Use
  50  *  Creates and handles a save as dialogue box (even saving your data for
  51  *  you!).
  52  *
  53  * Parameters
  54  *  char *title == the title of the dialogue box.
  55  *  char *name == the default filename for the box.
  56  *  int filetype == the filetype of the data to be sent.
  57  *  int estsize == the estimated file size.
  58  *  xfersend_saveproc saveproc == function to save the data.
  59  *  xfersend_sendproc sendproc == function to export data to another
  60  *    application (RAM transfer).
  61  *  xfersend_printproc printproc == function to print data.
  62  *  void *handle == your handle to the data (or anything else!)
  63  */
  64
  65 void saveas
  66 (
  67   char *title,
  68   char *name,
  69   int filetype,
  70   int estsize,
  71   xfersend_saveproc saveproc,
  72   xfersend_sendproc sendproc,
  73   xfersend_printproc printproc,
  74   void *handle
  75 );
  76
  77 /*
  78  * BOOL saveas_file_is_safe(void)
  79  *
  80  * Use
  81  *  Informs caller if the file is going to a safe home.
  82  *
  83  * Returns
  84  *  TRUE if the file is 'safe' - i.e. on disk
  85  */
  86
  87 BOOL saveas_file_is_safe(void);
  88
  89 #endif