No docs yet, just the bare interace so we can get XML for Phoenix.

[wxWidgets.git] / interface / wx / filefn.h

diff --git a/interface/wx/filefn.h b/interface/wx/filefn.h
index 04b82d18ac4930db57f335cca38d1c576c72a39c..18fd7def0d7e5970bf2ae6dce6fad60bb0c37658 100644 (file)
--- a/interface/wx/filefn.h
+++ b/interface/wx/filefn.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxPathList and file functions
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxPathList and file functions
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -24,6 +24,9 @@
 class wxPathList : public wxArrayString
 {
 public:
 class wxPathList : public wxArrayString
 {
 public:

+    /**
+        Standard constructor.
+    */

     wxPathList();
 
     /**
     wxPathList();
 
     /**


@@ -98,7 +101,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 

-/** @ingroup group_funcmacro_file */
+/** @addtogroup group_funcmacro_file */

 //@{
 
 /**
 //@{
 
 /**


@@ -107,6 +110,15 @@ public:
 */
 const int wxInvalidOffset = -1;
 
 */
 const int wxInvalidOffset = -1;
 

+/**
+    The type used to store and provide byte offsets or byte sizes for files or streams.
+
+    It is type-defined as @c off_t on POSIX platforms
+    (see http://www.gnu.org/software/libc/manual/html_node/File-Position-Primitive.html)
+    or to @c wxLongLong_t on Windows when @c wxHAS_HUGE_FILES is defined.
+*/
+typedef off_t wxFileOffset;
+

 /**
     Under Unix this macro changes the current process umask to the given value,
     unless it is equal to -1 in which case nothing is done, and restores it to
 /**
     Under Unix this macro changes the current process umask to the given value,
     unless it is equal to -1 in which case nothing is done, and restores it to


@@ -116,7 +128,7 @@ const int wxInvalidOffset = -1;
 
     @header{wx/filefn.h}
 */
 
     @header{wx/filefn.h}
 */

-#define wxCHANGE_UMASK(int mask)
+#define wxCHANGE_UMASK(mask)

 
 /**
     This function returns the total number of bytes and number of free bytes on
 
 /**
     This function returns the total number of bytes and number of free bytes on


@@ -168,16 +180,22 @@ int wxParseCommonDialogsFilter(const wxString& wildCard,
     Converts a DOS to a Unix filename by replacing backslashes with forward
     slashes.
 
     Converts a DOS to a Unix filename by replacing backslashes with forward
     slashes.
 

+    @deprecated
+        Construct a wxFileName with wxPATH_DOS and then use
+        wxFileName::GetFullPath(wxPATH_UNIX) instead.
+

     @header{wx/filefn.h}
 */
 void wxDos2UnixFilename(wxChar* s);
 
 /**
     @header{wx/filefn.h}
 */
 void wxDos2UnixFilename(wxChar* s);
 
 /**

-    @warning This function is deprecated, use wxFileName instead.
-

     Converts a Unix to a DOS filename by replacing forward slashes with
     backslashes.
 
     Converts a Unix to a DOS filename by replacing forward slashes with
     backslashes.
 

+    @deprecated
+        Construct a wxFileName with wxPATH_UNIX and then use
+        wxFileName::GetFullPath(wxPATH_DOS) instead.
+

     @header{wx/filefn.h}
 */
 void wxUnix2DosFilename(wxChar* s);
     @header{wx/filefn.h}
 */
 void wxUnix2DosFilename(wxChar* s);


@@ -190,8 +208,8 @@ void wxUnix2DosFilename(wxChar* s);
 bool wxDirExists(const wxString& dirname);
 
 /**
 bool wxDirExists(const wxString& dirname);
 
 /**

-    @warning This function is obsolete, please use wxFileName::SplitPath()
-             instead.
+    @deprecated
+        This function is obsolete, please use wxFileName::SplitPath() instead.

 
     This function splits a full file name into components: the path (including
     possible disk/drive specification under Windows), the base name, and the
 
     This function splits a full file name into components: the path (including
     possible disk/drive specification under Windows), the base name, and the


@@ -230,9 +248,10 @@ time_t wxFileModificationTime(const wxString& filename);
 /**
     Renames @a file1 to @e file2, returning @true if successful.
 
 /**
     Renames @a file1 to @e file2, returning @true if successful.
 

-    If @a overwrite parameter is @true (default), the destination file is
-    overwritten if it exists, but if @a overwrite is @false, the functions
-    fails in this case.
+    If @a file2 is a directory, @a file1 is moved into it (@a overwrite is
+    ignored in this case). Otherwise, if @a file2 is an existing file, it is
+    overwritten if @a overwrite is @true (default) and the function fails if @a
+    overwrite is @false.

 
     @header{wx/filefn.h}
 */
 
     @header{wx/filefn.h}
 */


@@ -274,7 +293,7 @@ bool wxMatchWild(const wxString& pattern,
                   bool dot_special);
 
 /**
                   bool dot_special);
 
 /**

-    @warning This function is deprecated, use wxGetCwd() instead.
+    @deprecated This function is deprecated, use wxGetCwd() instead.

 
     Copies the current working directory into the buffer if supplied, or copies
     the working directory into new storage (which you must delete yourself) if
 
     Copies the current working directory into the buffer if supplied, or copies
     the working directory into new storage (which you must delete yourself) if


@@ -343,6 +362,59 @@ bool wxConcatFiles(const wxString& file1,
 */
 bool wxRemoveFile(const wxString& file);
 
 */
 bool wxRemoveFile(const wxString& file);
 

+/**
+    File permission bit names.
+
+    We define these constants in wxWidgets because S_IREAD &c are not standard.
+    However, we do assume that the values correspond to the Unix umask bits.
+*/
+enum wxPosixPermissions
+{
+    /// Standard POSIX names for these permission flags with "wx" prefix.
+    //@{
+    wxS_IRUSR = 00400,
+    wxS_IWUSR = 00200,
+    wxS_IXUSR = 00100,
+
+    wxS_IRGRP = 00040,
+    wxS_IWGRP = 00020,
+    wxS_IXGRP = 00010,
+
+    wxS_IROTH = 00004,
+    wxS_IWOTH = 00002,
+    wxS_IXOTH = 00001,
+    //@}
+
+    /// Longer but more readable synonyms for the constants above.
+    //@{
+    wxPOSIX_USER_READ = wxS_IRUSR,
+    wxPOSIX_USER_WRITE = wxS_IWUSR,
+    wxPOSIX_USER_EXECUTE = wxS_IXUSR,
+
+    wxPOSIX_GROUP_READ = wxS_IRGRP,
+    wxPOSIX_GROUP_WRITE = wxS_IWGRP,
+    wxPOSIX_GROUP_EXECUTE = wxS_IXGRP,
+
+    wxPOSIX_OTHERS_READ = wxS_IROTH,
+    wxPOSIX_OTHERS_WRITE = wxS_IWOTH,
+    wxPOSIX_OTHERS_EXECUTE = wxS_IXOTH,
+    //@}
+
+    /// Default mode for the new files: allow reading/writing them to everybody but
+    /// the effective file mode will be set after ANDing this value with umask and
+    /// so won't include wxS_IW{GRP,OTH} for the default 022 umask value
+    wxS_DEFAULT = (wxPOSIX_USER_READ | wxPOSIX_USER_WRITE | \
+                   wxPOSIX_GROUP_READ | wxPOSIX_GROUP_WRITE | \
+                   wxPOSIX_OTHERS_READ | wxPOSIX_OTHERS_WRITE),
+
+    /// Default mode for the new directories (see wxFileName::Mkdir): allow
+    /// reading/writing/executing them to everybody, but just like wxS_DEFAULT
+    /// the effective directory mode will be set after ANDing this value with umask
+    wxS_DIR_DEFAULT = (wxPOSIX_USER_READ | wxPOSIX_USER_WRITE | wxPOSIX_USER_EXECUTE | \
+                       wxPOSIX_GROUP_READ | wxPOSIX_GROUP_WRITE | wxPOSIX_GROUP_EXECUTE | \
+                       wxPOSIX_OTHERS_READ | wxPOSIX_OTHERS_WRITE | wxPOSIX_OTHERS_EXECUTE)
+};
+

 /**
     Makes the directory @a dir, returning @true if successful.
 
 /**
     Makes the directory @a dir, returning @true if successful.
 


@@ -351,7 +423,7 @@ bool wxRemoveFile(const wxString& file);
 
     @header{wx/filefn.h}
 */
 
     @header{wx/filefn.h}
 */

-bool wxMkdir(const wxString& dir, int perm = 0777);
+bool wxMkdir(const wxString& dir, int perm = wxS_DIR_DEFAULT);

 
 /**
     Removes the directory @a dir, returning @true if successful. Does not work
 
 /**
     Removes the directory @a dir, returning @true if successful. Does not work


@@ -422,7 +494,7 @@ enum wxFileKind
 
 //@}
 
 
 //@}
 

-/** @ingroup group_funcmacro_file */
+/** @addtogroup group_funcmacro_file */

 //@{
 /**
     Returns the type of an open file. Possible return values are enumerations
 //@{
 /**
     Returns the type of an open file. Possible return values are enumerations


@@ -434,11 +506,11 @@ wxFileKind wxGetFileKind(int fd);
 wxFileKind wxGetFileKind(FILE* fp);
 //@}
 
 wxFileKind wxGetFileKind(FILE* fp);
 //@}
 

-/** @ingroup group_funcmacro_file */
+/** @addtogroup group_funcmacro_file */

 //@{
 /**
 //@{
 /**

-    @warning This function is obsolete, please use wxFileName::SplitPath()
-             instead.
+    @deprecated
+        This function is obsolete, please use wxFileName::SplitPath() instead.

 
     Returns the filename for a full path. The second form returns a pointer to
     temporary storage that should not be deallocated.
 
     Returns the filename for a full path. The second form returns a pointer to
     temporary storage that should not be deallocated.


@@ -449,11 +521,11 @@ wxString wxFileNameFromPath(const wxString& path);
 char* wxFileNameFromPath(char* path);
 //@}
 
 char* wxFileNameFromPath(char* path);
 //@}
 

-/** @ingroup group_funcmacro_file */
+/** @addtogroup group_funcmacro_file */

 //@{
 /**
 //@{
 /**

-    @warning This function is obsolete, please use
-             wxFileName::CreateTempFileName() instead.
+    @deprecated
+        This function is obsolete, please use wxFileName::CreateTempFileName() instead.

 
     @header{wx/filefn.h}
 */
 
     @header{wx/filefn.h}
 */