cleanup - fixed warnings, reformatting

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

diff --git a/include/wx/setup_inc.h b/include/wx/setup_inc.h
index 8fee39b65117afeaeadacb992eecb175d6ffcb5e..500493b6b672df735428d1398ed3989cc199fe35 100644 (file)
--- a/include/wx/setup_inc.h
+++ b/include/wx/setup_inc.h
@@ -1,3 +1,13 @@
+///////////////////////////////////////////////////////////////////////////////
+// Name:        wx/setup_inc.h
+// Purpose:     setup.h settings
+// Author:      Vadim Zeitlin
+// Modified by:
+// Created:
+// RCS-ID:      $Id$
+// Copyright:   (c) Vadim Zeitlin
+// Licence:     wxWindows licence
+///////////////////////////////////////////////////////////////////////////////

 
 // ----------------------------------------------------------------------------
 // global settings
 
 // ----------------------------------------------------------------------------
 // global settings


@@ -13,15 +23,15 @@
 // compatibility settings
 // ----------------------------------------------------------------------------
 
 // compatibility settings
 // ----------------------------------------------------------------------------
 

-// This setting determines the compatibility with 2.2 API: set it to 1 to
+// This setting determines the compatibility with 2.4 API: set it to 1 to

 // enable it but please consider updating your code instead.
 //
 // Default is 0
 //
 // Recommended setting: 0 (please update your code)
 // enable it but please consider updating your code instead.
 //
 // Default is 0
 //
 // Recommended setting: 0 (please update your code)

-#define WXWIN_COMPATIBILITY_2_2 0
+#define WXWIN_COMPATIBILITY_2_4 0

 
 

-// This setting determines the compatibility with 2.4 API: set it to 0 to
+// This setting determines the compatibility with 2.6 API: set it to 0 to

 // flag all cases of using deprecated functions.
 //
 // Default is 1 but please try building your code with 0 as the default will
 // flag all cases of using deprecated functions.
 //
 // Default is 1 but please try building your code with 0 as the default will


@@ -29,15 +39,16 @@
 // in the version after it completely.
 //
 // Recommended setting: 0 (please update your code)
 // in the version after it completely.
 //
 // Recommended setting: 0 (please update your code)

-#define WXWIN_COMPATIBILITY_2_4 1
+#define WXWIN_COMPATIBILITY_2_6 1

 
 

-// Set to 0 for accurate dialog units, else 1 to be as per 2.1.16 and before.
-// If migrating between versions, your dialogs may seem to shrink.
+// MSW-only: Set to 0 for accurate dialog units, else 1 for old behaviour when
+// default system font is used for wxWindow::GetCharWidth/Height() instead of
+// the current font.

 //
 //

-// Default is 1
+// Default is 0

 //
 //

-// Recommended setting: 0 (the new calculations are more correct!)
-#define wxDIALOG_UNIT_COMPATIBILITY   1
+// Recommended setting: 0
+#define wxDIALOG_UNIT_COMPATIBILITY   0

 
 // ----------------------------------------------------------------------------
 // debugging settings
 
 // ----------------------------------------------------------------------------
 // debugging settings


@@ -105,12 +116,26 @@
 // Default is 1
 //
 // Recommended setting: 1 if your compiler supports it.
 // Default is 1
 //
 // Recommended setting: 1 if your compiler supports it.

-#if defined(_MSC_VER) || \
-    (defined(__BORLANDC__) && __BORLANDC__ >= 0x0550)
-    #define wxUSE_ON_FATAL_EXCEPTION 1
-#else
-    #define wxUSE_ON_FATAL_EXCEPTION 0
-#endif
+#define wxUSE_ON_FATAL_EXCEPTION 1
+
+// Set this to 1 to be able to generate a human-readable (unlike
+// machine-readable minidump created by wxCrashReport::Generate()) stack back
+// trace when your program crashes using wxStackWalker
+//
+// Default is 1 if supported by the compiler.
+//
+// Recommended setting: 1, set to 0 if your programs never crash
+#define wxUSE_STACKWALKER 1
+
+// Set this to 1 to compile in wxDebugReport class which allows you to create
+// and optionally upload to your web site a debug report consisting of back
+// trace of the crash (if wxUSE_STACKWALKER == 1) and other information.
+//
+// Default is 1 if supported by the compiler.
+//
+// Recommended setting: 1, it is compiled into a separate library so there
+//                         is no overhead if you don't use it
+#define wxUSE_DEBUGREPORT 1

 
 // ----------------------------------------------------------------------------
 // Unicode support
 
 // ----------------------------------------------------------------------------
 // Unicode support


@@ -131,22 +156,6 @@
     #define wxUSE_UNICODE 0
 #endif
 
     #define wxUSE_UNICODE 0
 #endif
 

-// Set wxUSE_UNICODE_MSLU to 1 if you want to compile wxWidgets in Unicode mode
-// and be able to run compiled apps under Windows 9x as well as NT/2000/XP.
-// This setting enables use of unicows.dll from MSLU (MS Layer for Unicode, see
-// http://www.microsoft.com/globaldev/handson/dev/mslu_announce.mspx). Note
-// that you will have to modify the makefiles to include unicows.lib import
-// library as the first library (see installation instructions in install.txt
-// to learn how to do it when building the library or samples).
-//
-// If your compiler doesn't have unicows.lib, you can get a version of it at
-// http://libunicows.sourceforge.net
-//
-// Default is 0
-//
-// Recommended setting: 0 (1 if you want to deploy Unicode apps on 9x systems)
-#define wxUSE_UNICODE_MSLU 0
-

 // 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
 // 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


@@ -168,6 +177,9 @@
 // code will lead to undefined behaviour -- but the code itself will be
 // slightly smaller and faster.
 //
 // code will lead to undefined behaviour -- but the code itself will be
 // slightly smaller and faster.
 //

+// Note that like wxUSE_THREADS this option is automatically set to 0 if
+// wxNO_EXCEPTIONS is defined.
+//

 // Default is 1
 //
 // Recommended setting: depends on whether you intend to use C++ exceptions
 // Default is 1
 //
 // Recommended setting: depends on whether you intend to use C++ exceptions


@@ -178,14 +190,9 @@
 //
 // Default is 0
 //
 //
 // Default is 0
 //

-// Recommended setting: 0
+// Recommended setting: 0 (this is still work in progress...)

 #define wxUSE_EXTENDED_RTTI 0
 
 #define wxUSE_EXTENDED_RTTI 0
 

-#if defined(__BORLANDC__)
-#undef wxUSE_EXTENDED_RTTI
-#define wxUSE_EXTENDED_RTTI 1
-#endif
-

 // Set wxUSE_STL to 1 to derive wxList(Foo) and wxArray(Foo) from
 // std::list<Foo*> and std::vector<Foo*>, with a compatibility interface,
 // and for wxHashMap to be implemented with templates.
 // Set wxUSE_STL to 1 to derive wxList(Foo) and wxArray(Foo) from
 // std::list<Foo*> and std::vector<Foo*>, with a compatibility interface,
 // and for wxHashMap to be implemented with templates.


@@ -226,19 +233,43 @@
 // library without it if you have no use for it - this will result in a
 // somewhat smaller and faster operation.
 //
 // library without it if you have no use for it - this will result in a
 // somewhat smaller and faster operation.
 //

-// This is ignored under Win16, threads are only supported under Win32.
+// Notice that if wxNO_THREADS is defined, wxUSE_THREADS is automatically reset
+// to 0 in wx/chkconf.h, so, for example, if you set USE_THREADS to 0 in
+// build/msw/config.* file this value will have no effect.

 //
 // Default is 1
 //
 // Recommended setting: 0 unless you do plan to develop MT applications
 #define wxUSE_THREADS 1
 
 //
 // Default is 1
 //
 // Recommended setting: 0 unless you do plan to develop MT applications
 #define wxUSE_THREADS 1
 

-// If enabled (1), compiles wxWidgets streams classes
+// If enabled, compiles wxWidgets streams classes
+//
+// wx stream classes are used for image IO, process IO redirection, network
+// protocols implementation and much more and so disabling this results in a
+// lot of other functionality being lost.
+//
+// Default is 1
+//
+// Recommended setting: 1 as setting it to 0 disables many other things

 #define wxUSE_STREAMS       1
 
 #define wxUSE_STREAMS       1
 

-// Use standard C++ streams if 1. If 0, use wxWin streams implementation.
+// 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.
+//
+// Notice that enabling this does not replace wx streams with std streams
+// everywhere, in a lot of places wx streams are used no matter what.
+//
+// Default is 0
+//
+// 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  0
 

+// Enable conversion to standard C++ string if 1.
+#define wxUSE_STD_STRING  0
+

 // ----------------------------------------------------------------------------
 // non GUI features selection
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // non GUI features selection
 // ----------------------------------------------------------------------------


@@ -273,6 +304,14 @@
 // Recommended setting: 1 (but may be safely disabled if you don't use it)
 #define wxUSE_FSVOLUME      1
 
 // Recommended setting: 1 (but may be safely disabled if you don't use it)
 #define wxUSE_FSVOLUME      1
 

+// Use wxStandardPaths class which allows to retrieve some standard locations
+// in the file system
+//
+// Default is 1
+//
+// Recommended setting: 1 (may be disabled to save space, but not much)
+#define wxUSE_STDPATHS      1
+

 // use wxTextBuffer class: required by wxTextFile
 #define wxUSE_TEXTBUFFER    1
 
 // use wxTextBuffer class: required by wxTextFile
 #define wxUSE_TEXTBUFFER    1
 


@@ -371,6 +410,9 @@
 // Set to 1 to enable virtual Internet filesystem (requires wxUSE_FILESYSTEM)
 #define wxUSE_FS_INET       1
 
 // Set to 1 to enable virtual Internet filesystem (requires wxUSE_FILESYSTEM)
 #define wxUSE_FS_INET       1
 

+// wxArchive classes for accessing archives such as zip and tar
+#define wxUSE_ARCHIVE_STREAMS     1
+

 // Set to 1 to compile wxZipInput/OutputStream classes.
 #define wxUSE_ZIPSTREAM     1
 
 // Set to 1 to compile wxZipInput/OutputStream classes.
 #define wxUSE_ZIPSTREAM     1
 


@@ -445,19 +487,12 @@
 // Recommended setting: 1 
 #define wxUSE_MEDIACTRL     1
 
 // Recommended setting: 1 
 #define wxUSE_MEDIACTRL     1
 

-// Use QuickTime
-//
-// Default is 0
-//
-// Recommended setting: 1 if you have the QT SDK installed and you need it, else 0
-#define wxUSE_QUICKTIME     0
-
-// Use DirectShow (requires linkage to strmiids.lib)
+// Use GStreamer for Unix (req a lot of dependancies)

 //
 // Default is 0
 //
 //
 // Default is 0
 //

-// Recommended setting: 1 if the DirectX 7 SDK is installed (highly recommended), else 0
-#define wxUSE_DIRECTSHOW    0
+// Recommended setting: 1 (wxMediaCtrl won't work by default without it)
+#define wxUSE_GSTREAMER    0

 
 // Use wxWidget's XRC XML-based resource system.  Recommended.
 //
 
 // Use wxWidget's XRC XML-based resource system.  Recommended.
 //


@@ -552,7 +587,7 @@
 // or the wrapper around native control. For native look and feel the native
 // version should be used.
 //
 // or the wrapper around native control. For native look and feel the native
 // version should be used.
 //

-// Default is 1.
+// Default is 1 for the platforms where native status bar is supported.

 //
 // Recommended setting: 1 (there is no advantage in using the generic one)
 #define wxUSE_NATIVE_STATUSBAR        1
 //
 // Recommended setting: 1 (there is no advantage in using the generic one)
 #define wxUSE_NATIVE_STATUSBAR        1


@@ -593,6 +628,22 @@
 // Recommended setting: 1
 #define wxUSE_CHOICEBOOK 1
 
 // Recommended setting: 1
 #define wxUSE_CHOICEBOOK 1
 

+// wxTreebook control is similar to wxNotebook but uses wxTreeCtrl instead of
+// the tabs
+//
+// Default is 1.
+//
+// Recommended setting: 1
+#define wxUSE_TREEBOOK 1
+
+// wxToolbook control is similar to wxNotebook but uses wxToolBar instead of
+// tabs
+//
+// Default is 1.
+//
+// Recommended setting: 1
+#define wxUSE_TOOLBOOK 1
+

 // wxTabDialog is a generic version of wxNotebook but it is incompatible with
 // the new class. It shouldn't be used in new code.
 //
 // wxTabDialog is a generic version of wxNotebook but it is incompatible with
 // the new class. It shouldn't be used in new code.
 //


@@ -603,12 +654,20 @@
 
 // wxGrid class
 //
 
 // wxGrid class
 //

-// Default is 1 for both options.
+// Default is 1, set to 0 to cut down compilation time and binaries size if you
+// don't use it.

 //
 // Recommended setting: 1
 //
 #define wxUSE_GRID         1
 
 //
 // Recommended setting: 1
 //
 #define wxUSE_GRID         1
 

+// wxMiniFrame class: a frame with narrow title bar
+//
+// Default is 1.
+//
+// Recommended setting: 1 (it doesn't cost almost anything)
+#define wxUSE_MINIFRAME 1
+

 // ----------------------------------------------------------------------------
 // Miscellaneous GUI stuff
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Miscellaneous GUI stuff
 // ----------------------------------------------------------------------------


@@ -825,6 +884,14 @@
 // Recommended setting: 1 if you intend to use OpenGL, 0 otherwise
 #define wxUSE_GLCANVAS       0
 
 // Recommended setting: 1 if you intend to use OpenGL, 0 otherwise
 #define wxUSE_GLCANVAS       0
 

+// wxRichTextCtrl allows editing of styled text.
+//
+// Default is 1.
+//
+// Recommended setting: 1, set to 0 if you want compile a
+// smaller library.
+#define wxUSE_RICHTEXT       1
+

 // ----------------------------------------------------------------------------
 // Data transfer
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Data transfer
 // ----------------------------------------------------------------------------


@@ -886,7 +953,7 @@
 // Use wxHTML-based help controller?
 #define wxUSE_WXHTML_HELP 1
 
 // Use wxHTML-based help controller?
 #define wxUSE_WXHTML_HELP 1
 

-#define wxUSE_RESOURCES   1
+#define wxUSE_RESOURCES   0

                                 // 0 for no wxGetResource/wxWriteResource
 #define wxUSE_CONSTRAINTS 1
                                 // 0 for no window layout constraint system
                                 // 0 for no wxGetResource/wxWriteResource
 #define wxUSE_CONSTRAINTS 1
                                 // 0 for no window layout constraint system


@@ -907,10 +974,6 @@
 // Set to 1 to use font metric files in GetTextExtent
 #define wxUSE_AFM_FOR_POSTSCRIPT 1
 
 // Set to 1 to use font metric files in GetTextExtent
 #define wxUSE_AFM_FOR_POSTSCRIPT 1
 

-// Set to 0 to disable PostScript print/preview architecture code under Windows
-// (just use Windows printing).
-#define wxUSE_POSTSCRIPT_ARCHITECTURE_IN_MSW 1
-

 // ----------------------------------------------------------------------------
 // database classes
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // database classes
 // ----------------------------------------------------------------------------


@@ -928,7 +991,7 @@
 #define wxODBC_FWD_ONLY_CURSORS         1
 
 // Default is 0.  Set to 1 to use the deprecated classes, enum types, function,
 #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 compatability with the
+// 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.
 // 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.