// Created: 29/01/98
// RCS-ID: $Id$
// Copyright: (c) 1998 Julian Smart
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_UTILSH__
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
+#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 WXDLLEXPORT wxProcess;
-class WXDLLEXPORT wxFrame;
-class WXDLLEXPORT wxWindow;
-class WXDLLEXPORT wxWindowList;
-class WXDLLEXPORT wxPoint;
+class WXDLLIMPEXP_BASE wxProcess;
+class WXDLLIMPEXP_BASE wxFrame;
+class WXDLLIMPEXP_BASE wxWindow;
+class WXDLLIMPEXP_BASE wxWindowList;
+class WXDLLIMPEXP_BASE wxPoint;
// ----------------------------------------------------------------------------
// Macros
// String functions (deprecated, use wxString)
// ----------------------------------------------------------------------------
-// Useful buffer (FIXME VZ: To be removed!!!)
-// Now only needed in Mac and MSW ports
-#if !defined(__WXMOTIF__) && !defined(__WXGTK__) && !defined(__WXX11__) && !defined(__WXMGL__)
-WXDLLEXPORT_DATA(extern wxChar*) wxBuffer;
-#endif
-
// Make a copy of this string using 'new'
-WXDLLEXPORT wxChar* copystring(const wxChar *s);
-
-// Matches string one within string two regardless of case
-WXDLLEXPORT bool StringMatch(const wxChar *one, const wxChar *two, bool subString = TRUE, bool exact = FALSE);
+#if WXWIN_COMPATIBILITY_2_4
+WXDLLIMPEXP_BASE wxChar* copystring(const wxChar *s);
+#endif
// A shorter way of using strcmp
#define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0))
// ----------------------------------------------------------------------------
// Sound the bell
-WXDLLEXPORT void wxBell();
+WXDLLIMPEXP_BASE void wxBell();
// Get OS description as a user-readable string
-WXDLLEXPORT wxString wxGetOsDescription();
+WXDLLIMPEXP_BASE wxString wxGetOsDescription();
// Get OS version
-WXDLLEXPORT int wxGetOsVersion(int *majorVsn = (int *) NULL,
+WXDLLIMPEXP_BASE int wxGetOsVersion(int *majorVsn = (int *) NULL,
int *minorVsn = (int *) NULL);
// Return a string with the current date/time
-WXDLLEXPORT wxString wxNow();
+WXDLLIMPEXP_BASE wxString wxNow();
// Return path where wxWindows is installed (mostly useful in Unices)
-WXDLLEXPORT const wxChar *wxGetInstallPrefix();
+WXDLLIMPEXP_BASE const wxChar *wxGetInstallPrefix();
// Return path to wxWin data (/usr/share/wx/%{version}) (Unices)
-WXDLLEXPORT wxString wxGetDataDir();
+WXDLLIMPEXP_BASE wxString wxGetDataDir();
#if wxUSE_GUI
+#if defined(__WXMSW__) || defined(__WXMAC__)
+ // Get the state of a key (true if pressed, false if not)
+ // This is generally most useful getting the state of
+ // Caps Lock, Num Lock and Scroll Lock...
+
+ // Note - There is a X11/GTK version which will be here
+ // soon
+ WXDLLEXPORT bool wxGetKeyState(wxKeyCode key);
+#endif
+
// 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();
// Various conversions
// ----------------------------------------------------------------------------
-WXDLLEXPORT_DATA(extern const wxChar*) wxFloatToStringStr;
-WXDLLEXPORT_DATA(extern const wxChar*) wxDoubleToStringStr;
+// these functions are deprecated, use wxString methods instead!
+#if WXWIN_COMPATIBILITY_2_4
-WXDLLEXPORT void StringToFloat(const wxChar *s, float *number);
-WXDLLEXPORT wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr);
-WXDLLEXPORT void StringToDouble(const wxChar *s, double *number);
-WXDLLEXPORT wxChar* DoubleToString(double number, const wxChar *fmt = wxDoubleToStringStr);
-WXDLLEXPORT void StringToInt(const wxChar *s, int *number);
-WXDLLEXPORT void StringToLong(const wxChar *s, long *number);
-WXDLLEXPORT wxChar* IntToString(int number);
-WXDLLEXPORT wxChar* LongToString(long number);
+WXDLLIMPEXP_DATA_BASE(extern const wxChar*) wxFloatToStringStr;
+WXDLLIMPEXP_DATA_BASE(extern 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);
+
+#endif // WXWIN_COMPATIBILITY_2_4
// Convert 2-digit hex number to decimal
-WXDLLEXPORT int wxHexToDec(const wxString& buf);
+WXDLLIMPEXP_BASE int wxHexToDec(const wxString& buf);
// Convert decimal integer to 2-character hex string
-WXDLLEXPORT void wxDecToHex(int dec, wxChar *buf);
-WXDLLEXPORT wxString wxDecToHex(int dec);
+WXDLLIMPEXP_BASE void wxDecToHex(int dec, wxChar *buf);
+WXDLLIMPEXP_BASE wxString wxDecToHex(int dec);
// ----------------------------------------------------------------------------
// Process management
// If flags contain wxEXEC_SYNC, return -1 on failure and the exit code of the
// process if everything was ok. Otherwise (i.e. if wxEXEC_ASYNC), return 0 on
// failure and the PID of the launched process if ok.
-WXDLLEXPORT long wxExecute(char **argv, int flags = wxEXEC_ASYNC,
+WXDLLIMPEXP_BASE long wxExecute(wxChar **argv, int flags = wxEXEC_ASYNC,
wxProcess *process = (wxProcess *) NULL);
-WXDLLEXPORT long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC,
+WXDLLIMPEXP_BASE long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC,
wxProcess *process = (wxProcess *) NULL);
// execute the command capturing its output into an array line by line, this is
// always synchronous
-WXDLLEXPORT long wxExecute(const wxString& command,
+WXDLLIMPEXP_BASE long wxExecute(const wxString& command,
wxArrayString& output);
// also capture stderr (also synchronous)
-WXDLLEXPORT long wxExecute(const wxString& command,
+WXDLLIMPEXP_BASE long wxExecute(const wxString& command,
wxArrayString& output,
wxArrayString& error);
wxKILL_ERROR // another, unspecified error
};
+enum wxShutdownFlags
+{
+ wxSHUTDOWN_POWEROFF, // power off the computer
+ wxSHUTDOWN_REBOOT // shutdown and reboot
+};
+
+// Shutdown or reboot the PC
+WXDLLIMPEXP_BASE bool wxShutdown(wxShutdownFlags wFlags);
+
// 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
-WXDLLEXPORT int wxKill(long pid,
+WXDLLIMPEXP_BASE int wxKill(long pid,
wxSignal sig = wxSIGTERM,
wxKillError *rc = NULL);
// Execute a command in an interactive shell window (always synchronously)
// If no command then just the shell
-WXDLLEXPORT bool wxShell(const wxString& command = wxEmptyString);
+WXDLLIMPEXP_BASE bool wxShell(const wxString& command = wxEmptyString);
// 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);
+WXDLLIMPEXP_BASE bool wxShell(const wxString& command, wxArrayString& output);
// Sleep for nSecs seconds
-WXDLLEXPORT void wxSleep(int nSecs);
+WXDLLIMPEXP_BASE void wxSleep(int nSecs);
// Sleep for a given amount of milliseconds
-WXDLLEXPORT void wxUsleep(unsigned long milliseconds);
+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)
-WXDLLEXPORT long wxGetFreeMemory();
+WXDLLIMPEXP_BASE long wxGetFreeMemory();
// should wxApp::OnFatalException() be called?
-WXDLLEXPORT bool wxHandleFatalExceptions(bool doit = TRUE);
+WXDLLIMPEXP_BASE 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);
+WXDLLIMPEXP_BASE 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);
+WXDLLIMPEXP_BASE bool wxSetEnv(const wxString& var, const wxChar *value);
// remove the env var from environment
inline bool wxUnsetEnv(const wxString& var) { return wxSetEnv(var, NULL); }
// NB: "char *" functions are deprecated, use wxString ones!
// Get eMail address
-WXDLLEXPORT bool wxGetEmailAddress(wxChar *buf, int maxSize);
-WXDLLEXPORT wxString wxGetEmailAddress();
+WXDLLIMPEXP_BASE bool wxGetEmailAddress(wxChar *buf, int maxSize);
+WXDLLIMPEXP_BASE wxString wxGetEmailAddress();
// Get hostname.
-WXDLLEXPORT bool wxGetHostName(wxChar *buf, int maxSize);
-WXDLLEXPORT wxString wxGetHostName();
+WXDLLIMPEXP_BASE bool wxGetHostName(wxChar *buf, int maxSize);
+WXDLLIMPEXP_BASE wxString wxGetHostName();
// Get FQDN
-WXDLLEXPORT wxString wxGetFullHostName();
-WXDLLEXPORT bool wxGetFullHostName(wxChar *buf, int maxSize);
+WXDLLIMPEXP_BASE wxString wxGetFullHostName();
+WXDLLIMPEXP_BASE bool wxGetFullHostName(wxChar *buf, int maxSize);
// Get user ID e.g. jacs (this is known as login name under Unix)
-WXDLLEXPORT bool wxGetUserId(wxChar *buf, int maxSize);
-WXDLLEXPORT wxString wxGetUserId();
+WXDLLIMPEXP_BASE bool wxGetUserId(wxChar *buf, int maxSize);
+WXDLLIMPEXP_BASE wxString wxGetUserId();
// Get user name e.g. Julian Smart
-WXDLLEXPORT bool wxGetUserName(wxChar *buf, int maxSize);
-WXDLLEXPORT wxString wxGetUserName();
+WXDLLIMPEXP_BASE bool wxGetUserName(wxChar *buf, int maxSize);
+WXDLLIMPEXP_BASE wxString wxGetUserName();
// Get current Home dir and copy to dest (returns pstr->c_str())
-WXDLLEXPORT wxString wxGetHomeDir();
-WXDLLEXPORT const wxChar* wxGetHomeDir(wxString *pstr);
+WXDLLIMPEXP_BASE wxString wxGetHomeDir();
+WXDLLIMPEXP_BASE const wxChar* wxGetHomeDir(wxString *pstr);
// Get the user's home dir (caller must copy --- volatile)
// returns NULL is no HOME dir is known
#if defined(__UNIX__) && wxUSE_UNICODE
-WXDLLEXPORT const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptyString);
+WXDLLIMPEXP_BASE const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptyString);
#else
-WXDLLEXPORT wxChar* wxGetUserHome(const wxString& user = wxEmptyString);
+WXDLLIMPEXP_BASE wxChar* wxGetUserHome(const wxString& user = wxEmptyString);
#endif
// get number of total/free bytes on the disk where path belongs
-WXDLLEXPORT bool wxGetDiskSpace(const wxString& path,
+WXDLLIMPEXP_BASE bool wxGetDiskSpace(const wxString& path,
wxLongLong *pTotal = NULL,
wxLongLong *pFree = NULL);
// Window search
// ----------------------------------------------------------------------------
-// Find the window/widget with the given title or label.
-// Pass a parent to begin the search from, or NULL to look through
-// all windows.
-WXDLLEXPORT wxWindow* wxFindWindowByLabel(const wxString& title, wxWindow *parent = (wxWindow *) NULL);
-
-// Find window by name, and if that fails, by label.
-WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent = (wxWindow *) NULL);
-
// Returns menu item id or -1 if none.
WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);
WXDLLEXPORT wxWindow* wxGenericFindWindowAtPoint(const wxPoint& pt);
WXDLLEXPORT wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
+// NB: this function is obsolete, use wxWindow::FindWindowByLabel() instead
+//
+// Find the window/widget with the given title or label.
+// Pass a parent to begin the search from, or NULL to look through
+// all windows.
+WXDLLEXPORT wxWindow* wxFindWindowByLabel(const wxString& title, wxWindow *parent = (wxWindow *) NULL);
+
+// NB: this function is obsolete, use wxWindow::FindWindowByName() instead
+//
+// Find window by name, and if that fails, by label.
+WXDLLEXPORT wxWindow* wxFindWindowByName(const wxString& name, wxWindow *parent = (wxWindow *) NULL);
+
// ----------------------------------------------------------------------------
// Message/event queue helpers
// ----------------------------------------------------------------------------
-// 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);
+WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL, bool onlyIfNeeded = FALSE);
// Enable or disable input to all top level windows
WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = TRUE);
private:
wxWindowList *m_winDisabled;
+
+ DECLARE_NO_COPY_CLASS(wxWindowDisabler)
};
// ----------------------------------------------------------------------------
#endif // wxUSE_GUI
+// ----------------------------------------------------------------------------
+// wxYield(): these functions are obsolete, please use wxApp methods instead!
+// ----------------------------------------------------------------------------
+
+// Yield to other apps/messages
+WXDLLIMPEXP_BASE bool wxYield();
+
+// Like wxYield, but fails silently if the yield is recursive.
+WXDLLIMPEXP_BASE bool wxYieldIfNeeded();
+
// ----------------------------------------------------------------------------
// 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 ...);
+WXDLLIMPEXP_BASE void wxDebugMsg(const wxChar *fmt ...) ATTRIBUTE_PRINTF_1;
// Non-fatal error (continues)
-WXDLLEXPORT_DATA(extern const wxChar*) wxInternalErrorStr;
-WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
+WXDLLIMPEXP_DATA_BASE(extern const wxChar*) wxInternalErrorStr;
+WXDLLIMPEXP_BASE 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);
+WXDLLIMPEXP_DATA_BASE(extern const wxChar*) wxFatalErrorStr;
+WXDLLIMPEXP_BASE void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
#endif // WXWIN_COMPATIBILITY_2_2
projects / wxWidgets.git / blobdiff