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