// headers
// ----------------------------------------------------------------------------
-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) && !defined(__EMX__)
+// Some older compilers (such as EMX) cannot handle
+// #pragma interface/implementation correctly, iff
+// #pragma implementation is used in _two_ translation
+// units (as created by e.g. event.cpp compiled for
+// libwx_base and event.cpp compiled for libwx_gui_core).
+// So we must not use those pragmas for those compilers in
+// such files.
#pragma interface "utils.h"
#endif
#include "wx/list.h"
#include "wx/filefn.h"
+class WXDLLIMPEXP_BASE wxArrayString;
+
// need this for wxGetDiskSpace() as we can't, unfortunately, forward declare
// wxLongLong
#include "wx/longlong.h"
// Forward declaration
// ----------------------------------------------------------------------------
-class WXDLLIMPEXP_BASE wxProcess;
-class WXDLLIMPEXP_BASE wxFrame;
-class WXDLLIMPEXP_BASE wxWindow;
-class WXDLLIMPEXP_BASE wxWindowList;
-class WXDLLIMPEXP_BASE wxPoint;
+class WXDLLIMPEXP_CORE wxProcess;
+class WXDLLIMPEXP_CORE wxFrame;
+class WXDLLIMPEXP_CORE wxWindow;
+class WXDLLIMPEXP_CORE wxWindowList;
+class WXDLLIMPEXP_CORE wxPoint;
// ----------------------------------------------------------------------------
// Macros
#define wxMax(a,b) (((a) > (b)) ? (a) : (b))
#define wxMin(a,b) (((a) < (b)) ? (a) : (b))
+// wxGetFreeMemory can return huge amount of memory on 64-bit platforms
+// define wxMemorySize according to the type which best fits your platform
+#if wxUSE_LONGLONG && defined(__WIN64__)
+ // 64 bit Windowses have sizeof(long) only 32 bit long
+ // we need to use wxLongLong to express memory sizes
+ #define wxMemorySize wxLongLong
+#else
+ // 64 bit UNIX has sizeof(long) = 64
+ // assume 32 bit platforms cannnot return more than 32bits of
+ #define wxMemorySize long
+#endif
+
// ----------------------------------------------------------------------------
// String functions (deprecated, use wxString)
// ----------------------------------------------------------------------------
// Make a copy of this string using 'new'
-WXDLLIMPEXP_BASE wxChar* copystring(const wxChar *s);
-
-#if WXWIN_COMPATIBILITY_2
-// Matches string one within string two regardless of case
-WXDLLIMPEXP_BASE bool StringMatch(const wxChar *one, const wxChar *two, bool subString = TRUE, bool exact = FALSE);
+#if WXWIN_COMPATIBILITY_2_4
+wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* copystring(const wxChar *s) );
#endif
// A shorter way of using strcmp
// ----------------------------------------------------------------------------
// Sound the bell
+#if !defined __EMX__ && \
+ (defined __WXMOTIF__ || defined __WXGTK__ || defined __WXX11__)
+WXDLLIMPEXP_CORE void wxBell();
+#else
WXDLLIMPEXP_BASE void wxBell();
+#endif
// Get OS description as a user-readable string
WXDLLIMPEXP_BASE wxString wxGetOsDescription();
// Return a string with the current date/time
WXDLLIMPEXP_BASE wxString wxNow();
-// Return path where wxWindows is installed (mostly useful in Unices)
+// Return path where wxWidgets is installed (mostly useful in Unices)
WXDLLIMPEXP_BASE const wxChar *wxGetInstallPrefix();
// Return path to wxWin data (/usr/share/wx/%{version}) (Unices)
WXDLLIMPEXP_BASE wxString wxGetDataDir();
#if wxUSE_GUI
+
+// Get the state of a key (true if pressed, false if not)
+// This is generally most useful getting the state of
+// the modifier or toggle keys.
+WXDLLEXPORT bool wxGetKeyState(wxKeyCode key);
+
+
// Don't synthesize KeyUp events holding down a key and producing
// KeyDown events with autorepeat. On by default and always on
// in wxMSW.
// Generate a unique ID
WXDLLEXPORT long wxNewId();
-#if !defined(NewId) && defined(WXWIN_COMPATIBILITY)
- #define NewId wxNewId
-#endif
// Ensure subsequent IDs don't clash with this one
WXDLLEXPORT void wxRegisterId(long id);
-#if !defined(RegisterId) && defined(WXWIN_COMPATIBILITY)
- #define RegisterId wxRegisterId
-#endif
// Return the current ID
WXDLLEXPORT long wxGetCurrentId();
// these functions are deprecated, use wxString methods instead!
#if WXWIN_COMPATIBILITY_2_4
-WXDLLIMPEXP_DATA_BASE(extern const wxChar*) wxFloatToStringStr;
-WXDLLIMPEXP_DATA_BASE(extern const wxChar*) wxDoubleToStringStr;
+extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxFloatToStringStr;
+extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxDoubleToStringStr;
-WXDLLIMPEXP_BASE void StringToFloat(const wxChar *s, float *number);
-WXDLLIMPEXP_BASE wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr);
-WXDLLIMPEXP_BASE void StringToDouble(const wxChar *s, double *number);
-WXDLLIMPEXP_BASE wxChar* DoubleToString(double number, const wxChar *fmt = wxDoubleToStringStr);
-WXDLLIMPEXP_BASE void StringToInt(const wxChar *s, int *number);
-WXDLLIMPEXP_BASE void StringToLong(const wxChar *s, long *number);
-WXDLLIMPEXP_BASE wxChar* IntToString(int number);
-WXDLLIMPEXP_BASE wxChar* LongToString(long number);
+wxDEPRECATED( WXDLLIMPEXP_BASE void StringToFloat(const wxChar *s, float *number) );
+wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr) );
+wxDEPRECATED( WXDLLIMPEXP_BASE void StringToDouble(const wxChar *s, double *number) );
+wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* DoubleToString(double number, const wxChar *fmt = wxDoubleToStringStr) );
+wxDEPRECATED( WXDLLIMPEXP_BASE void StringToInt(const wxChar *s, int *number) );
+wxDEPRECATED( WXDLLIMPEXP_BASE void StringToLong(const wxChar *s, long *number) );
+wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* IntToString(int number) );
+wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* LongToString(long number) );
#endif // WXWIN_COMPATIBILITY_2_4
// Process management
// ----------------------------------------------------------------------------
-// NB: for backwars compatibility reasons the values of wxEXEC_[A]SYNC *must*
+// NB: for backwards compatibility reasons the values of wxEXEC_[A]SYNC *must*
// be 0 and 1, don't change!
enum
// is done by default)
wxEXEC_NOHIDE = 2,
- // under Unix, if the process is the group leader then killing -pid kills
- // all children as well as pid
- wxEXEC_MAKE_GROUP_LEADER = 4
+ // under Unix, if the process is the group leader then passing wxKILL_CHILDREN to wxKill
+ // kills all children as well as pid
+ wxEXEC_MAKE_GROUP_LEADER = 4,
+
+ // by default synchronous execution disables all program windows to avoid
+ // that the user interacts with the program while the child process is
+ // running, you can use this flag to prevent this from happening
+ wxEXEC_NODISABLE = 8
};
// Execute another program.
// execute the command capturing its output into an array line by line, this is
// always synchronous
WXDLLIMPEXP_BASE long wxExecute(const wxString& command,
- wxArrayString& output);
+ wxArrayString& output,
+ int flags = 0);
// also capture stderr (also synchronous)
WXDLLIMPEXP_BASE long wxExecute(const wxString& command,
- wxArrayString& output,
- wxArrayString& error);
+ wxArrayString& output,
+ wxArrayString& error,
+ int flags = 0);
enum wxSignal
{
wxKILL_ERROR // another, unspecified error
};
+enum wxKillFlags
+{
+ wxKILL_NOCHILDREN = 0, // don't kill children
+ wxKILL_CHILDREN = 1 // kill children
+};
+
enum wxShutdownFlags
{
wxSHUTDOWN_POWEROFF, // power off the computer
// Shutdown or reboot the PC
WXDLLIMPEXP_BASE bool wxShutdown(wxShutdownFlags wFlags);
+enum wxPowerType
+{
+ wxPOWER_SOCKET,
+ wxPOWER_BATTERY,
+ wxPOWER_UNKNOWN
+};
+
+WXDLLIMPEXP_BASE wxPowerType wxGetPowerType();
+
+enum wxBatteryState
+{
+ wxBATTERY_NORMAL_STATE, // system is fully usable
+ wxBATTERY_LOW_STATE, // start to worry
+ wxBATTERY_CRITICAL_STATE, // save quickly
+ wxBATTERY_SHUTDOWN_STATE, // too late
+ wxBATTERY_UNKNOWN_STATE
+};
+
+WXDLLIMPEXP_BASE wxBatteryState wxGetBatteryState();
+
// send the given signal to the process (only NONE and KILL are supported under
// Windows, all others mean TERM), return 0 if ok and -1 on error
//
// return detailed error in rc if not NULL
WXDLLIMPEXP_BASE int wxKill(long pid,
wxSignal sig = wxSIGTERM,
- wxKillError *rc = NULL);
+ wxKillError *rc = NULL,
+ int flags = wxKILL_NOCHILDREN);
// Execute a command in an interactive shell window (always synchronously)
// If no command then just the shell
WXDLLIMPEXP_BASE void wxSleep(int nSecs);
// Sleep for a given amount of milliseconds
-WXDLLIMPEXP_BASE void wxUsleep(unsigned long milliseconds);
+WXDLLIMPEXP_BASE void wxMilliSleep(unsigned long milliseconds);
+
+// Sleep for a given amount of microseconds
+WXDLLIMPEXP_BASE void wxMicroSleep(unsigned long microseconds);
+
+// Sleep for a given amount of milliseconds (old, bad name), use wxMilliSleep
+wxDEPRECATED( WXDLLIMPEXP_BASE void wxUsleep(unsigned long milliseconds) );
// Get the process id of the current process
WXDLLIMPEXP_BASE unsigned long wxGetProcessId();
// Get free memory in bytes, or -1 if cannot determine amount (e.g. on UNIX)
-WXDLLIMPEXP_BASE long wxGetFreeMemory();
+WXDLLIMPEXP_BASE wxMemorySize wxGetFreeMemory();
+
+#if wxUSE_ON_FATAL_EXCEPTION
// should wxApp::OnFatalException() be called?
-WXDLLIMPEXP_BASE bool wxHandleFatalExceptions(bool doit = TRUE);
+WXDLLIMPEXP_BASE bool wxHandleFatalExceptions(bool doit = true);
+
+#endif // wxUSE_ON_FATAL_EXCEPTION
+
+#if wxABI_VERSION >= 20601
+// Launch url in the user's default internet browser
+WXDLLIMPEXP_BASE bool wxLaunchDefaultBrowser(const wxString& url);
+#endif
// ----------------------------------------------------------------------------
// Environment variables
// ----------------------------------------------------------------------------
-// returns TRUE if variable exists (value may be NULL if you just want to check
+// returns true if variable exists (value may be NULL if you just want to check
// for this)
WXDLLIMPEXP_BASE bool wxGetEnv(const wxString& var, wxString *value);
-// set the env var name to the given value, return TRUE on success
+// set the env var name to the given value, return true on success
WXDLLIMPEXP_BASE bool wxSetEnv(const wxString& var, const wxChar *value);
// remove the env var from environment
// Window search
// ----------------------------------------------------------------------------
-// Returns menu item id or -1 if none.
+// Returns menu item id or wxNOT_FOUND if none.
WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);
// Find the wxWindow at the given point. wxGenericFindWindowAtPoint
// ----------------------------------------------------------------------------
// Yield to other apps/messages and disable user input
-WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL, bool onlyIfNeeded = FALSE);
+WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL, bool onlyIfNeeded = false);
// Enable or disable input to all top level windows
-WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = TRUE);
+WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = true);
// Check whether this window wants to process messages, e.g. Stop button
// in long calculations.
// Set the cursor to the busy cursor for all windows
class WXDLLEXPORT wxCursor;
-WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR;
+extern WXDLLEXPORT_DATA(wxCursor*) wxHOURGLASS_CURSOR;
WXDLLEXPORT void wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
// Restore cursor to normal
WXDLLEXPORT void wxEndBusyCursor();
-// TRUE if we're between the above two calls
+// true if we're between the above two calls
WXDLLEXPORT bool wxIsBusy();
// Convenience class so we can just create a wxBusyCursor object on the stack
// 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 wxChar* wxUserResourceStr;
+ extern WXDLLEXPORT const wxChar* wxUserResourceStr;
WXDLLEXPORT wxChar* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr);
#endif // MSW
#endif
#ifdef __X__
- WXDisplay *wxGetDisplay();
- bool wxSetDisplay(const wxString& display_name);
- wxString wxGetDisplayName();
+ WXDLLIMPEXP_CORE WXDisplay *wxGetDisplay();
+ WXDLLIMPEXP_CORE bool wxSetDisplay(const wxString& display_name);
+ WXDLLIMPEXP_CORE wxString wxGetDisplayName();
#endif // X or GTK+
#ifdef __X__
WXDLLIMPEXP_BASE bool wxYieldIfNeeded();
// ----------------------------------------------------------------------------
-// Error message functions used by wxWindows (deprecated, use wxLog)
+// Error message functions used by wxWidgets (deprecated, use wxLog)
// ----------------------------------------------------------------------------
#if WXWIN_COMPATIBILITY_2_2
// Format a message on the standard error (UNIX) or the debugging
// stream (Windows)
-WXDLLIMPEXP_BASE void wxDebugMsg(const wxChar *fmt ...) ATTRIBUTE_PRINTF_1;
+wxDEPRECATED( WXDLLIMPEXP_BASE void wxDebugMsg(const wxChar *fmt ...) ATTRIBUTE_PRINTF_1 );
// Non-fatal error (continues)
-WXDLLIMPEXP_DATA_BASE(extern const wxChar*) wxInternalErrorStr;
-WXDLLIMPEXP_BASE void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
+extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxInternalErrorStr;
+wxDEPRECATED( WXDLLIMPEXP_BASE void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr) );
// Fatal error (exits)
-WXDLLIMPEXP_DATA_BASE(extern const wxChar*) wxFatalErrorStr;
-WXDLLIMPEXP_BASE void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
+extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxFatalErrorStr;
+wxDEPRECATED( WXDLLIMPEXP_BASE void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr) );
#endif // WXWIN_COMPATIBILITY_2_2
projects / wxWidgets.git / blobdiff