wxHTML classes description is now in alphabetical order

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

diff --git a/include/wx/utils.h b/include/wx/utils.h
index 7a72994f532439015701c60c738419354892cbba..9e964e7a3dbce39918875ea6c4acc536da682a57 100644 (file)
--- a/include/wx/utils.h
+++ b/include/wx/utils.h
@@ -23,11 +23,8 @@
 #include "wx/setup.h"
 #include "wx/object.h"
 #include "wx/list.h"
 #include "wx/setup.h"
 #include "wx/object.h"
 #include "wx/list.h"

-#include "wx/window.h"

 #include "wx/filefn.h"
 
 #include "wx/filefn.h"
 

-#include "wx/ioswrap.h"
-

 #ifdef __X__
     #include <dirent.h>
     #include <unistd.h>
 #ifdef __X__
     #include <dirent.h>
     #include <unistd.h>


@@ -41,9 +38,10 @@
 
 class WXDLLEXPORT wxProcess;
 class WXDLLEXPORT wxFrame;
 
 class WXDLLEXPORT wxProcess;
 class WXDLLEXPORT wxFrame;

+class WXDLLEXPORT wxWindow;

 
 // FIXME should use wxStricmp() instead
 
 // FIXME should use wxStricmp() instead

-#ifdef __GNUWIN32__
+#if defined(__GNUWIN32__)

     #define stricmp strcasecmp
     #define strnicmp strncasecmp
 #endif
     #define stricmp strcasecmp
     #define strnicmp strncasecmp
 #endif


@@ -60,23 +58,23 @@ class WXDLLEXPORT wxFrame;
 // ----------------------------------------------------------------------------
 
 // Useful buffer (FIXME VZ: yeah, that is. To be removed!)
 // ----------------------------------------------------------------------------
 
 // Useful buffer (FIXME VZ: yeah, that is. To be removed!)

-WXDLLEXPORT_DATA(extern char*) wxBuffer;
+WXDLLEXPORT_DATA(extern wxChar*) wxBuffer;

 
 // Make a copy of this string using 'new'
 
 // Make a copy of this string using 'new'

-WXDLLEXPORT char* copystring(const char *s);
+WXDLLEXPORT wxChar* copystring(const wxChar *s);

 
 // Matches string one within string two regardless of case
 
 // Matches string one within string two regardless of case

-WXDLLEXPORT bool StringMatch(char *one, char *two, bool subString = TRUE, bool exact = FALSE);
+WXDLLEXPORT bool StringMatch(wxChar *one, wxChar *two, bool subString = TRUE, bool exact = FALSE);

 
 // A shorter way of using strcmp
 
 // A shorter way of using strcmp

-#define wxStringEq(s1, s2) (s1 && s2 && (strcmp(s1, s2) == 0))
+#define wxStringEq(s1, s2) (s1 && s2 && (wxStrcmp(s1, s2) == 0))

 
 // ----------------------------------------------------------------------------
 // Miscellaneous functions
 // ----------------------------------------------------------------------------
 
 // Sound the bell
 
 // ----------------------------------------------------------------------------
 // Miscellaneous functions
 // ----------------------------------------------------------------------------
 
 // Sound the bell

-WXDLLEXPORT void wxBell(void) ;
+WXDLLEXPORT void wxBell();

 
 // Get OS version
 WXDLLEXPORT int wxGetOsVersion(int *majorVsn= (int *) NULL,int *minorVsn= (int *) NULL) ;
 
 // Get OS version
 WXDLLEXPORT int wxGetOsVersion(int *majorVsn= (int *) NULL,int *minorVsn= (int *) NULL) ;


@@ -84,6 +82,12 @@ WXDLLEXPORT int wxGetOsVersion(int *majorVsn= (int *) NULL,int *minorVsn= (int *
 // Return a string with the current date/time
 WXDLLEXPORT wxString wxNow();
 
 // 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.
+WXDLLEXPORT bool wxSetDetectableAutoRepeat( bool flag );
+

 // ----------------------------------------------------------------------------
 // Window ID management
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Window ID management
 // ----------------------------------------------------------------------------


@@ -103,27 +107,29 @@ WXDLLEXPORT void wxRegisterId(long id);
 // Return the current ID
 WXDLLEXPORT long wxGetCurrentId();
 
 // Return the current ID
 WXDLLEXPORT long wxGetCurrentId();
 

+#endif // wxUSE_GUI
+

 // ----------------------------------------------------------------------------
 // Various conversions
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // Various conversions
 // ----------------------------------------------------------------------------
 

-WXDLLEXPORT_DATA(extern const char*) wxFloatToStringStr;
-WXDLLEXPORT_DATA(extern const char*) wxDoubleToStringStr;
+WXDLLEXPORT_DATA(extern const wxChar*) wxFloatToStringStr;
+WXDLLEXPORT_DATA(extern const wxChar*) wxDoubleToStringStr;

 
 

-WXDLLEXPORT void StringToFloat(char *s, float *number);
-WXDLLEXPORT char* FloatToString(float number, const char *fmt = wxFloatToStringStr);
-WXDLLEXPORT void StringToDouble(char *s, double *number);
-WXDLLEXPORT char* DoubleToString(double number, const char *fmt = wxDoubleToStringStr);
-WXDLLEXPORT void StringToInt(char *s, int *number);
-WXDLLEXPORT void StringToLong(char *s, long *number);
-WXDLLEXPORT char* IntToString(int number);
-WXDLLEXPORT char* LongToString(long number);
+WXDLLEXPORT void StringToFloat(wxChar *s, float *number);
+WXDLLEXPORT wxChar* FloatToString(float number, const wxChar *fmt = wxFloatToStringStr);
+WXDLLEXPORT void StringToDouble(wxChar *s, double *number);
+WXDLLEXPORT wxChar* DoubleToString(double number, const wxChar *fmt = wxDoubleToStringStr);
+WXDLLEXPORT void StringToInt(wxChar *s, int *number);
+WXDLLEXPORT void StringToLong(wxChar *s, long *number);
+WXDLLEXPORT wxChar* IntToString(int number);
+WXDLLEXPORT wxChar* LongToString(long number);

 
 // Convert 2-digit hex number to decimal
 WXDLLEXPORT int wxHexToDec(const wxString& buf);
 
 // Convert decimal integer to 2-character hex string
 
 // Convert 2-digit hex number to decimal
 WXDLLEXPORT int wxHexToDec(const wxString& buf);
 
 // Convert decimal integer to 2-character hex string

-WXDLLEXPORT void wxDecToHex(int dec, char *buf);
+WXDLLEXPORT void wxDecToHex(int dec, wxChar *buf);

 WXDLLEXPORT wxString wxDecToHex(int dec);
 
 // ----------------------------------------------------------------------------
 WXDLLEXPORT wxString wxDecToHex(int dec);
 
 // ----------------------------------------------------------------------------


@@ -131,7 +137,7 @@ WXDLLEXPORT wxString wxDecToHex(int dec);
 // ----------------------------------------------------------------------------
 
 // Execute another program. Returns 0 if there was an error, a PID otherwise.
 // ----------------------------------------------------------------------------
 
 // Execute another program. Returns 0 if there was an error, a PID otherwise.

-WXDLLEXPORT long wxExecute(char **argv, bool sync = FALSE,
+WXDLLEXPORT long wxExecute(wxChar **argv, bool sync = FALSE,

                            wxProcess *process = (wxProcess *) NULL);
 WXDLLEXPORT long wxExecute(const wxString& command, bool sync = FALSE,
                            wxProcess *process = (wxProcess *) NULL);
                            wxProcess *process = (wxProcess *) NULL);
 WXDLLEXPORT long wxExecute(const wxString& command, bool sync = FALSE,
                            wxProcess *process = (wxProcess *) NULL);


@@ -182,36 +188,43 @@ WXDLLEXPORT long wxGetFreeMemory();
 // NB: "char *" functions are deprecated, use wxString ones!
 
 // Get eMail address
 // NB: "char *" functions are deprecated, use wxString ones!
 
 // Get eMail address

-WXDLLEXPORT bool wxGetEmailAddress(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetEmailAddress(wxChar *buf, int maxSize);

 WXDLLEXPORT wxString wxGetEmailAddress();
 
 // Get hostname.
 WXDLLEXPORT wxString wxGetEmailAddress();
 
 // Get hostname.

-WXDLLEXPORT bool wxGetHostName(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetHostName(wxChar *buf, int maxSize);

 WXDLLEXPORT wxString wxGetHostName();
 
 // Get FQDN
 WXDLLEXPORT wxString wxGetFullHostName();
 WXDLLEXPORT wxString wxGetHostName();
 
 // Get FQDN
 WXDLLEXPORT wxString wxGetFullHostName();

+WXDLLEXPORT bool wxGetFullHostName(wxChar *buf, int maxSize);

 
 // Get user ID e.g. jacs (this is known as login name under Unix)
 
 // Get user ID e.g. jacs (this is known as login name under Unix)

-WXDLLEXPORT bool wxGetUserId(char *buf, int maxSize);
+WXDLLEXPORT bool wxGetUserId(wxChar *buf, int maxSize);

 WXDLLEXPORT wxString wxGetUserId();
 
 // Get user name e.g. Julian Smart
 WXDLLEXPORT wxString wxGetUserId();
 
 // Get user name e.g. Julian Smart

-WXDLLEXPORT bool wxGetUserName(char *buf, int maxSize);
+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 const char* wxGetHomeDir(wxString *pstr);
+WXDLLEXPORT const wxChar* wxGetHomeDir(wxString *pstr);

 
 // Get the user's home dir (caller must copy --- volatile)
 // returns NULL is no HOME dir is known
 
 // Get the user's home dir (caller must copy --- volatile)
 // returns NULL is no HOME dir is known

-WXDLLEXPORT char* wxGetUserHome(const wxString& user = wxEmptyString);
+#if defined(__UNIX__) && wxUSE_UNICODE
+WXDLLEXPORT const wxMB2WXbuf wxGetUserHome(const wxString& user = wxEmptyString);
+#else
+WXDLLEXPORT wxChar* wxGetUserHome(const wxString& user = wxEmptyString);
+#endif
+
+#if wxUSE_GUI // GUI only things from now on

 
 // ----------------------------------------------------------------------------
 // Strip out any menu codes
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // Strip out any menu codes
 // ----------------------------------------------------------------------------
 

-WXDLLEXPORT char* wxStripMenuCodes(char *in, char *out = (char *) NULL);
+WXDLLEXPORT wxChar* wxStripMenuCodes(wxChar *in, wxChar *out = (wxChar *) NULL);

 WXDLLEXPORT wxString wxStripMenuCodes(const wxString& str);
 
 // ----------------------------------------------------------------------------
 WXDLLEXPORT wxString wxStripMenuCodes(const wxString& str);
 
 // ----------------------------------------------------------------------------


@@ -239,6 +252,9 @@ WXDLLEXPORT bool wxYield();
 // Yield to other apps/messages and disable user input
 WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL);
 
 // Yield to other apps/messages and disable user input
 WXDLLEXPORT bool wxSafeYield(wxWindow *win = NULL);
 

+// Enable or disable input to all top level windows
+WXDLLEXPORT void wxEnableTopLevelWindows(bool enable = TRUE);
+

 // Check whether this window wants to process messages, e.g. Stop button
 // in long calculations.
 WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd);
 // Check whether this window wants to process messages, e.g. Stop button
 // in long calculations.
 WXDLLEXPORT bool wxCheckForInterrupt(wxWindow *wnd);


@@ -277,14 +293,14 @@ public:
 
 // Format a message on the standard error (UNIX) or the debugging
 // stream (Windows)
 
 // Format a message on the standard error (UNIX) or the debugging
 // stream (Windows)

-WXDLLEXPORT void wxDebugMsg(const char *fmt ...) ;
+WXDLLEXPORT void wxDebugMsg(const wxChar *fmt ...) ;

 
 // Non-fatal error (continues)
 
 // Non-fatal error (continues)

-WXDLLEXPORT_DATA(extern const char*) wxInternalErrorStr;
+WXDLLEXPORT_DATA(extern const wxChar*) wxInternalErrorStr;

 WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
 
 // Fatal error (exits)
 WXDLLEXPORT void wxError(const wxString& msg, const wxString& title = wxInternalErrorStr);
 
 // Fatal error (exits)

-WXDLLEXPORT_DATA(extern const char*) wxFatalErrorStr;
+WXDLLEXPORT_DATA(extern const wxChar*) wxFatalErrorStr;

 WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
 
 // ----------------------------------------------------------------------------
 WXDLLEXPORT void wxFatalError(const wxString& msg, const wxString& title = wxFatalErrorStr);
 
 // ----------------------------------------------------------------------------


@@ -297,7 +313,7 @@ WXDLLEXPORT bool wxWriteResource(const wxString& section, const wxString& entry,
 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 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, char **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);
 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);


@@ -308,8 +324,8 @@ 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__
 // 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 char* wxUserResourceStr;
-WXDLLEXPORT char* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr);
+WXDLLEXPORT extern const wxChar* wxUserResourceStr;
+WXDLLEXPORT wxChar* wxLoadUserResource(const wxString& resourceName, const wxString& resourceType = wxUserResourceStr);

 
 // Implemented in utils.cpp: VC++, Win95 only. Sets up a console for standard
 // input/output
 
 // Implemented in utils.cpp: VC++, Win95 only. Sets up a console for standard
 // input/output


@@ -352,5 +368,32 @@ void wxAllocColor(Display *display,Colormap colormap,XColor *xcolor);
 
 #endif //__X__
 
 
 #endif //__X__
 

+// ----------------------------------------------------------------------------
+// font-related functions (X and GTK)
+// ----------------------------------------------------------------------------
+
+#if defined(__X__) || defined(__WXGTK__)
+
+#ifdef __X__
+    typedef XFontStruct *wxNativeFont;
+#else // GDK
+    typedef GdkFont *wxNativeFont;
+#endif
+
+#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);
+
+#endif // X || GTK
+
+#endif // wxUSE_GUI
+

 #endif
     // _WX_UTILSH__
 #endif
     // _WX_UTILSH__