wxHTML src code indentation now conforms (more) to wxWin coding style

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

diff --git a/include/wx/utils.h b/include/wx/utils.h
index 1b63cccae029d3d35aa1307370427c07cdb1633b..5329a493e662995487243699b0ca4b96bc000843 100644 (file)
--- a/include/wx/utils.h
+++ b/include/wx/utils.h
@@ -39,6 +39,8 @@
 class WXDLLEXPORT wxProcess;
 class WXDLLEXPORT wxFrame;
 class WXDLLEXPORT wxWindow;
 class WXDLLEXPORT wxProcess;
 class WXDLLEXPORT wxFrame;
 class WXDLLEXPORT wxWindow;

+class WXDLLEXPORT wxWindowList;
+class WXDLLEXPORT wxPoint;

 
 // FIXME should use wxStricmp() instead
 #if defined(__GNUWIN32__)
 
 // FIXME should use wxStricmp() instead
 #if defined(__GNUWIN32__)


@@ -76,8 +78,12 @@ WXDLLEXPORT bool StringMatch(wxChar *one, wxChar *two, bool subString = TRUE, bo
 // Sound the bell
 WXDLLEXPORT void wxBell();
 
 // Sound the bell
 WXDLLEXPORT void wxBell();
 

+// Get OS description as a user-readable string
+WXDLLEXPORT wxString wxGetOsDescription();
+

 // Get OS version
 // 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();
 
 // Return a string with the current date/time
 WXDLLEXPORT wxString wxNow();


@@ -142,6 +148,15 @@ WXDLLEXPORT long wxExecute(wxChar **argv, bool sync = FALSE,
 WXDLLEXPORT long wxExecute(const wxString& command, 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
 enum wxSignal
 {
     wxSIGNONE = 0,  // verify if the process exists under Unix


@@ -168,11 +183,15 @@ enum wxSignal
 // the argument is ignored under Windows - the process is always killed
 WXDLLEXPORT int wxKill(long pid, wxSignal sig = wxSIGTERM);
 
 // 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);
 
 // 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
 WXDLLEXPORT void wxSleep(int nSecs);
 
 // Sleep for a given amount of milliseconds


@@ -181,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();
 
 // 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.
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Network and username functions.
 // ----------------------------------------------------------------------------


@@ -208,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 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)
 WXDLLEXPORT const wxChar* wxGetHomeDir(wxString *pstr);
 
 // Get the user's home dir (caller must copy --- volatile)


@@ -247,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);
 
 // 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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Message/event queue helpers
 // ----------------------------------------------------------------------------


@@ -267,6 +295,18 @@ WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd);
 // Consume all events until no more left
 WXDLLEXPORT void wxFlushEvents();
 
 // 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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Cursors
 // ----------------------------------------------------------------------------


@@ -288,25 +328,18 @@ class WXDLLEXPORT wxBusyCursor
 public:
     wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR)
         { wxBeginBusyCursor(cursor); }
 public:
     wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR)
         { wxBeginBusyCursor(cursor); }

-   ~wxBusyCursor()
+    ~wxBusyCursor()

         { wxEndBusyCursor(); }
         { 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)
 
 // ----------------------------------------------------------------------------
 // Reading and writing resources (eg WIN.INI, .Xdefaults)


@@ -354,7 +387,14 @@ WXDLLEXPORT void wxRedirectIOToConsole();
 
 #ifdef __X__
 
 
 #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>
 #include <X11/Xlib.h>

+#ifdef __VMS__
+#pragma message enable nosimpint
+#endif

 
 #define wxMAX_RGB           0xff
 #define wxMAX_SV            1000
 
 #define wxMAX_RGB           0xff
 #define wxMAX_SV            1000


@@ -377,32 +417,24 @@ void wxAllocColor(Display *display,Colormap colormap,XColor *xcolor);
 
 #endif //__X__
 
 
 #endif //__X__
 

+#endif // wxUSE_GUI
+

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-// font-related functions (X and GTK)
+// Error message functions used by wxWindows (deprecated, use wxLog)

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-#if defined(__X__) || defined(__WXGTK__)
-
-#ifdef __X__
-    typedef XFontStruct *wxNativeFont;
-#else // GDK
-    typedef GdkFont *wxNativeFont;
-#endif
+// Format a message on the standard error (UNIX) or the debugging
+// stream (Windows)
+WXDLLEXPORT void wxDebugMsg(const wxChar *fmt ...);

 
 

-#include "wx/font.h"    // for wxFontEncoding
-    
-// returns the handle of the nearest available font or 0
-extern wxNativeFont wxLoadQueryNearestFont(int pointSize,
-                                           int family,
-                                           int style,
-                                           int weight,
-                                           bool underlined,
-                                           const wxString &facename,
-                                           wxFontEncoding encoding);
+// Non-fatal error (continues)
+WXDLLEXPORT_DATA(extern const wxChar*) wxInternalErrorStr;
+WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);

 
 

-#endif // X || GTK
+// Fatal error (exits)
+WXDLLEXPORT_DATA(extern const wxChar*) wxFatalErrorStr;
+WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);

 
 

-#endif // wxUSE_GUI

 
 #endif
     // _WX_UTILSH__
 
 #endif
     // _WX_UTILSH__