include/wx/private/filename.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/private/filename.h
   3 // Purpose:     Internal declarations for src/common/filename.cpp
   4 // Author:      Mike Wetherell
   5 // Modified by:
   6 // Created:     2006-10-22
   7 // Copyright:   (c) 2006 Mike Wetherell
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_PRIVATE_FILENAME_H_
  12 #define _WX_PRIVATE_FILENAME_H_
  13
  14 #include "wx/file.h"
  15 #include "wx/ffile.h"
  16
  17 // Self deleting temp files aren't supported on all platforms. Therefore
  18 // rather than let these be in the API, they can be used internally to
  19 // implement classes (e.g. wxTempFileStream), that will do the clean up when
  20 // the OS doesn't support it.
  21
  22 // Same usage as wxFileName::CreateTempFileName() with the extra parameter
  23 // deleteOnClose. *deleteOnClose true on entry requests a file created with a
  24 // delete on close flag, on exit the value of *deleteOnClose indicates whether
  25 // available.
  26
  27 #if wxUSE_FILE
  28 wxString wxCreateTempFileName(const wxString& prefix,
  29                               wxFile *fileTemp,
  30                               bool *deleteOnClose = NULL);
  31 #endif
  32
  33 #if wxUSE_FFILE
  34 wxString wxCreateTempFileName(const wxString& prefix,
  35                               wxFFile *fileTemp,
  36                               bool *deleteOnClose = NULL);
  37 #endif
  38
  39 // Returns an open temp file, if possible either an unlinked open file or one
  40 // that will delete on close. Only returns the filename if neither was
  41 // possible, so that the caller can delete the file when done.
  42
  43 #if wxUSE_FILE
  44 bool wxCreateTempFile(const wxString& prefix,
  45                       wxFile *fileTemp,
  46                       wxString *name);
  47 #endif
  48
  49 #if wxUSE_FFILE
  50 bool wxCreateTempFile(const wxString& prefix,
  51                       wxFFile *fileTemp,
  52                       wxString *name);
  53 #endif
  54
  55 #endif // _WX_PRIVATE_FILENAME_H_