Minor corrections to make dist after reports

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

diff --git a/include/wx/setup_inc.h b/include/wx/setup_inc.h
index 79e636098e02f56c5ddfd9f0a53b0ee80af8b1cb..628d5e0096547cdd0bf02eb9acbde9d0b56f26a2 100644 (file)
--- a/include/wx/setup_inc.h
+++ b/include/wx/setup_inc.h
@@ -143,29 +143,15 @@
 // Unicode support
 // ----------------------------------------------------------------------------
 
 // Unicode support
 // ----------------------------------------------------------------------------
 

-// Set wxUSE_UNICODE to 1 to compile wxWidgets in Unicode mode: wxChar will be
-// defined as wchar_t, wxString will use Unicode internally. If you set this
-// to 1, you must use wxT() macro for all literal strings in the program.
-//
-// Unicode is currently only fully supported under Windows NT/2000/XP
-// (Windows 9x doesn't support it and the programs compiled in Unicode mode
-// will not run under 9x -- but see wxUSE_UNICODE_MSLU below).
-//
-// Default is 0 (but only because of makefiles)
-//
-// Recommended setting: 1
+// These settings are obsolete: the library is always built in Unicode mode
+// now, only set wxUSE_UNICODE to 0 to compile legacy code in ANSI mode if
+// absolutely necessary -- updating it is strongly recommended as the ANSI mode
+// will disappear completely in future wxWidgets releases.

 #ifndef wxUSE_UNICODE
 #ifndef wxUSE_UNICODE

-    #define wxUSE_UNICODE 0
+    #define wxUSE_UNICODE 1

 #endif
 
 #endif
 

-// Setting wxUSE_WCHAR_T to 1 gives you some degree of Unicode support without
-// compiling the program in Unicode mode. More precisely, it will be possible
-// to construct wxString from a wide (Unicode) string and convert any wxString
-// to Unicode.
-//
-// Default is 1
-//
-// Recommended setting: 1
+// wxUSE_WCHAR_T is required by wxWidgets now, don't change.

 #define wxUSE_WCHAR_T 1
 
 // ----------------------------------------------------------------------------
 #define wxUSE_WCHAR_T 1
 
 // ----------------------------------------------------------------------------


@@ -255,6 +241,22 @@
 // Recommended setting: 1 as setting it to 0 disables many other things
 #define wxUSE_STREAMS       1
 
 // Recommended setting: 1 as setting it to 0 disables many other things
 #define wxUSE_STREAMS       1
 

+// This is not a real option but is used as the default value for
+// wxUSE_STD_IOSTREAM and wxUSE_STD_STRING.
+//
+// Currently the Digital Mars and Watcom compilers come without standard C++
+// library headers by default, wxUSE_STD_STRING can be set to 1 if you do have
+// them (e.g. from STLPort).
+//
+// VC++ 5.0 does include standard C++ library headers, however they produce
+// many warnings that can't be turned off when compiled at warning level 4.
+#if defined(__DMC__) || defined(__WATCOMC__) \
+        || (defined(_MSC_VER) && _MSC_VER < 1200)
+    #define wxUSE_STD_DEFAULT  0
+#else
+    #define wxUSE_STD_DEFAULT  1
+#endif
+

 // Use standard C++ streams if 1 instead of wx streams in some places. If
 // disabled (default), wx streams are used everywhere and wxWidgets doesn't
 // depend on the standard streams library.
 // Use standard C++ streams if 1 instead of wx streams in some places. If
 // disabled (default), wx streams are used everywhere and wxWidgets doesn't
 // depend on the standard streams library.


@@ -267,24 +269,15 @@
 // Recommended setting: 1 if you use the standard streams anyhow and so
 //                      dependency on the standard streams library is not a
 //                      problem
 // Recommended setting: 1 if you use the standard streams anyhow and so
 //                      dependency on the standard streams library is not a
 //                      problem

-#define wxUSE_STD_IOSTREAM  0
+#define wxUSE_STD_IOSTREAM  wxUSE_STD_DEFAULT

 
 // Enable conversion to standard C++ string if 1.
 //
 // Default is 1 for most compilers.
 //
 
 // Enable conversion to standard C++ string if 1.
 //
 // Default is 1 for most compilers.
 //

-// Currently the Digital Mars and Watcom compilers come without standard C++
-// library headers by default, wxUSE_STD_STRING can be set to 1 if you do have
-// them (e.g. from STLPort).
-//
-// VC++ 5.0 does include standard C++ library header, however they produce
-// many warnings that can't be turned off when compiled at warning level 4.
-#if defined(__DMC__) || defined(__WATCOMC__) \
-        || (defined(_MSC_VER) && _MSC_VER < 1200)
-    #define wxUSE_STD_STRING  0
-#else
-    #define wxUSE_STD_STRING  1
-#endif
+// Recommended setting: 1 unless you want to ensure your program doesn't use
+//                      the standard C++ library at all.
+#define wxUSE_STD_STRING  wxUSE_STD_DEFAULT

 
 // Support for positional parameters (e.g. %1$d, %2$s ...) in wxVsnprintf.
 // Note that if the system's implementation does not support positional
 
 // Support for positional parameters (e.g. %1$d, %2$s ...) in wxVsnprintf.
 // Note that if the system's implementation does not support positional


@@ -371,6 +364,21 @@
 // i18n support: _() macro, wxLocale class. Requires wxTextFile.
 #define wxUSE_INTL          1
 
 // i18n support: _() macro, wxLocale class. Requires wxTextFile.
 #define wxUSE_INTL          1
 

+// Provide wxFoo_l() functions similar to standard foo() functions but taking
+// an extra locale parameter.
+//
+// Notice that this is fully implemented only for the systems providing POSIX
+// xlocale support or Microsoft Visual C++ >= 8 (which provides proprietary
+// almost-equivalent of xlocale functions), otherwise wxFoo_l() functions will
+// only work for the current user locale and "C" locale. You can use
+// wxHAS_XLOCALE_SUPPORT to test whether the full support is available.
+//
+// Default is 1
+//
+// Recommended setting: 1 but may be disabled if you are writing programs
+// running only in C locale anyhow
+#define wxUSE_XLOCALE       1
+

 // Set wxUSE_DATETIME to 1 to compile the wxDateTime and related classes which
 // allow to manipulate dates, times and time intervals. wxDateTime replaces the
 // old wxTime and wxDate classes which are still provided for backwards
 // Set wxUSE_DATETIME to 1 to compile the wxDateTime and related classes which
 // allow to manipulate dates, times and time intervals. wxDateTime replaces the
 // old wxTime and wxDate classes which are still provided for backwards


@@ -450,6 +458,17 @@
 // Set to 1 to use socket classes
 #define wxUSE_SOCKETS       1
 
 // Set to 1 to use socket classes
 #define wxUSE_SOCKETS       1
 

+// Set to 1 to use ipv6 socket classes (requires wxUSE_SOCKETS)
+//
+// Notice that currently setting this option under Windows will result in
+// programs which can only run on recent OS versions (with ws2_32.dll
+// installed) which is why it is disabled by default.
+//
+// Default is 1.
+//
+// Recommended setting: 1 if you need IPv6 support
+#define wxUSE_IPV6          0
+

 // Set to 1 to enable virtual file systems (required by wxHTML)
 #define wxUSE_FILESYSTEM    1
 
 // Set to 1 to enable virtual file systems (required by wxHTML)
 #define wxUSE_FILESYSTEM    1
 


@@ -554,9 +573,10 @@
 // Recommended setting: 1
 #define wxUSE_MEDIACTRL     1
 
 // Recommended setting: 1
 #define wxUSE_MEDIACTRL     1
 

-// Use GStreamer for Unix (req a lot of dependancies)
+// Use GStreamer for Unix.

 //
 //

-// Default is 0
+// Default is 0 as this requires a lot of dependencies which might not be
+// available.

 //
 // Recommended setting: 1 (wxMediaCtrl won't work by default without it)
 #define wxUSE_GSTREAMER    0
 //
 // Recommended setting: 1 (wxMediaCtrl won't work by default without it)
 #define wxUSE_GSTREAMER    0


@@ -656,6 +676,7 @@
 #define wxUSE_DATEPICKCTRL  1   // wxDatePickerCtrl
 #define wxUSE_DIRPICKERCTRL 1   // wxDirPickerCtrl
 #define wxUSE_EDITABLELISTBOX 1 // wxEditableListBox
 #define wxUSE_DATEPICKCTRL  1   // wxDatePickerCtrl
 #define wxUSE_DIRPICKERCTRL 1   // wxDirPickerCtrl
 #define wxUSE_EDITABLELISTBOX 1 // wxEditableListBox

+#define wxUSE_FILECTRL      1   // wxFileCtrl

 #define wxUSE_FILEPICKERCTRL 1  // wxFilePickerCtrl
 #define wxUSE_FONTPICKERCTRL 1  // wxFontPickerCtrl
 #define wxUSE_GAUGE         1   // wxGauge
 #define wxUSE_FILEPICKERCTRL 1  // wxFilePickerCtrl
 #define wxUSE_FONTPICKERCTRL 1  // wxFontPickerCtrl
 #define wxUSE_GAUGE         1   // wxGauge


@@ -849,6 +870,17 @@
 // Recommended setting: 1 (can't be disabled under MSW)
 #define wxUSE_MENUS         1
 
 // Recommended setting: 1 (can't be disabled under MSW)
 #define wxUSE_MENUS         1
 

+// Use wxNotificationMessage.
+//
+// wxNotificationMessage allows to show non-intrusive messages to the user
+// using balloons, banners, popups or whatever is the appropriate method for
+// the current platform.
+//
+// Default is 1.
+//
+// Recommended setting: 1
+#define wxUSE_NOTIFICATION_MESSAGE 1
+

 // Use wxSashWindow class.
 //
 // Default is 1.
 // Use wxSashWindow class.
 //
 // Default is 1.


@@ -873,6 +905,20 @@
 // wxValidator class and related methods
 #define wxUSE_VALIDATORS 1
 
 // wxValidator class and related methods
 #define wxUSE_VALIDATORS 1
 

+// Use reference counted ID management: this means that wxWidgets will track
+// the automatically allocated ids (those used when you use wxID_ANY when
+// creating a window, menu or toolbar item &c) instead of just supposing that
+// the program never runs out of them. This is mostly useful only under wxMSW
+// where the total ids range is limited to SHRT_MIN..SHRT_MAX and where
+// long-running programs can run into problems with ids reuse without this. On
+// the other platforms, where the ids have the full int range, this shouldn't
+// be necessary.
+#ifdef __WXMSW__
+#define wxUSE_AUTOID_MANAGEMENT 1
+#else
+#define wxUSE_AUTOID_MANAGEMENT 0
+#endif
+

 // ----------------------------------------------------------------------------
 // common dialogs
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // common dialogs
 // ----------------------------------------------------------------------------


@@ -1077,7 +1123,7 @@
 // ----------------------------------------------------------------------------
 
 // wxSingleInstanceChecker class allows to verify at startup if another program
 // ----------------------------------------------------------------------------
 
 // wxSingleInstanceChecker class allows to verify at startup if another program

-// instance is running (it is only available under Win32)
+// instance is running.

 //
 // Default is 1
 //
 //
 // Default is 1
 //


@@ -1125,32 +1171,9 @@
 #define wxUSE_AFM_FOR_POSTSCRIPT 1
 
 // Set to 1 to compile in support for wxSVGFileDC, a wxDC subclass which allows
 #define wxUSE_AFM_FOR_POSTSCRIPT 1
 
 // Set to 1 to compile in support for wxSVGFileDC, a wxDC subclass which allows

-// to create fiels in SVG (Scalable Vector Graphics) format.
+// to create files in SVG (Scalable Vector Graphics) format.

 #define wxUSE_SVG 1
 
 #define wxUSE_SVG 1
 

-// ----------------------------------------------------------------------------
-// database classes
-// ----------------------------------------------------------------------------
-
-// Define 1 to use ODBC classes
-#define wxUSE_ODBC          0
-
-// For backward compatibility reasons, this parameter now only controls the
-// default scrolling method used by cursors.  This default behavior can be
-// overriden by setting the second param of wxDB::wxDbGetConnection() or
-// wxDb() constructor to indicate whether the connection (and any wxDbTable()s
-// that use the connection) should support forward only scrolling of cursors,
-// or both forward and backward support for backward scrolling cursors is
-// dependent on the data source as well as the ODBC driver being used.
-#define wxODBC_FWD_ONLY_CURSORS         1
-
-// Default is 0.  Set to 1 to use the deprecated classes, enum types, function,
-// member variables.  With a setting of 1, full backward compatibility with the
-// 2.0.x release is possible. It is STRONGLY recommended that this be set to 0,
-// as future development will be done only on the non-deprecated
-// functions/classes/member variables/etc.
-#define wxODBC_BACKWARD_COMPATABILITY 0
-

 // ----------------------------------------------------------------------------
 // other compiler (mis)features
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // other compiler (mis)features
 // ----------------------------------------------------------------------------


@@ -1164,14 +1187,15 @@
 #define REMOVE_UNUSED_ARG   1
 
 // VC++ 4.2 and above allows <iostream> and <iostream.h> but you can't mix
 #define REMOVE_UNUSED_ARG   1
 
 // VC++ 4.2 and above allows <iostream> and <iostream.h> but you can't mix

-// them. Set to 1 for <iostream.h>, 0 for <iostream>. Note that VC++ 7.1
-// and later doesn't support wxUSE_IOSTREAMH == 1 and so <iostream> will be
-// used anyhow.
+// them. Set this option to 1 to use <iostream.h>, 0 to use <iostream>.

 //
 //

-// Default is 1.
+// Note that newer compilers (including VC++ 7.1 and later) don't support
+// wxUSE_IOSTREAMH == 1 and so <iostream> will be used anyhow.
+//
+// Default is 0.

 //
 //

-// Recommended setting: whatever your compiler likes more
-#define wxUSE_IOSTREAMH     1
+// Recommended setting: 0, only set to 1 if you use a really old compiler
+#define wxUSE_IOSTREAMH     0

 
 // ----------------------------------------------------------------------------
 // image format support
 
 // ----------------------------------------------------------------------------
 // image format support