]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/utils.h
fixed wxContextHelpButton bitmap (dis)appearance
[wxWidgets.git] / include / wx / utils.h
index 8ab3168cc9d493f0e1143c01dea2459407723a02..c47224769049d1b954b01d62059006c69cf4df1d 100644 (file)
@@ -23,7 +23,6 @@
 #include "wx/setup.h"
 #include "wx/object.h"
 #include "wx/list.h"
-#include "wx/window.h"
 #include "wx/filefn.h"
 
 #ifdef __X__
 
 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
@@ -74,14 +76,19 @@ WXDLLEXPORT bool StringMatch(wxChar *one, wxChar *two, bool subString = TRUE, bo
 // ----------------------------------------------------------------------------
 
 // 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.
@@ -106,6 +113,8 @@ WXDLLEXPORT void wxRegisterId(long id);
 // Return the current ID
 WXDLLEXPORT long wxGetCurrentId();
 
+#endif // wxUSE_GUI
+
 // ----------------------------------------------------------------------------
 // Various conversions
 // ----------------------------------------------------------------------------
@@ -139,6 +148,15 @@ WXDLLEXPORT long wxExecute(wxChar **argv, bool sync = FALSE,
 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
@@ -165,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
@@ -178,6 +200,9 @@ 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);
+
 // ----------------------------------------------------------------------------
 // Network and username functions.
 // ----------------------------------------------------------------------------
@@ -205,6 +230,7 @@ WXDLLEXPORT bool wxGetUserName(wxChar *buf, int maxSize);
 WXDLLEXPORT wxString wxGetUserName();
 
 // Get current Home dir and copy to dest (returns pstr->c_str())
+WXDLLEXPORT wxString wxGetHomeDir();
 WXDLLEXPORT const wxChar* wxGetHomeDir(wxString *pstr);
 
 // Get the user's home dir (caller must copy --- volatile)
@@ -215,13 +241,20 @@ WXDLLEXPORT const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptyString)
 WXDLLEXPORT wxChar* wxGetUserHome(const wxString& user = wxEmptyString);
 #endif
 
+#if wxUSE_GUI // GUI only things from now on
+
 // ----------------------------------------------------------------------------
-// Strip out any menu codes
+// Menu accelerators related things
 // ----------------------------------------------------------------------------
 
 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
 // ----------------------------------------------------------------------------
@@ -237,6 +270,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
 // ----------------------------------------------------------------------------
@@ -257,6 +295,22 @@ 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;
+
+#ifdef __WXMSW__
+    wxWindow *m_winTop;
+#endif // MSW
+};
+
 // ----------------------------------------------------------------------------
 // Cursors
 // ----------------------------------------------------------------------------
@@ -278,25 +332,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 wxChar *fmt ...) ;
-
-// Non-fatal error (continues)
-WXDLLEXPORT_DATA(extern const wxChar*) wxInternalErrorStr;
-WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
+    // 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();
+};
 
-// Fatal error (exits)
-WXDLLEXPORT_DATA(extern const wxChar*) wxFatalErrorStr;
-WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
 
 // ----------------------------------------------------------------------------
 // Reading and writing resources (eg WIN.INI, .Xdefaults)
@@ -332,15 +379,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
@@ -363,5 +421,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__