]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/utils.h
removed wxUSE_XPM_IN_MSW from setup0.h
[wxWidgets.git] / include / wx / utils.h
index 7a72994f532439015701c60c738419354892cbba..4c834988903c44bcaa190cf2d43df57862947a70 100644 (file)
 #include "wx/setup.h"
 #include "wx/object.h"
 #include "wx/list.h"
-#include "wx/window.h"
 #include "wx/filefn.h"
 
-#include "wx/ioswrap.h"
-
 #ifdef __X__
     #include <dirent.h>
     #include <unistd.h>
 
 class WXDLLEXPORT wxProcess;
 class WXDLLEXPORT wxFrame;
+class WXDLLEXPORT wxWindow;
+class WXDLLEXPORT wxWindowList;
+class WXDLLEXPORT wxPoint;
 
 // FIXME should use wxStricmp() instead
-#ifdef __GNUWIN32__
+#if defined(__GNUWIN32__)
     #define stricmp strcasecmp
     #define strnicmp strncasecmp
 #endif
@@ -59,31 +59,41 @@ class WXDLLEXPORT wxFrame;
 // String functions (deprecated, use wxString)
 // ----------------------------------------------------------------------------
 
-// Useful buffer (FIXME VZ: yeah, that is. To be removed!)
-WXDLLEXPORT_DATA(extern char*) wxBuffer;
+// Useful buffer (FIXME VZ: To be removed!!!)
+WXDLLEXPORT_DATA(extern wxChar*) wxBuffer;
 
 // Make a copy of this string using 'new'
-WXDLLEXPORT char* copystring(const char *s);
+WXDLLEXPORT wxChar* copystring(const wxChar *s);
 
 // Matches string one within string two regardless of case
-WXDLLEXPORT bool StringMatch(char *one, char *two, bool subString = TRUE, bool exact = FALSE);
+WXDLLEXPORT bool StringMatch(wxChar *one, wxChar *two, bool subString = TRUE, bool exact = FALSE);
 
 // A shorter way of using strcmp
-#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
+#define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0))
 
 // ----------------------------------------------------------------------------
 // Miscellaneous functions
 // ----------------------------------------------------------------------------
 
 // Sound the bell
-WXDLLEXPORT void wxBell(void) ;
+WXDLLEXPORT void wxBell();
+
+// Get OS description as a user-readable string
+WXDLLEXPORT wxString wxGetOsDescription();
 
 // Get OS version
-WXDLLEXPORT int wxGetOsVersion(int *majorVsn= (int *) NULL,int *minorVsn= (int *) NULL) ;
+WXDLLEXPORT int wxGetOsVersion(int *majorVsn = (int *) NULL,
+                               int *minorVsn = (int *) NULL);
 
 // Return a string with the current date/time
 WXDLLEXPORT wxString wxNow();
 
+#if wxUSE_GUI
+// Don't synthesize KeyUp events holding down a key and producing
+// KeyDown events with autorepeat. On by default and always on
+// in wxMSW.
+WXDLLEXPORT bool wxSetDetectableAutoRepeat( bool flag );
+
 // ----------------------------------------------------------------------------
 // Window ID management
 // ----------------------------------------------------------------------------
@@ -103,27 +113,29 @@ WXDLLEXPORT void wxRegisterId(long id);
 // Return the current ID
 WXDLLEXPORT long wxGetCurrentId();
 
+#endif // wxUSE_GUI
+
 // ----------------------------------------------------------------------------
 // Various conversions
 // ----------------------------------------------------------------------------
 
-WXDLLEXPORT_DATA(extern const char*) wxFloatToStringStr;
-WXDLLEXPORT_DATA(extern const char*) wxDoubleToStringStr;
+WXDLLEXPORT_DATA(extern const wxChar*) wxFloatToStringStr;
+WXDLLEXPORT_DATA(extern const wxChar*) wxDoubleToStringStr;
 
-WXDLLEXPORT void StringToFloat(char *s, float *number);
-WXDLLEXPORT char* FloatToString(float number, const char *fmt = wxFloatToStringStr);
-WXDLLEXPORT void StringToDouble(char *s, double *number);
-WXDLLEXPORT char* DoubleToString(double number, const char *fmt = wxDoubleToStringStr);
-WXDLLEXPORT void StringToInt(char *s, int *number);
-WXDLLEXPORT void StringToLong(char *s, long *number);
-WXDLLEXPORT char* IntToString(int number);
-WXDLLEXPORT char* LongToString(long number);
+WXDLLEXPORT void StringToFloat(wxChar *s, float *number);
+WXDLLEXPORT wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr);
+WXDLLEXPORT void StringToDouble(wxChar *s, double *number);
+WXDLLEXPORT wxChar* DoubleToString(double number, const wxChar *fmt = wxDoubleToStringStr);
+WXDLLEXPORT void StringToInt(wxChar *s, int *number);
+WXDLLEXPORT void StringToLong(wxChar *s, long *number);
+WXDLLEXPORT wxChar* IntToString(int number);
+WXDLLEXPORT wxChar* LongToString(long number);
 
 // Convert 2-digit hex number to decimal
 WXDLLEXPORT int wxHexToDec(const wxString& buf);
 
 // Convert decimal integer to 2-character hex string
-WXDLLEXPORT void wxDecToHex(int dec, char *buf);
+WXDLLEXPORT void wxDecToHex(int dec, wxChar *buf);
 WXDLLEXPORT wxString wxDecToHex(int dec);
 
 // ----------------------------------------------------------------------------
@@ -131,11 +143,20 @@ WXDLLEXPORT wxString wxDecToHex(int dec);
 // ----------------------------------------------------------------------------
 
 // Execute another program. Returns 0 if there was an error, a PID otherwise.
-WXDLLEXPORT long wxExecute(char **argv, bool sync = FALSE,
+WXDLLEXPORT long wxExecute(wxChar **argv, bool sync = FALSE,
                            wxProcess *process = (wxProcess *) NULL);
 WXDLLEXPORT long wxExecute(const wxString& command, bool sync = FALSE,
                            wxProcess *process = (wxProcess *) NULL);
 
+// execute the command capturing its output into an array line by line
+WXDLLEXPORT long wxExecute(const wxString& command,
+                           wxArrayString& output);
+
+// also capture stderr
+WXDLLEXPORT long wxExecute(const wxString& command,
+                           wxArrayString& output,
+                           wxArrayString& error);
+
 enum wxSignal
 {
     wxSIGNONE = 0,  // verify if the process exists under Unix
@@ -162,11 +183,15 @@ enum wxSignal
 // the argument is ignored under Windows - the process is always killed
 WXDLLEXPORT int wxKill(long pid, wxSignal sig = wxSIGTERM);
 
-// Execute a command in an interactive shell window
+// Execute a command in an interactive shell window (always synchronously)
 // If no command then just the shell
 WXDLLEXPORT bool wxShell(const wxString& command = wxEmptyString);
 
-// Sleep for nSecs seconds under UNIX, do nothing under Windows
+// As wxShell(), but must give a (non interactive) command and its output will
+// be returned in output array
+WXDLLEXPORT bool wxShell(const wxString& command, wxArrayString& output);
+
+// Sleep for nSecs seconds
 WXDLLEXPORT void wxSleep(int nSecs);
 
 // Sleep for a given amount of milliseconds
@@ -175,6 +200,23 @@ WXDLLEXPORT void wxUsleep(unsigned long milliseconds);
 // Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX)
 WXDLLEXPORT long wxGetFreeMemory();
 
+// should wxApp::OnFatalException() be called?
+WXDLLEXPORT bool wxHandleFatalExceptions(bool doit = TRUE);
+
+// ----------------------------------------------------------------------------
+// Environment variables
+// ----------------------------------------------------------------------------
+
+// returns TRUE if variable exists (value may be NULL if you just want to check
+// for this)
+WXDLLEXPORT bool wxGetEnv(const wxString& var, wxString *value);
+
+// set the env var name to the given value, return TRUE on success
+WXDLLEXPORT bool wxSetEnv(const wxString& var, const wxChar *value);
+
+// remove the env var from environment
+inline bool wxUnsetEnv(const wxString& var) { return wxSetEnv(var, NULL); }
+
 // ----------------------------------------------------------------------------
 // Network and username functions.
 // ----------------------------------------------------------------------------
@@ -182,38 +224,57 @@ WXDLLEXPORT long wxGetFreeMemory();
 // NB: "char *" functions are deprecated, use wxString ones!
 
 // Get eMail address
-WXDLLEXPORT bool wxGetEmailAddress(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetEmailAddress(wxChar *buf, int maxSize);
 WXDLLEXPORT wxString wxGetEmailAddress();
 
 // Get hostname.
-WXDLLEXPORT bool wxGetHostName(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetHostName(wxChar *buf, int maxSize);
 WXDLLEXPORT wxString wxGetHostName();
 
 // Get FQDN
 WXDLLEXPORT wxString wxGetFullHostName();
+WXDLLEXPORT bool wxGetFullHostName(wxChar *buf, int maxSize);
 
 // Get user ID e.g. jacs (this is known as login name under Unix)
-WXDLLEXPORT bool wxGetUserId(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetUserId(wxChar *buf, int maxSize);
 WXDLLEXPORT wxString wxGetUserId();
 
 // Get user name e.g. Julian Smart
-WXDLLEXPORT bool wxGetUserName(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetUserName(wxChar *buf, int maxSize);
 WXDLLEXPORT wxString wxGetUserName();
 
 // Get current Home dir and copy to dest (returns pstr->c_str())
-WXDLLEXPORT const char* wxGetHomeDir(wxString *pstr);
+WXDLLEXPORT wxString wxGetHomeDir();
+WXDLLEXPORT const wxChar* wxGetHomeDir(wxString *pstr);
 
 // Get the user's home dir (caller must copy --- volatile)
 // returns NULL is no HOME dir is known
-WXDLLEXPORT char* wxGetUserHome(const wxString& user = wxEmptyString);
+#if defined(__UNIX__) && wxUSE_UNICODE
+WXDLLEXPORT const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptyString);
+#else
+WXDLLEXPORT wxChar* wxGetUserHome(const wxString& user = wxEmptyString);
+#endif
+
+#ifdef __WXMAC__
+WXDLLEXPORT wxString wxMacFindFolder(short                                     vRefNum,
+                                                                OSType                                 folderType,
+                                                                Boolean                                createFolder);
+#endif
+
+#if wxUSE_GUI // GUI only things from now on
 
 // ----------------------------------------------------------------------------
-// Strip out any menu codes
+// Menu accelerators related things
 // ----------------------------------------------------------------------------
 
-WXDLLEXPORT char* wxStripMenuCodes(char *in, char *out = (char *) NULL);
+WXDLLEXPORT wxChar* wxStripMenuCodes(wxChar *in, wxChar *out = (wxChar *) NULL);
 WXDLLEXPORT wxString wxStripMenuCodes(const wxString& str);
 
+#if wxUSE_ACCEL
+class WXDLLEXPORT wxAcceleratorEntry;
+WXDLLEXPORT wxAcceleratorEntry *wxGetAccelFromString(const wxString& label);
+#endif // wxUSE_ACCEL
+
 // ----------------------------------------------------------------------------
 // Window search
 // ----------------------------------------------------------------------------
@@ -229,6 +290,11 @@ WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent
 // Returns menu item id or -1 if none.
 WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);
 
+// Find the wxWindow at the given point. wxGenericFindWindowAtPoint
+// is always present but may be less reliable than a native version.
+WXDLLEXPORT wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
+WXDLLEXPORT wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
+
 // ----------------------------------------------------------------------------
 // Message/event queue helpers
 // ----------------------------------------------------------------------------
@@ -236,9 +302,15 @@ WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, con
 // Yield to other apps/messages
 WXDLLEXPORT bool wxYield();
 
+// Like wxYield, but fails silently if the yield is recursive.
+WXDLLEXPORT bool wxYieldIfNeeded();
+
 // Yield to other apps/messages and disable user input
 WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL);
 
+// Enable or disable input to all top level windows
+WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = TRUE);
+
 // Check whether this window wants to process messages, e.g. Stop button
 // in long calculations.
 WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd);
@@ -246,6 +318,18 @@ WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd);
 // Consume all events until no more left
 WXDLLEXPORT void wxFlushEvents();
 
+// a class which disables all windows (except, may be, thegiven one) in its
+// ctor and enables them back in its dtor
+class WXDLLEXPORT wxWindowDisabler
+{
+public:
+    wxWindowDisabler(wxWindow *winToSkip = (wxWindow *)NULL);
+    ~wxWindowDisabler();
+
+private:
+    wxWindowList *m_winDisabled;
+};
+
 // ----------------------------------------------------------------------------
 // Cursors
 // ----------------------------------------------------------------------------
@@ -267,25 +351,18 @@ class WXDLLEXPORT wxBusyCursor
 public:
     wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR)
         { wxBeginBusyCursor(cursor); }
-   ~wxBusyCursor()
+    ~wxBusyCursor()
         { wxEndBusyCursor(); }
-};
-
-// ----------------------------------------------------------------------------
-// Error message functions used by wxWindows (deprecated, use wxLog)
-// ----------------------------------------------------------------------------
 
-// Format a message on the standard error (UNIX) or the debugging
-// stream (Windows)
-WXDLLEXPORT void wxDebugMsg(const char *fmt ...) ;
+    // FIXME: These two methods are currently only implemented (and needed?)
+    //        in wxGTK.  BusyCursor handling should probably be moved to
+    //        common code since the wxGTK and wxMSW implementations are very
+    //        similar except for wxMSW using HCURSOR directly instead of
+    //        wxCursor..  -- RL.
+    static const wxCursor &GetStoredCursor();
+    static const wxCursor GetBusyCursor();
+};
 
-// Non-fatal error (continues)
-WXDLLEXPORT_DATA(extern const char*) wxInternalErrorStr;
-WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
-
-// Fatal error (exits)
-WXDLLEXPORT_DATA(extern const char*) wxFatalErrorStr;
-WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
 
 // ----------------------------------------------------------------------------
 // Reading and writing resources (eg WIN.INI, .Xdefaults)
@@ -297,7 +374,7 @@ WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry,
 WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, long value, const wxString& file = wxEmptyString);
 WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, int value, const wxString& file = wxEmptyString);
 
-WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, char **value, const wxString& file = wxEmptyString);
+WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, wxChar **value, const wxString& file = wxEmptyString);
 WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, float *value, const wxString& file = wxEmptyString);
 WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, long *value, const wxString& file = wxEmptyString);
 WXDLLEXPORT bool wxGetResource(const wxString& section, const wxString& entry, int *value, const wxString& file = wxEmptyString);
@@ -308,8 +385,8 @@ void WXDLLEXPORT wxGetMousePosition( int* x, int* y );
 // MSW only: get user-defined resource from the .res file.
 // Returns NULL or newly-allocated memory, so use delete[] to clean up.
 #ifdef __WXMSW__
-WXDLLEXPORT extern const char* wxUserResourceStr;
-WXDLLEXPORT char* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr);
+WXDLLEXPORT extern const wxChar* wxUserResourceStr;
+WXDLLEXPORT wxChar* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr);
 
 // Implemented in utils.cpp: VC++, Win95 only. Sets up a console for standard
 // input/output
@@ -321,15 +398,26 @@ WXDLLEXPORT void wxRedirectIOToConsole();
 // Display and colorss (X only)
 // ----------------------------------------------------------------------------
 
+#ifdef __WXGTK__
+    void *wxGetDisplay();
+#endif
+
 #ifdef __X__
     WXDisplay *wxGetDisplay();
     bool wxSetDisplay(const wxString& display_name);
     wxString wxGetDisplayName();
-#endif
+#endif // X or GTK+
 
 #ifdef __X__
 
+#ifdef __VMS__ // Xlib.h for VMS is not (yet) compatible with C++
+               // The resulting warnings are switched off here
+#pragma message disable nosimpint
+#endif
 #include <X11/Xlib.h>
+#ifdef __VMS__
+#pragma message enable nosimpint
+#endif
 
 #define wxMAX_RGB           0xff
 #define wxMAX_SV            1000
@@ -352,5 +440,24 @@ void wxAllocColor(Display *display,Colormap colormap,XColor *xcolor);
 
 #endif //__X__
 
+#endif // wxUSE_GUI
+
+// ----------------------------------------------------------------------------
+// Error message functions used by wxWindows (deprecated, use wxLog)
+// ----------------------------------------------------------------------------
+
+// Format a message on the standard error (UNIX) or the debugging
+// stream (Windows)
+WXDLLEXPORT void wxDebugMsg(const wxChar *fmt ...);
+
+// Non-fatal error (continues)
+WXDLLEXPORT_DATA(extern const wxChar*) wxInternalErrorStr;
+WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
+
+// Fatal error (exits)
+WXDLLEXPORT_DATA(extern const wxChar*) wxFatalErrorStr;
+WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
+
+
 #endif
     // _WX_UTILSH__