/////////////////////////////////////////////////////////////////////////////
-// Name: utils.h
+// Name: wx/utils.h
// Purpose: Miscellaneous utilities
// Author: Julian Smart
// Modified by:
// Created: 29/01/98
// RCS-ID: $Id$
// Copyright: (c) 1998 Julian Smart
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_UTILSH__
#define _WX_UTILSH__
-#ifdef __GNUG__
-#pragma interface "utils.h"
-#endif
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
-#include "wx/setup.h"
#include "wx/object.h"
#include "wx/list.h"
-#include "wx/window.h"
#include "wx/filefn.h"
-#include "wx/process.h"
+#if wxUSE_GUI
+ #include "wx/gdicmn.h"
+#endif
-#if wxUSE_IOSTREAMH
-#include <iostream.h>
-#else
-#include <iostream>
+class WXDLLIMPEXP_BASE wxArrayString;
+class WXDLLIMPEXP_BASE wxArrayInt;
+
+// need this for wxGetDiskSpace() as we can't, unfortunately, forward declare
+// wxLongLong
+#include "wx/longlong.h"
+
+#ifdef __WATCOMC__
+ #include <direct.h>
+#elif defined(__X__)
+ #include <dirent.h>
+ #include <unistd.h>
#endif
-#ifdef __X__
-#ifndef __VMS__
-/*steve: these two are not known under VMS */
-#include <dirent.h>
-#include <unistd.h>
+#include <stdio.h>
+
+// ----------------------------------------------------------------------------
+// Forward declaration
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxProcess;
+class WXDLLIMPEXP_CORE wxFrame;
+class WXDLLIMPEXP_CORE wxWindow;
+class WXDLLIMPEXP_CORE wxWindowList;
+
+// ----------------------------------------------------------------------------
+// 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 32-bit platforms as well
+// so to always use long long for its result type on all platforms which
+// support it
+#if wxUSE_LONGLONG
+ typedef wxLongLong wxMemorySize;
+#else
+ typedef long wxMemorySize;
#endif
+
+// ----------------------------------------------------------------------------
+// String functions (deprecated, use wxString)
+// ----------------------------------------------------------------------------
+
+// Make a copy of this string using 'new'
+#if WXWIN_COMPATIBILITY_2_4
+wxDEPRECATED( WXDLLIMPEXP_BASE wxChar* copystring(const wxChar *s) );
#endif
-#include <stdio.h>
+// A shorter way of using strcmp
+#define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0))
-#ifdef __GNUWIN32__
-#define stricmp strcasecmp
-#define strnicmp strncasecmp
+// ----------------------------------------------------------------------------
+// Miscellaneous functions
+// ----------------------------------------------------------------------------
+
+// Sound the bell
+#if !defined __EMX__ && \
+ (defined __WXMOTIF__ || defined __WXGTK__ || defined __WXX11__)
+WXDLLIMPEXP_CORE void wxBell();
+#else
+WXDLLIMPEXP_BASE void wxBell();
#endif
-// Forward declaration
-class WXDLLEXPORT wxFrame;
+// Get OS description as a user-readable string
+WXDLLIMPEXP_BASE wxString wxGetOsDescription();
-// Stupid ASCII macros
-#define wxToUpper(C) (((C) >= 'a' && (C) <= 'z')? (C) - 'a' + 'A': (C))
-#define wxToLower(C) (((C) >= 'A' && (C) <= 'Z')? (C) - 'A' + 'a': (C))
+// Get OS version
+WXDLLIMPEXP_BASE int wxGetOsVersion(int *majorVsn = (int *) NULL,
+ int *minorVsn = (int *) NULL);
// Return a string with the current date/time
-wxString WXDLLEXPORT wxNow(void);
+WXDLLIMPEXP_BASE wxString wxNow();
+
+// 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();
+
+/*
+ * Class to make it easier to specify platform-dependent values
+ *
+ * Examples:
+ * long val = wxPlatform::If(wxMac, 1).ElseIf(wxGTK, 2).ElseIf(stPDA, 5).Else(3);
+ * wxString strVal = wxPlatform::If(wxMac, wxT("Mac")).ElseIf(wxMSW, wxT("MSW")).Else(wxT("Other"));
+ *
+ * A custom platform symbol:
+ *
+ * #define stPDA 100
+ * #ifdef __WXWINCE__
+ * wxPlatform::AddPlatform(stPDA);
+ * #endif
+ *
+ * long windowStyle = wxCAPTION | (long) wxPlatform::IfNot(stPDA, wxRESIZE_BORDER);
+ *
+ */
+
+class WXDLLIMPEXP_BASE wxPlatform
+{
+public:
+ wxPlatform() { Init(); }
+ wxPlatform(const wxPlatform& platform) { Copy(platform); }
+ void operator = (const wxPlatform& platform) { Copy(platform); }
+ void Copy(const wxPlatform& platform);
+ void Init() { m_longValue = 0; m_doubleValue = 0.0; }
+
+ // Specify an optional default value
+ wxPlatform(long defValue) { m_longValue = defValue; m_doubleValue = 0.0; }
+ wxPlatform(const wxString& defValue) { m_stringValue = defValue; m_longValue = 0; m_doubleValue = 0.0; }
+ wxPlatform(double defValue) { m_longValue = 0; m_doubleValue = defValue; }
+
+ static wxPlatform If(int platform, long value);
+ static wxPlatform IfNot(int platform, long value);
+ wxPlatform& ElseIf(int platform, long value);
+ wxPlatform& ElseIfNot(int platform, long value);
+ wxPlatform& Else(long value);
+
+ static wxPlatform If(int platform, int value);
+ static wxPlatform IfNot(int platform, int value) { return IfNot(platform, (long)value); }
+ wxPlatform& ElseIf(int platform, int value) { return ElseIf(platform, (long) value); }
+ wxPlatform& ElseIfNot(int platform, int value) { return ElseIfNot(platform, (long) value); }
+ wxPlatform& Else(int value) { return Else((long) value); }
+
+ static wxPlatform If(int platform, double value);
+ static wxPlatform IfNot(int platform, double value);
+ wxPlatform& ElseIf(int platform, double value);
+ wxPlatform& ElseIfNot(int platform, double value);
+ wxPlatform& Else(double value);
+
+ static wxPlatform If(int platform, const wxString& value);
+ static wxPlatform IfNot(int platform, const wxString& value);
+ wxPlatform& ElseIf(int platform, const wxString& value);
+ wxPlatform& ElseIfNot(int platform, const wxString& value);
+ wxPlatform& Else(const wxString& value);
+
+ long GetInteger() const { return m_longValue; }
+ const wxString& GetString() const { return m_stringValue; }
+ double GetDouble() const { return m_doubleValue; }
+
+ operator int() const { return (int) GetInteger(); }
+ operator long() const { return GetInteger(); }
+ operator double() const { return GetDouble(); }
+ operator const wxString() const { return GetString(); }
+ operator const wxChar*() const { return (const wxChar*) GetString(); }
+
+ static void AddPlatform(int platform);
+ static bool Is(int platform);
+ static void ClearPlatforms();
+
+private:
+ long m_longValue;
+ double m_doubleValue;
+ wxString m_stringValue;
+ static wxArrayInt* sm_customPlatforms;
+};
+
+/// Function for testing current platform
+inline bool wxPlatformIs(int platform) { return wxPlatform::Is(platform); }
+
+#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);
-// Make a copy of this string using 'new'
-char* WXDLLEXPORT copystring(const char *s);
+
+// 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 );
+
+
+// wxMouseState is used to hold information about button and modifier state
+// and is what is returned from wxGetMouseState.
+class WXDLLEXPORT wxMouseState
+{
+public:
+ wxMouseState()
+ : m_x(0), m_y(0),
+ m_leftDown(false), m_middleDown(false), m_rightDown(false),
+ m_controlDown(false), m_shiftDown(false), m_altDown(false),
+ m_metaDown(false)
+ {}
+
+ wxCoord GetX() { return m_x; }
+ wxCoord GetY() { return m_y; }
+
+ bool LeftDown() { return m_leftDown; }
+ bool MiddleDown() { return m_middleDown; }
+ bool RightDown() { return m_rightDown; }
+
+ bool ControlDown() { return m_controlDown; }
+ bool ShiftDown() { return m_shiftDown; }
+ bool AltDown() { return m_altDown; }
+ bool MetaDown() { return m_metaDown; }
+ bool CmdDown()
+ {
+#if defined(__WXMAC__) || defined(__WXCOCOA__)
+ return MetaDown();
+#else
+ return ControlDown();
+#endif
+ }
+
+ void SetX(wxCoord x) { m_x = x; }
+ void SetY(wxCoord y) { m_y = y; }
+
+ void SetLeftDown(bool down) { m_leftDown = down; }
+ void SetMiddleDown(bool down) { m_middleDown = down; }
+ void SetRightDown(bool down) { m_rightDown = down; }
+
+ void SetControlDown(bool down) { m_controlDown = down; }
+ void SetShiftDown(bool down) { m_shiftDown = down; }
+ void SetAltDown(bool down) { m_altDown = down; }
+ void SetMetaDown(bool down) { m_metaDown = down; }
+
+private:
+ wxCoord m_x;
+ wxCoord m_y;
+
+ bool m_leftDown;
+ bool m_middleDown;
+ bool m_rightDown;
+
+ bool m_controlDown;
+ bool m_shiftDown;
+ bool m_altDown;
+ bool m_metaDown;
+};
+
+
+// Returns the current state of the mouse position, buttons and modifers
+WXDLLEXPORT wxMouseState wxGetMouseState();
+
+
+// ----------------------------------------------------------------------------
+// Window ID management
+// ----------------------------------------------------------------------------
// Generate a unique ID
-long WXDLLEXPORT wxNewId(void);
-#define NewId wxNewId
+WXDLLEXPORT long wxNewId();
// Ensure subsequent IDs don't clash with this one
-void WXDLLEXPORT wxRegisterId(long id);
-#define RegisterId wxRegisterId
+WXDLLEXPORT void wxRegisterId(long id);
// Return the current ID
-long WXDLLEXPORT wxGetCurrentId(void);
+WXDLLEXPORT long wxGetCurrentId();
-// Useful buffer
-WXDLLEXPORT_DATA(extern char*) wxBuffer;
-
-WXDLLEXPORT_DATA(extern const char*) wxFloatToStringStr;
-WXDLLEXPORT_DATA(extern const char*) wxDoubleToStringStr;
+#endif // wxUSE_GUI
+// ----------------------------------------------------------------------------
// Various conversions
-void WXDLLEXPORT StringToFloat(char *s, float *number);
-char* WXDLLEXPORT FloatToString(float number, const char *fmt = wxFloatToStringStr);
-void WXDLLEXPORT StringToDouble(char *s, double *number);
-char* WXDLLEXPORT DoubleToString(double number, const char *fmt = wxDoubleToStringStr);
-void WXDLLEXPORT StringToInt(char *s, int *number);
-void WXDLLEXPORT StringToLong(char *s, long *number);
-char* WXDLLEXPORT IntToString(int number);
-char* WXDLLEXPORT LongToString(long number);
-
-// Matches string one within string two regardless of case
-bool WXDLLEXPORT StringMatch(char *one, char *two, bool subString = TRUE, bool exact = FALSE);
+// ----------------------------------------------------------------------------
-// A shorter way of using strcmp
-#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
+// these functions are deprecated, use wxString methods instead!
+#if WXWIN_COMPATIBILITY_2_4
+
+extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxFloatToStringStr;
+extern WXDLLIMPEXP_DATA_BASE(const wxChar*) wxDoubleToStringStr;
+
+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
// Convert 2-digit hex number to decimal
-int WXDLLEXPORT wxHexToDec(const wxString& buf);
+WXDLLIMPEXP_BASE int wxHexToDec(const wxString& buf);
// Convert decimal integer to 2-character hex string
-void WXDLLEXPORT wxDecToHex(int dec, char *buf);
-wxString WXDLLEXPORT wxDecToHex(int dec);
+WXDLLIMPEXP_BASE void wxDecToHex(int dec, wxChar *buf);
+WXDLLIMPEXP_BASE wxString wxDecToHex(int dec);
+
+// ----------------------------------------------------------------------------
+// Process management
+// ----------------------------------------------------------------------------
+
+// NB: for backwards compatibility reasons the values of wxEXEC_[A]SYNC *must*
+// be 0 and 1, don't change!
+
+enum
+{
+ // execute the process asynchronously
+ wxEXEC_ASYNC = 0,
+
+ // execute it synchronously, i.e. wait until it finishes
+ wxEXEC_SYNC = 1,
-// Execute another program. Returns 0 if there was an error, a PID otherwise.
-long WXDLLEXPORT wxExecute(char **argv, bool sync = FALSE,
+ // under Windows, don't hide the child even if it's IO is redirected (this
+ // is done by default)
+ wxEXEC_NOHIDE = 2,
+
+ // 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.
+//
+// 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.
+WXDLLIMPEXP_BASE long wxExecute(wxChar **argv, int flags = wxEXEC_ASYNC,
wxProcess *process = (wxProcess *) NULL);
-long WXDLLEXPORT wxExecute(const wxString& command, bool sync = FALSE,
+WXDLLIMPEXP_BASE long wxExecute(const wxString& command, int flags = wxEXEC_ASYNC,
wxProcess *process = (wxProcess *) NULL);
-#define wxSIGTERM 1
+// 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,
+ int flags = 0);
+
+// also capture stderr (also synchronous)
+WXDLLIMPEXP_BASE long wxExecute(const wxString& command,
+ wxArrayString& output,
+ wxArrayString& error,
+ int flags = 0);
+
+#if defined(__WXMSW__) && wxUSE_IPC
+// ask a DDE server to execute the DDE request with given parameters
+WXDLLIMPEXP_BASE bool wxExecuteDDE(const wxString& ddeServer,
+ const wxString& ddeTopic,
+ const wxString& ddeCommand);
+#endif // __WXMSW__ && wxUSE_IPC
+
+enum wxSignal
+{
+ wxSIGNONE = 0, // verify if the process exists under Unix
+ wxSIGHUP,
+ wxSIGINT,
+ wxSIGQUIT,
+ wxSIGILL,
+ wxSIGTRAP,
+ wxSIGABRT,
+ wxSIGIOT = wxSIGABRT, // another name
+ wxSIGEMT,
+ wxSIGFPE,
+ wxSIGKILL,
+ wxSIGBUS,
+ wxSIGSEGV,
+ wxSIGSYS,
+ wxSIGPIPE,
+ wxSIGALRM,
+ wxSIGTERM
+
+ // further signals are different in meaning between different Unix systems
+};
+
+enum wxKillError
+{
+ wxKILL_OK, // no error
+ wxKILL_BAD_SIGNAL, // no such signal
+ wxKILL_ACCESS_DENIED, // permission denied
+ wxKILL_NO_PROCESS, // no such process
+ 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
+ wxSHUTDOWN_REBOOT // shutdown and reboot
+};
+
+// Shutdown or reboot the PC
+WXDLLIMPEXP_BASE bool wxShutdown(wxShutdownFlags wFlags);
+
+enum wxPowerType
+{
+ wxPOWER_SOCKET,
+ wxPOWER_BATTERY,
+ wxPOWER_UNKNOWN
+};
+
+WXDLLIMPEXP_BASE wxPowerType wxGetPowerType();
-int WXDLLEXPORT wxKill(long pid, int sig=wxSIGTERM);
+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();
-// Execute a command in an interactive shell window
+// 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,
+ int flags = wxKILL_NOCHILDREN);
+
+// Execute a command in an interactive shell window (always synchronously)
// If no command then just the shell
-bool WXDLLEXPORT wxShell(const wxString& command = "");
+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
+WXDLLIMPEXP_BASE bool wxShell(const wxString& command, wxArrayString& output);
+
+// Sleep for nSecs seconds
+WXDLLIMPEXP_BASE void wxSleep(int nSecs);
-// Sleep for nSecs seconds under UNIX, do nothing under Windows
-void WXDLLEXPORT wxSleep(int nSecs);
+// Sleep for a given amount of 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)
-long WXDLLEXPORT wxGetFreeMemory(void);
+WXDLLIMPEXP_BASE wxMemorySize wxGetFreeMemory();
-// Consume all events until no more left
-void WXDLLEXPORT wxFlushEvents(void);
+#if wxUSE_ON_FATAL_EXCEPTION
-/*
- * Network and username functions.
- *
- */
+// should wxApp::OnFatalException() be called?
+WXDLLIMPEXP_BASE bool wxHandleFatalExceptions(bool doit = true);
+
+#endif // wxUSE_ON_FATAL_EXCEPTION
+
+// flags for wxLaunchDefaultBrowser
+enum
+{
+ wxBROWSER_NEW_WINDOW = 1
+};
+
+// Launch url in the user's default internet browser
+WXDLLIMPEXP_BASE bool wxLaunchDefaultBrowser(const wxString& url, int flags = 0);
+
+// ----------------------------------------------------------------------------
+// Environment variables
+// ----------------------------------------------------------------------------
+
+// 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
+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); }
+
+// ----------------------------------------------------------------------------
+// Network and username functions.
+// ----------------------------------------------------------------------------
+
+// NB: "char *" functions are deprecated, use wxString ones!
// Get eMail address
-bool WXDLLEXPORT wxGetEmailAddress(char *buf, int maxSize);
+WXDLLIMPEXP_BASE bool wxGetEmailAddress(wxChar *buf, int maxSize);
+WXDLLIMPEXP_BASE wxString wxGetEmailAddress();
// Get hostname.
-bool WXDLLEXPORT wxGetHostName(char *buf, int maxSize);
+WXDLLIMPEXP_BASE bool wxGetHostName(wxChar *buf, int maxSize);
+WXDLLIMPEXP_BASE wxString wxGetHostName();
-// Get user ID e.g. jacs
-bool WXDLLEXPORT wxGetUserId(char *buf, int maxSize);
+// Get FQDN
+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)
+WXDLLIMPEXP_BASE bool wxGetUserId(wxChar *buf, int maxSize);
+WXDLLIMPEXP_BASE wxString wxGetUserId();
// Get user name e.g. Julian Smart
-bool WXDLLEXPORT wxGetUserName(char *buf, int maxSize);
+WXDLLIMPEXP_BASE bool wxGetUserName(wxChar *buf, int maxSize);
+WXDLLIMPEXP_BASE wxString wxGetUserName();
-/*
- * Strip out any menu codes
- */
-char* WXDLLEXPORT wxStripMenuCodes(char *in, char *out = (char *) NULL);
+// Get current Home dir and copy to dest (returns pstr->c_str())
+WXDLLIMPEXP_BASE wxString wxGetHomeDir();
+WXDLLIMPEXP_BASE const wxChar* wxGetHomeDir(wxString *pstr);
-// 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.
-wxWindow* WXDLLEXPORT wxFindWindowByLabel(const wxString& title, wxWindow *parent = (wxWindow *) NULL);
+// Get the user's home dir (caller must copy --- volatile)
+// returns NULL is no HOME dir is known
+#if defined(__UNIX__) && wxUSE_UNICODE
+WXDLLIMPEXP_BASE const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptyString);
+#else
+WXDLLIMPEXP_BASE wxChar* wxGetUserHome(const wxString& user = wxEmptyString);
+#endif
-// Find window by name, and if that fails, by label.
-wxWindow* WXDLLEXPORT wxFindWindowByName(const wxString& name, wxWindow *parent = (wxWindow *) NULL);
+#if wxUSE_LONGLONG
+ typedef wxLongLong wxDiskspaceSize_t;
+#else
+ typedef long wxDiskspaceSize_t;
+#endif
-// Returns menu item id or -1 if none.
-int WXDLLEXPORT wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);
+// get number of total/free bytes on the disk where path belongs
+WXDLLIMPEXP_BASE bool wxGetDiskSpace(const wxString& path,
+ wxDiskspaceSize_t *pTotal = NULL,
+ wxDiskspaceSize_t *pFree = NULL);
-// A debugging stream buffer.
-// Under Windows, this writes to the Windows debug output.
-// Under other platforms, it writes to cerr.
+#if wxUSE_GUI // GUI only things from now on
-// ALl this horrible gubbins required for Borland, because the calling
-// convention needs to be the same as for streambuf.
-// Thanks to Gerhard.Vogt@embl-heidelberg.de for this solution.
+// ----------------------------------------------------------------------------
+// Menu accelerators related things
+// ----------------------------------------------------------------------------
-#if defined(__BORLANDC__) && defined(__BCOPT__) && !defined(_RTL_ALLOW_po) && !defined(__FLAT__)
-#pragma option -po-
-#endif
+WXDLLEXPORT wxChar* wxStripMenuCodes(const wxChar *in, wxChar *out = (wxChar *) NULL);
+WXDLLEXPORT wxString wxStripMenuCodes(const wxString& str);
-// Can't export a class derived from a non-export class
-#if !defined(_WINDLL) && !defined(WXUSINGDLL)
+#if wxUSE_ACCEL
+class WXDLLEXPORT wxAcceleratorEntry;
+WXDLLEXPORT wxAcceleratorEntry *wxGetAccelFromString(const wxString& label);
+#endif // wxUSE_ACCEL
-// #ifdef new
-// #undef new
-// #endif
+// ----------------------------------------------------------------------------
+// Window search
+// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxDebugStreamBuf: public streambuf
-{
- public:
- wxDebugStreamBuf(void);
- ~wxDebugStreamBuf(void) {}
+// Returns menu item id or wxNOT_FOUND if none.
+WXDLLEXPORT int wxFindMenuItemId(wxFrame *frame, const wxString& menuString, const wxString& itemString);
- int overflow(int i);
- inline int underflow(void) { return EOF; }
- int sync(void);
-};
+// 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);
-// #if WXDEBUG && wxUSE_GLOBAL_MEMORY_OPERATORS
-// #define new WXDEBUG_NEW
-// #endif
+// 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);
-#endif
+// 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);
-#if defined(__BORLANDC__) && defined(__BCOPT__) && !defined(_RTL_ALLOW_po) && !defined(__FLAT__)
-#pragma option -po.
-#endif
+// ----------------------------------------------------------------------------
+// Message/event queue helpers
+// ----------------------------------------------------------------------------
-/*
-#if (!defined(__MINMAX_DEFINED) && !defined(max))
-#define max(a,b) (((a) > (b)) ? (a) : (b))
-#define min(a,b) (((a) < (b)) ? (a) : (b))
-#define __MINMAX_DEFINED 1
-#endif
-*/
-#define wxMax(a,b) (((a) > (b)) ? (a) : (b))
-#define wxMin(a,b) (((a) < (b)) ? (a) : (b))
+// Yield to other apps/messages and disable user input
+WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL, bool onlyIfNeeded = false);
-// Yield to other apps/messages
-bool WXDLLEXPORT wxYield(void);
+// Enable or disable input to all top level windows
+WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = true);
-// Format a message on the standard error (UNIX) or the debugging
-// stream (Windows)
-void WXDLLEXPORT wxDebugMsg(const char *fmt ...) ;
-
-// Sound the bell
-void WXDLLEXPORT wxBell(void) ;
-
-// Get OS version
-int WXDLLEXPORT wxGetOsVersion(int *majorVsn= (int *) NULL,int *minorVsn= (int *) NULL) ;
+// Check whether this window wants to process messages, e.g. Stop button
+// in long calculations.
+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;
+
+ DECLARE_NO_COPY_CLASS(wxWindowDisabler)
+};
+
+// ----------------------------------------------------------------------------
+// Cursors
+// ----------------------------------------------------------------------------
// Set the cursor to the busy cursor for all windows
-class WXDLLEXPORT wxCursor;
-WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR;
-void WXDLLEXPORT wxBeginBusyCursor(wxCursor *cursor = wxHOURGLASS_CURSOR);
-
+WXDLLIMPEXP_CORE void wxBeginBusyCursor(const wxCursor *cursor = wxHOURGLASS_CURSOR);
+
// Restore cursor to normal
-void WXDLLEXPORT wxEndBusyCursor(void);
-
-// TRUE if we're between the above two calls
-bool WXDLLEXPORT wxIsBusy(void);
+WXDLLEXPORT void wxEndBusyCursor();
-/* Error message functions used by wxWindows */
+// true if we're between the above two calls
+WXDLLEXPORT bool wxIsBusy();
-// Non-fatal error (continues)
-WXDLLEXPORT_DATA(extern const char*) wxInternalErrorStr;
-void WXDLLEXPORT wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
+// Convenience class so we can just create a wxBusyCursor object on the stack
+class WXDLLEXPORT wxBusyCursor
+{
+public:
+ wxBusyCursor(const wxCursor* cursor = wxHOURGLASS_CURSOR)
+ { wxBeginBusyCursor(cursor); }
+ ~wxBusyCursor()
+ { wxEndBusyCursor(); }
+
+ // 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 char*) wxFatalErrorStr;
-void WXDLLEXPORT wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
+// ----------------------------------------------------------------------------
// Reading and writing resources (eg WIN.INI, .Xdefaults)
+// ----------------------------------------------------------------------------
+
#if wxUSE_RESOURCES
-bool WXDLLEXPORT wxWriteResource(const wxString& section, const wxString& entry, const wxString& value, const wxString& file = "");
-bool WXDLLEXPORT wxWriteResource(const wxString& section, const wxString& entry, float value, const wxString& file = "");
-bool WXDLLEXPORT wxWriteResource(const wxString& section, const wxString& entry, long value, const wxString& file = "");
-bool WXDLLEXPORT wxWriteResource(const wxString& section, const wxString& entry, int value, const wxString& file = "");
-
-bool WXDLLEXPORT wxGetResource(const wxString& section, const wxString& entry, char **value, const wxString& file = "");
-bool WXDLLEXPORT wxGetResource(const wxString& section, const wxString& entry, float *value, const wxString& file = "");
-bool WXDLLEXPORT wxGetResource(const wxString& section, const wxString& entry, long *value, const wxString& file = "");
-bool WXDLLEXPORT wxGetResource(const wxString& section, const wxString& entry, int *value, const wxString& file = "");
+WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, const wxString& value, const wxString& file = wxEmptyString);
+WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry, float value, const wxString& file = wxEmptyString);
+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, 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);
#endif // wxUSE_RESOURCES
-// Get current Home dir and copy to dest (returns pstr->c_str())
-const char* WXDLLEXPORT wxGetHomeDir(wxString *pstr);
-
-// Get the user's home dir (caller must copy--- volatile)
-// returns NULL is no HOME dir is known
-char* WXDLLEXPORT wxGetUserHome(const wxString& user = "");
-
-// Check whether this window wants to process messages, e.g. Stop button
-// in long calculations.
-bool WXDLLEXPORT wxCheckForInterrupt(wxWindow *wnd);
-
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__
-extern const char* WXDLLEXPORT wxUserResourceStr;
-char* WXDLLEXPORT wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr);
+ extern WXDLLEXPORT const wxChar* wxUserResourceStr;
+ WXDLLEXPORT wxChar* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr);
+#endif // MSW
+
+// ----------------------------------------------------------------------------
+// Display and colorss (X only)
+// ----------------------------------------------------------------------------
+
+#ifdef __WXGTK__
+ void *wxGetDisplay();
#endif
-// X only
#ifdef __X__
-WXDisplay *wxGetDisplay();
-bool wxSetDisplay(const wxString& display_name);
-wxString wxGetDisplayName();
-#endif
+ WXDLLIMPEXP_CORE WXDisplay *wxGetDisplay();
+ WXDLLIMPEXP_CORE bool wxSetDisplay(const wxString& display_name);
+ WXDLLIMPEXP_CORE wxString wxGetDisplayName();
+#endif // X or GTK+
#ifdef __X__
-#include <X11/Xlib.h>
+#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
+
+#endif //__X__
-#define wxMAX_RGB 0xff
-#define wxMAX_SV 1000
-#define wxSIGN(x) ((x < 0) ? -x : x)
-#define wxH_WEIGHT 4
-#define wxS_WEIGHT 1
-#define wxV_WEIGHT 2
+#endif // wxUSE_GUI
-typedef struct wx_hsv {
- int h,s,v;
- } wxHSV;
-
-#define wxMax3(x,y,z) ((x > y) ? ((x > z) ? x : z) : ((y > z) ? y : z))
-#define wxMin3(x,y,z) ((x < y) ? ((x < z) ? x : z) : ((y < z) ? y : z))
+// ----------------------------------------------------------------------------
+// wxYield(): these functions are obsolete, please use wxApp methods instead!
+// ----------------------------------------------------------------------------
-#define wxMax2(x,y) ((x > y) ? x : y)
-#define wxMin2(x,y) ((x < y) ? x : y)
+// Yield to other apps/messages
+WXDLLIMPEXP_BASE bool wxYield();
-void wxHSVToXColor(wxHSV *hsv,XColor *xcolor);
-void wxXColorToHSV(wxHSV *hsv,XColor *xcolor);
-void wxAllocNearestColor(Display *display,Colormap colormap,XColor *xcolor);
-void wxAllocColor(Display *display,Colormap colormap,XColor *xcolor);
+// Like wxYield, but fails silently if the yield is recursive.
+WXDLLIMPEXP_BASE bool wxYieldIfNeeded();
-#endif //__X__
+// ----------------------------------------------------------------------------
+// Error message functions used by wxWidgets (deprecated, use wxLog)
+// ----------------------------------------------------------------------------
#endif
// _WX_UTILSH__
projects / wxWidgets.git / blobdiff