Add comment about wxBitmap::SetPalette() not being implemented

[wxWidgets.git] / include / wx / msw / setup0.h

diff --git a/include/wx/msw/setup0.h b/include/wx/msw/setup0.h
index eb65c142e92c50eb28ceb62eecbe45b113755b00..9217ade6daaf15f7ed840551002a1762b6bf16cf 100644 (file)
--- a/include/wx/msw/setup0.h
+++ b/include/wx/msw/setup0.h
@@ -12,6 +12,8 @@
 #ifndef _WX_SETUP_H_
 #define _WX_SETUP_H_
 
 #ifndef _WX_SETUP_H_
 #define _WX_SETUP_H_
 

+/* --- start common options --- */
+

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


@@ -26,24 +28,6 @@
 // compatibility settings
 // ----------------------------------------------------------------------------
 
 // compatibility settings
 // ----------------------------------------------------------------------------
 

-// This setting determines the compatibility with 1.68 API:
-// Level 0: no backward compatibility, all new features
-// Level 1: some extra methods are defined for compatibility.
-//
-// Default is 0.
-//
-// Recommended setting: 0 (in fact the compatibility code is now very minimal
-// so there is little advantage to setting it to 1.
-#define WXWIN_COMPATIBILITY  0
-
-// This setting determines the compatibility with 2.0 API: set it to 1 to
-// enable it
-//
-// Default is 0.
-//
-// Recommended setting: 0 (please update your code instead!)
-#define WXWIN_COMPATIBILITY_2 0
-

 // This setting determines the compatibility with 2.2 API: set it to 1 to
 // enable it but please consider updating your code instead.
 //
 // This setting determines the compatibility with 2.2 API: set it to 1 to
 // enable it but please consider updating your code instead.
 //


@@ -62,14 +46,6 @@
 // Recommended setting: 0 (please update your code)
 #define WXWIN_COMPATIBILITY_2_4 1
 
 // Recommended setting: 0 (please update your code)
 #define WXWIN_COMPATIBILITY_2_4 1
 

-// Define as 1 for font size to be backward compatible to 1.63 and earlier.
-// 1.64 and later define point sizes to be compatible with Windows.
-//
-// Default is 0
-//
-// Recommended setting: 0
-#define wxFONT_SIZE_COMPATIBILITY    0
-

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


@@ -85,7 +61,7 @@
 // Generic comment about debugging settings: they are very useful if you don't
 // use any other memory leak detection tools such as Purify/BoundsChecker, but
 // are probably redundant otherwise. Also, Visual C++ CRT has the same features
 // Generic comment about debugging settings: they are very useful if you don't
 // use any other memory leak detection tools such as Purify/BoundsChecker, but
 // are probably redundant otherwise. Also, Visual C++ CRT has the same features

-// as wxWindows memory debugging subsystem built in since version 5.0 and you
+// as wxWidgets memory debugging subsystem built in since version 5.0 and you

 // may prefer to use it instead of built in memory debugging code because it is
 // faster and more fool proof.
 //
 // may prefer to use it instead of built in memory debugging code because it is
 // faster and more fool proof.
 //


@@ -141,20 +117,25 @@
 // This setting is for Win32 only and can only be enabled if your compiler
 // supports Win32 structured exception handling (currently only VC++ does)
 //
 // This setting is for Win32 only and can only be enabled if your compiler
 // supports Win32 structured exception handling (currently only VC++ does)
 //

-// Default is 1
+// Default is 1 if supported by the compiler (VC++ and recent BC++ only).

 //
 // Recommended setting: 1 if your compiler supports it.
 //
 // Recommended setting: 1 if your compiler supports it.

-#ifdef _MSC_VER
-    #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 minidumop created by wxCrashReport::Generate()) stack back
+// trace when your program crashes using wxStackWalker
+//
+// Default is 1 if supported by the compiler (VC++ and recent BC++ only).
+//
+// Recommended setting: 1, set to 0 if your programs never crash
+#define wxUSE_STACKWALKER 1

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

-// Set wxUSE_UNICODE to 1 to compile wxWindows in Unicode mode: wxChar will be
+// 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.
 //
 // 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.
 //


@@ -169,13 +150,13 @@
     #define wxUSE_UNICODE 0
 #endif
 
     #define wxUSE_UNICODE 0
 #endif
 

-// Set wxUSE_UNICODE_MSLU to 1 if you want to compile wxWindows in Unicode mode
+// 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
 // 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 (if you use MSVC, you can run the makefile with "nmake
-// MSLU=1 UNICODE=1" command).
+// 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
 //
 // If your compiler doesn't have unicows.lib, you can get a version of it at
 // http://libunicows.sourceforge.net


@@ -199,6 +180,26 @@
 // global features
 // ----------------------------------------------------------------------------
 
 // global features
 // ----------------------------------------------------------------------------
 

+// Compile library in exception-safe mode? If set to 1, the library will try to
+// behave correctly in presence of exceptions (even though it still will not
+// use the exceptions itself) and notify the user code about any unhandled
+// exceptions. If set to 0, propagation of the exceptions through the library
+// code will lead to undefined behaviour -- but the code itself will be
+// slightly smaller and faster.
+//
+// Default is 1
+//
+// Recommended setting: depends on whether you intend to use C++ exceptions
+//                      in your own code (1 if you do, 0 if you don't)
+#define wxUSE_EXCEPTIONS    1
+
+// Set wxUSE_EXTENDED_RTTI to 1 to use extended RTTI
+//
+// Default is 0
+//
+// Recommended setting: 0 (this is still work in progress...)
+#define wxUSE_EXTENDED_RTTI 0
+

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


@@ -246,7 +247,7 @@
 // Recommended setting: 0 unless you do plan to develop MT applications
 #define wxUSE_THREADS 1
 
 // Recommended setting: 0 unless you do plan to develop MT applications
 #define wxUSE_THREADS 1
 

-// If enabled (1), compiles wxWindows streams classes
+// If enabled (1), compiles wxWidgets streams classes

 #define wxUSE_STREAMS       1
 
 // Use standard C++ streams if 1. If 0, use wxWin streams implementation.
 #define wxUSE_STREAMS       1
 
 // Use standard C++ streams if 1. If 0, use wxWin streams implementation.


@@ -388,12 +389,12 @@
 #define wxUSE_ZIPSTREAM     1
 
 // Set to 1 to compile wxZlibInput/OutputStream classes. Also required by
 #define wxUSE_ZIPSTREAM     1
 
 // Set to 1 to compile wxZlibInput/OutputStream classes. Also required by

-// wxUSE_LIBPNG.
+// wxUSE_LIBPNG

 #define wxUSE_ZLIB          1
 
 // If enabled, the code written by Apple will be used to write, in a portable
 // way, float on the disk. See extended.c for the license which is different
 #define wxUSE_ZLIB          1
 
 // If enabled, the code written by Apple will be used to write, in a portable
 // way, float on the disk. See extended.c for the license which is different

-// from wxWindows one.
+// from wxWidgets one.

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


@@ -425,6 +426,16 @@
 // Define this to use wxURL class.
 #define wxUSE_URL 1
 
 // Define this to use wxURL class.
 #define wxUSE_URL 1
 

+// Define this to use native platform url and protocol support.
+// Currently valid only for MS-Windows.
+// Note: if you set this to 1, you can open ftp/http/gopher sites
+// and obtain a valid input stream for these sites
+// even when you set wxUSE_PROTOCOL_FTP/HTTP to 0.
+// Doing so reduces the code size.
+//
+// This code is experimental and subject to change.
+#define wxUSE_URL_NATIVE 0
+

 // Support for regular expression matching via wxRegEx class: enable this to
 // use POSIX regular expressions in your code. You need to compile regex
 // library from src/regex to use it under Windows.
 // Support for regular expression matching via wxRegEx class: enable this to
 // use POSIX regular expressions in your code. You need to compile regex
 // library from src/regex to use it under Windows.


@@ -438,16 +449,48 @@
 // wxSystemOptions class
 #define wxUSE_SYSTEM_OPTIONS 1
 
 // wxSystemOptions class
 #define wxUSE_SYSTEM_OPTIONS 1
 

-// wxWave class
-#define wxUSE_WAVE      1
+// wxSound class
+#define wxUSE_SOUND      1
+
+// Use wxMediaCtrl
+//
+// Default is 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)
+//
+// Default is 0
+//
+// Recommended setting: 1 if the DirectX 7 SDK is installed (highly recommended), else 0
+#define wxUSE_DIRECTSHOW    0
+
+// Use wxWidget's XRC XML-based resource system.  Recommended.
+//
+// Default is 1
+//
+// Recommended setting: 1 (requires wxUSE_XML)
+#define wxUSE_XRC       1

 
 // XML parsing classes. Note that their API will change in the future, so
 // using wxXmlDocument and wxXmlNode in your app is not recommended.
 //
 // Default is 1
 //
 
 // XML parsing classes. Note that their API will change in the future, so
 // using wxXmlDocument and wxXmlNode in your app is not recommended.
 //
 // Default is 1
 //

-// Recommended setting: 1 (needed by XRC)
-#define wxUSE_XML       1
+// Recommended setting: 1 (required by XRC)
+#if wxUSE_XRC
+#  define wxUSE_XML       1
+#else
+#  define wxUSE_XML       0
+#endif

 
 // ----------------------------------------------------------------------------
 // Individual GUI controls
 
 // ----------------------------------------------------------------------------
 // Individual GUI controls


@@ -477,7 +520,7 @@
 // Recommended setting: 1 (may be set to 0)
 #define wxUSE_TIPWINDOW    1
 
 // Recommended setting: 1 (may be set to 0)
 #define wxUSE_TIPWINDOW    1
 

-// Each of the settings below corresponds to one wxWindows control. They are
+// Each of the settings below corresponds to one wxWidgets control. They are

 // all switched on by default but may be disabled if you are sure that your
 // program (including any standard dialogs it can show!) doesn't need them and
 // if you desperately want to save some space. If you use any of these you must
 // all switched on by default but may be disabled if you are sure that your
 // program (including any standard dialogs it can show!) doesn't need them and
 // if you desperately want to save some space. If you use any of these you must


@@ -493,6 +536,7 @@
 #define wxUSE_CHECKLISTBOX 1    // wxCheckListBox (requires wxUSE_OWNER_DRAWN)
 #define wxUSE_CHOICE       1    // wxChoice
 #define wxUSE_COMBOBOX     1    // wxComboBox
 #define wxUSE_CHECKLISTBOX 1    // wxCheckListBox (requires wxUSE_OWNER_DRAWN)
 #define wxUSE_CHOICE       1    // wxChoice
 #define wxUSE_COMBOBOX     1    // wxComboBox

+#define wxUSE_DATEPICKCTRL 1    // wxDatePickerCtrl

 #define wxUSE_GAUGE        1    // wxGauge
 #define wxUSE_LISTBOX      1    // wxListBox
 #define wxUSE_LISTCTRL     1    // wxListCtrl
 #define wxUSE_GAUGE        1    // wxGauge
 #define wxUSE_LISTBOX      1    // wxListBox
 #define wxUSE_LISTCTRL     1    // wxListCtrl


@@ -522,10 +566,14 @@
 // 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)
 //
 // Recommended setting: 1 (there is no advantage in using the generic one)

+#if defined(__WXMSW__) || defined(__WXMAC__)

 #define wxUSE_NATIVE_STATUSBAR        1
 #define wxUSE_NATIVE_STATUSBAR        1

+#else
+#define wxUSE_NATIVE_STATUSBAR        0
+#endif

 
 // wxToolBar related settings: if wxUSE_TOOLBAR is 0, don't compile any toolbar
 // classes at all. Otherwise, use the native toolbar class unless
 
 // wxToolBar related settings: if wxUSE_TOOLBAR is 0, don't compile any toolbar
 // classes at all. Otherwise, use the native toolbar class unless


@@ -537,11 +585,8 @@
 #define wxUSE_TOOLBAR 1
 #define wxUSE_TOOLBAR_NATIVE 1
 
 #define wxUSE_TOOLBAR 1
 #define wxUSE_TOOLBAR_NATIVE 1
 

-// this setting is obsolete, value is ignored
-#define wxUSE_BUTTONBAR    1
-

 // wxNotebook is a control with several "tabs" located on one of its sides. It
 // wxNotebook is a control with several "tabs" located on one of its sides. It

-// may be used ot logically organise the data presented to the user instead of
+// may be used to logically organise the data presented to the user instead of

 // putting everything in one huge dialog. It replaces wxTabControl and related
 // classes of wxWin 1.6x.
 //
 // putting everything in one huge dialog. It replaces wxTabControl and related
 // classes of wxWin 1.6x.
 //


@@ -550,6 +595,22 @@
 // Recommended setting: 1
 #define wxUSE_NOTEBOOK 1
 
 // Recommended setting: 1
 #define wxUSE_NOTEBOOK 1
 

+// wxListbook control is similar to wxNotebook but uses wxListCtrl instead of
+// the tabs
+//
+// Default is 1.
+//
+// Recommended setting: 1
+#define wxUSE_LISTBOOK 1
+
+// wxChoicebook control is similar to wxNotebook but uses wxChoice instead of
+// the tabs
+//
+// Default is 1.
+//
+// Recommended setting: 1
+#define wxUSE_CHOICEBOOK 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.
 //


@@ -560,12 +621,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
 // ----------------------------------------------------------------------------


@@ -635,29 +704,10 @@
 // wxValidator class and related methods
 #define wxUSE_VALIDATORS 1
 
 // wxValidator class and related methods
 #define wxUSE_VALIDATORS 1
 

-// wxDC cacheing implementation
-#define wxUSE_DC_CACHEING 1
-
-// Set this to 1 to enable the use of DIB's for wxBitmap to support
-// bitmaps > 16MB on Win95/98/Me.  Set to 0 to use DDB's only.
-#define wxUSE_DIB_FOR_BITMAP 0
-
-// Set this to 1 to enable wxDIB
-#define wxUSE_WXDIB 1
-

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

-// Define 1 to use generic dialogs in Windows, even though they duplicate
-// native common dialog (e.g. wxColourDialog). This is mainly useful for
-// testing.
-//
-// Default is 0
-//
-// Recommended setting: 0
-#define wxUSE_GENERIC_DIALOGS_IN_MSW 0
-

 // On rare occasions (e.g. using DJGPP) may want to omit common dialogs (e.g.
 // file selector, printer dialog). Switching this off also switches off the
 // printing architecture and interactive wxPrinterDC.
 // On rare occasions (e.g. using DJGPP) may want to omit common dialogs (e.g.
 // file selector, printer dialog). Switching this off also switches off the
 // printing architecture and interactive wxPrinterDC.


@@ -761,10 +811,21 @@
 // Big GUI components
 // ----------------------------------------------------------------------------
 
 // Big GUI components
 // ----------------------------------------------------------------------------
 

+// Set to 0 to disable MDI support.
+//
+// Requires wxUSE_NOTEBOOK under platforms other than MSW.
+//
+// Default is 1.
+//
+// Recommended setting: 1, can be safely set to 0.
+#define wxUSE_MDI 1
+

 // Set to 0 to disable document/view architecture
 #define wxUSE_DOC_VIEW_ARCHITECTURE 1
 
 // Set to 0 to disable MDI document/view architecture
 // Set to 0 to disable document/view architecture
 #define wxUSE_DOC_VIEW_ARCHITECTURE 1
 
 // Set to 0 to disable MDI document/view architecture

+//
+// Requires wxUSE_MDI && wxUSE_DOC_VIEW_ARCHITECTURE

 #define wxUSE_MDI_ARCHITECTURE    1
 
 // Set to 0 to disable print/preview architecture code
 #define wxUSE_MDI_ARCHITECTURE    1
 
 // Set to 0 to disable print/preview architecture code


@@ -851,7 +912,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


@@ -966,11 +1027,13 @@
 // Set to 1 to compile in wxPalette class
 #define wxUSE_PALETTE       1
 
 // Set to 1 to compile in wxPalette class
 #define wxUSE_PALETTE       1
 

+/* --- end common options --- */
+

 // ----------------------------------------------------------------------------
 // Windows-only settings
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // Windows-only settings
 // ----------------------------------------------------------------------------
 

-// Set this to 1 if you want to use wxWindows and MFC in the same program. This
+// Set this to 1 if you want to use wxWidgets and MFC in the same program. This

 // will override some other settings (see below)
 //
 // Default is 0.
 // will override some other settings (see below)
 //
 // Default is 0.


@@ -987,17 +1050,15 @@
 // Recommended setting: 1
 #define wxUSE_OLE           1
 
 // Recommended setting: 1
 #define wxUSE_OLE           1
 

-// Set this to 1 to use Microsoft CTL3D library for "3D-look" under Win16 or NT
-// 3.x. This setting is ignored under Win9x and NT 4.0+.
-//
-// Default is 0 for (most) Win32 (systems), 1 for Win16
-//
-// Recommended setting: same as default
-#if defined(__WIN95__)
-#define wxUSE_CTL3D                      0
-#else
-#define wxUSE_CTL3D                      1
-#endif
+// wxDC cacheing implementation
+#define wxUSE_DC_CACHEING 1
+
+// Set this to 1 to enable the use of DIB's for wxBitmap to support
+// bitmaps > 16MB on Win95/98/Me.  Set to 0 to use DDB's only.
+#define wxUSE_DIB_FOR_BITMAP 0
+
+// Set this to 1 to enable wxDIB
+#define wxUSE_WXDIB 1

 
 // Define as 1 to use Microsoft's ItsyBitsy small title bar library, for
 // wxMiniFrame. This setting is only used for Win3.1; Win9x and NT use native
 
 // Define as 1 to use Microsoft's ItsyBitsy small title bar library, for
 // wxMiniFrame. This setting is only used for Win3.1; Win9x and NT use native


@@ -1042,8 +1103,29 @@
 // (notably, wxNotebook pages)
 #define wxUSE_UXTHEME_AUTO      1
 
 // (notably, wxNotebook pages)
 #define wxUSE_UXTHEME_AUTO      1
 

-// Set to 1 to if you're developing for MS SmartPhone
-#define wxUSE_SMARTPHONE        0
+// ----------------------------------------------------------------------------
+// Generic versions of native controls
+// ----------------------------------------------------------------------------
+
+// Set this to 1 to be able to use wxDatePickerCtrlGeneric in addition to the
+// native wxDatePickerCtrl
+//
+// Default is 0.
+//
+// Recommended setting: 0, this is mainly used for testing
+#define wxUSE_DATEPICKCTRL_GENERIC 0
+
+// ----------------------------------------------------------------------------
+// Crash debugging helpers
+// ----------------------------------------------------------------------------
+
+// Set this to 1 to be able to use wxCrashReport::Generate() to create mini
+// dumps of your program when it crashes (or at any other moment)
+//
+// Default is 1 if supported by the compiler (VC++ and recent BC++ only).
+//
+// Recommended setting: 1, set to 0 if your programs never crash
+#define wxUSE_CRASHREPORT 1

 
 // ----------------------------------------------------------------------------
 // obsolete settings
 
 // ----------------------------------------------------------------------------
 // obsolete settings


@@ -1058,9 +1140,5 @@
 // Define 1 to use bitmap messages.
 #define wxUSE_BITMAP_MESSAGE         1
 
 // Define 1 to use bitmap messages.
 #define wxUSE_BITMAP_MESSAGE         1
 

-// If 1, enables provision of run-time type information.
-// NOW MANDATORY: don't change.
-#define wxUSE_DYNAMIC_CLASSES     1
+#endif // _WX_SETUP_H_

 
 

-#endif
-    // _WX_SETUP_H_