allow specifying the mask colour in wxImage::ConvertAlphaToMask() (closes #10143)

[wxWidgets.git] / include / wx / filename.h

diff --git a/include/wx/filename.h b/include/wx/filename.h
index 6f3273257dca87af7c91c8b1e49dd9dd7028cc1d..7a7593c6d606bd65ee7fe3b72cffc8cad9b27928 100644 (file)
--- a/include/wx/filename.h
+++ b/include/wx/filename.h
@@ -27,6 +27,8 @@
 #include "wx/filefn.h"
 #include "wx/datetime.h"
 #include "wx/intl.h"
 #include "wx/filefn.h"
 #include "wx/datetime.h"
 #include "wx/intl.h"

+#include "wx/longlong.h"
+#include "wx/file.h"

 
 #if wxUSE_FILE
 class WXDLLIMPEXP_FWD_BASE wxFile;
 
 #if wxUSE_FILE
 class WXDLLIMPEXP_FWD_BASE wxFile;


@@ -36,6 +38,12 @@ class WXDLLIMPEXP_FWD_BASE wxFile;
 class WXDLLIMPEXP_FWD_BASE wxFFile;
 #endif
 
 class WXDLLIMPEXP_FWD_BASE wxFFile;
 #endif
 

+// this symbol is defined for the platforms where file systems use volumes in
+// paths
+#if defined(__WXMSW__) || defined(__DOS__) || defined(__OS2__)
+    #define wxHAS_FILESYSTEM_VOLUMES
+#endif
+

 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------


@@ -74,19 +82,27 @@ enum wxPathNormalize
 // what exactly should GetPath() return?
 enum
 {
 // what exactly should GetPath() return?
 enum
 {

+    wxPATH_NO_SEPARATOR  = 0x0000,  // for symmetry with wxPATH_GET_SEPARATOR

     wxPATH_GET_VOLUME    = 0x0001,  // include the volume if applicable
     wxPATH_GET_SEPARATOR = 0x0002   // terminate the path with the separator
 };
 
     wxPATH_GET_VOLUME    = 0x0001,  // include the volume if applicable
     wxPATH_GET_SEPARATOR = 0x0002   // terminate the path with the separator
 };
 

-// MkDir flags
+// Mkdir flags

 enum
 {
     wxPATH_MKDIR_FULL    = 0x0001   // create directories recursively
 };
 
 enum
 {
     wxPATH_MKDIR_FULL    = 0x0001   // create directories recursively
 };
 

+// Rmdir flags
+enum
+{
+    wxPATH_RMDIR_FULL       = 0x0001,  // delete with subdirectories if empty
+    wxPATH_RMDIR_RECURSIVE  = 0x0002   // delete all recursively (dangerous!)
+};
+

 #if wxUSE_LONGLONG
 // error code of wxFileName::GetSize()
 #if wxUSE_LONGLONG
 // error code of wxFileName::GetSize()

-extern wxULongLong wxInvalidSize;
+extern WXDLLIMPEXP_DATA_BASE(const wxULongLong) wxInvalidSize;

 #endif // wxUSE_LONGLONG
 
 
 #endif // wxUSE_LONGLONG
 
 


@@ -166,7 +182,7 @@ public:
         // assorted assignment operators
 
     wxFileName& operator=(const wxFileName& filename)
         // assorted assignment operators
 
     wxFileName& operator=(const wxFileName& filename)

-        { Assign(filename); return *this; }
+        { if (this != &filename) Assign(filename); return *this; }

 
     wxFileName& operator=(const wxString& filename)
         { Assign(filename); return *this; }
 
     wxFileName& operator=(const wxString& filename)
         { Assign(filename); return *this; }


@@ -247,7 +263,7 @@ public:
     }
 #endif // wxUSE_DATETIME
 
     }
 #endif // wxUSE_DATETIME
 

-#ifdef __WXMAC__
+#if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON

     bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;
     bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) ;
     // gets the 'common' type and creator for a certain extension
     bool MacSetTypeAndCreator( wxUint32 type , wxUint32 creator ) ;
     bool MacGetTypeAndCreator( wxUint32 *type , wxUint32 *creator ) ;
     // gets the 'common' type and creator for a certain extension


@@ -300,11 +316,12 @@ public:
 #endif // wxUSE_FFILE
 
     // directory creation and removal.
 #endif // wxUSE_FFILE
 
     // directory creation and removal.

-    bool Mkdir( int perm = 0777, int flags = 0);
-    static bool Mkdir( const wxString &dir, int perm = 0777, int flags = 0 );
+    bool Mkdir(int perm = wxS_DIR_DEFAULT, int flags = 0);
+    static bool Mkdir(const wxString &dir, int perm = wxS_DIR_DEFAULT,
+                      int flags = 0);

 
 

-    bool Rmdir();
-    static bool Rmdir( const wxString &dir );
+    bool Rmdir(int flags = 0);
+    static bool Rmdir(const wxString &dir, int flags = 0);

 
     // operations on the path
 
 
     // operations on the path
 


@@ -344,6 +361,25 @@ public:
                            wxString* arguments = NULL);
 #endif
 
                            wxString* arguments = NULL);
 #endif
 

+#ifndef __WXWINCE__
+        // if the path contains the value of the environment variable named envname
+        // then this function replaces it with the string obtained from
+        //    wxString::Format(replacementFmtString, value_of_envname_variable)
+        //
+        // Example:
+        //    wxFileName fn("/usr/openwin/lib/someFile");
+        //    fn.ReplaceEnvVariable("OPENWINHOME");
+        //         // now fn.GetFullPath() == "$OPENWINHOME/lib/someFile"
+    bool ReplaceEnvVariable(const wxString& envname,
+                            const wxString& replacementFmtString = "$%s",
+                            wxPathFormat format = wxPATH_NATIVE);
+#endif
+
+        // replaces, if present in the path, the home directory for the given user
+        // (see wxGetHomeDir) with a tilde
+    bool ReplaceHomeDir(wxPathFormat format = wxPATH_NATIVE);
+
+

     // Comparison
 
         // compares with the rules of the given platforms format
     // Comparison
 
         // compares with the rules of the given platforms format


@@ -483,7 +519,12 @@ public:
                             wxString *path,
                             wxPathFormat format = wxPATH_NATIVE);
 
                             wxString *path,
                             wxPathFormat format = wxPATH_NATIVE);
 

-    // Filesize
+#ifdef wxHAS_FILESYSTEM_VOLUMES
+        // return the string representing a file system volume, or drive
+    static wxString GetVolumeString(char drive, int flags = wxPATH_GET_SEPARATOR);
+#endif // wxHAS_FILESYSTEM_VOLUMES
+
+    // File size

 
 #if wxUSE_LONGLONG
         // returns the size of the given filename
 
 #if wxUSE_LONGLONG
         // returns the size of the given filename