]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/setup0.h
Some corrections
[wxWidgets.git] / include / wx / msw / setup0.h
index 52fc43a9ec337aecb362b1bfee9186ddba3ef6a5..04261d844ac8c56a87acb9b9dea519092e3ed42d 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        setup.h
+// Name:        wx/msw/setup.h
 // Purpose:     Configuration for the library
 // Author:      Julian Smart
 // Modified by:
 // 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
-                                // Compatibility with 1.68 API.
-                                // Level 0: no backward compatibility, all new features
-                                // Level 1: Some compatibility. In fact
-                                // the compatibility code is now very minimal so there
-                                // is little advantage to setting it to 1.
 
 // in wxMSW version 2.1.11 and earlier, wxIcon always derives from wxBitmap,
 // but this is very dangerous because you can mistakenly pass an icon instead
 #define wxICON_IS_BITMAP    0
 
 // ----------------------------------------------------------------------------
-// General features
+// non GUI features selection
 // ----------------------------------------------------------------------------
 
+// Set wxUSE_LONGLONG to 1 to compile the wxLongLong class. This is a 64 bit
+// integer which is implemented in terms of native 64 bit integers if any or
+// uses emulation otherwise.
+//
+// This class is required by wxDateTime and so you should enable it if you want
+// to use wxDateTime. For most modern platforms, it will use the native 64 bit
+// integers in which case (almost) all of its functions are inline and it
+// almost does not take any space, so there should be no reason to switch it
+// off.
+//
+// Recommended setting: 1
+#define wxUSE_LONGLONG      1
+
+// Set wxUSE_TIMEDATE 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
+// compatibility (and implemented in terms of wxDateTime).
+//
+// Note that this class is relatively new and is still officially in alpha
+// stage because some features are not yet (fully) implemented. It is already
+// quite useful though and should only be disabled if you are aiming at
+// absolutely minimal version of the library.
+//
+// Requires: wxUSE_LONGLONG
+//
+// Recommended setting: 1
+#define wxUSE_TIMEDATE      1
+
 // Setting wxUSE_CONFIG to 1 enables the use of wxConfig and related classes
 // which allow the application to store its settings in the persistent
 // storage. Setting this to 1 will also enable on-demand creation of the
 #define wxUSE_TOOLBAR_NATIVE 1
 #define wxUSE_TOOLBAR_SIMPLE 1
 
+// 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
+// putting everything in one huge dialog. It replaces wxTabControl and related
+// classes of wxWin 1.6x.
+//
+// Default is 1.
+//
+// Recommended setting: 1
+#define wxUSE_NOTEBOOK 1
+
+// The corresponding controls will be compiled in if wxUSE_<CONTROL> is set to
+// 1 and not compiled into the library otherwise.
+//
+// Default is 1 for everything.
+//
+// Recommended setting: 1 (library might fail to compile for some combinations
+// of disabled controls)
+#define wxUSE_CARET        1
+#define wxUSE_CHECKBOX     1
+#define wxUSE_CHECKLISTBOX 1
+#define wxUSE_CHOICE       1
+#define wxUSE_COMBOBOX     1
+#define wxUSE_GAUGE        1
+#define wxUSE_LISTBOX      1
+#define wxUSE_RADIOBOX     1
+#define wxUSE_RADIOBTN     1
+#define wxUSE_SCROLLBAR    1
+#define wxUSE_SLIDER       1
+#define wxUSE_SPINBTN      1
+#define wxUSE_SPINCTRL     1
+#define wxUSE_STATLINE     1
+
+// this setting is obsolete, value is ignored
+#define wxUSE_BUTTONBAR    1
+
+// wxGrid class comes in two flavours: the original (pre wxWin 2.2) one and
+// the new, much imporved and enhanced version. The new version is backwards
+// compatible with the old one and should be used whenever possible, i.e. if
+// you set wxUSE_GRID to 1, set wxUSE_NEW_GRID to 1 too.
+//
+// Default is 1 for both options.
+//
+// Recommended setting: 1 for wxUSE_NEW_GRID, 0 if you have an old code using
+// wxGrid and 100% backwards compatible (with all old wxGrid quirks) is
+// essential.
+#define wxUSE_GRID         1
+#define wxUSE_NEW_GRID     1
+
+// ----------------------------------------------------------------------------
+// Metafiles support
+// ----------------------------------------------------------------------------
+
+// Windows supports the graphics format known as metafile which is, though not
+// portable, is widely used under Windows and so is supported by wxWin (under
+// Windows only, of course). Win16 (Win3.1) used the so-called "Window
+// MetaFiles" or WMFs which were replaced with "Enhanced MetaFiles" or EMFs in
+// Win32 (Win9x, NT, 2000). Both of these are supported in wxWin and, by
+// default, WMFs will be used under Win16 and EMFs under Win32. This may be
+// changed by setting wxUSE_WIN_METAFILES_ALWAYS to 1 and/or setting
+// wxUSE_ENH_METAFILE to 0. You may also set wxUSE_METAFILE to 0 to not compile
+// in any metafile related classes at all.
+//
+// Default is 1 for wxUSE_ENH_METAFILE and 0 for wxUSE_WIN_METAFILES_ALWAYS.
+//
+// Recommended setting: default or 0 for everything for portable programs.
+#define wxUSE_METAFILE              1
+#define wxUSE_ENH_METAFILE          1
+#define wxUSE_WIN_METAFILES_ALWAYS  0
+
+// ----------------------------------------------------------------------------
+// Big GUI components
+// ----------------------------------------------------------------------------
+
+// wxHTML sublibrary allows to display HTML in wxWindow programs and much,
+// much more.
+//
+// Default is 1.
+//
+// Recommended setting: 1 (wxHTML is great!), set to 0 if you want compile a
+// smaller library.
+#define wxUSE_HTML          1
+
+// wxPlot is a class to display functions plots in wxWindow.
+//
+// Default is 1.
+//
+// Recommended setting: 1
+#define wxUSE_PLOT           1
+
+// OpenGL canvas
+#define wxUSE_GLCANVAS       0
+
+// wxTreeLayout class
+#define wxUSE_TREELAYOUT     1
+
 // ----------------------------------------------------------------------------
 // Postscript support settings
 // ----------------------------------------------------------------------------
                                 // 0 for no PostScript device context
 #define wxUSE_AFM_FOR_POSTSCRIPT 0
                                 // 1 to use font metric files in GetTextExtent
-#define wxUSE_METAFILE    1
-                                // 0 for no Metafile and metafile device context
 #define wxUSE_IPC         1
                                 // 0 for no interprocess comms
 // Note: wxHELP uses IPC under X so these are interdependent!
 #define wxUSE_CONSTRAINTS 1
                                 // 0 for no window layout constraint system
 
-#define wxUSE_TIMEDATE    1
-                                // 0 for no wxTime/wxDate classes
-
 #define wxUSE_CLIPBOARD   1
                                 // 0 for no clipboard functions
 
 #define wxUSE_DRAG_AND_DROP 1
                                 // 0 for no drag and drop
 
-#define wxUSE_BUTTONBAR    1
-                                // Define 1 to use buttonbar classes (enhanced toolbar
-                                // for MS Windows)
-#define wxUSE_GAUGE        1
-                                // Define 1 to use Microsoft's gauge (Windows)
-                                // or Bull's gauge (Motif) library (both in contrib).
-#define wxUSE_COMBOBOX     1
-                                // Define 1 to use COMBOXBOX control (Windows)
-                                // or FWW's ComboBox widget (Motif).
-#define wxUSE_CHOICE       1
-                                // Define 1 to use CHOICE
-
-#define wxUSE_RADIOBUTTON  1
-                                // Define 1 to use radio button control
-#define wxUSE_RADIOBTN     1
-                                // Unfortunately someone introduced this one, too
-#define wxUSE_RADIOBOX     1
-                                // And this... don't know which one is corect
-
-#define wxUSE_SCROLLBAR    1
-                                // Define 1 to compile contributed wxScrollBar class
-
-#define wxUSE_CHECKBOX     1
-                                // Define 1 to compile checkbox
-
-#define wxUSE_LISTBOX      1
-                                // Define 1 to compile listbox
-
-#define wxUSE_SPINBTN      1
-                                // Define 1 to compile spin button
-
-#define wxUSE_SPINCTRL     1
-                                // Define 1 to use wxSpinCtrl class
-
-#define wxUSE_STATLINE     1
-                                // use wxStaticLine class
-
-#define wxUSE_CHECKLISTBOX 1
-                                // Define 1 to compile check listbox
-
-#define wxUSE_CHOICE       1
-                                // Define 1 to compile choice
-
-#define wxUSE_CARET        1
-                                // Define 1 to use wxCaret class
-
-#define wxUSE_SLIDER       1
-                                // Define 1 to use wxSlider class
-
-#define wxUSE_NEW_GRID     1
-                                // Define 1 to use the new wxGrid class
-                                // (still under development, define 0 to
-                                //  use existing wxGrid class)
 #define wxUSE_XPM_IN_MSW   1
                                 // Define 1 to support the XPM package in wxBitmap.
 #define wxUSE_IMAGE_LOADING_IN_MSW        1
 #define wxUSE_ODBC          0
                                 // Define 1 to use ODBC classes
 
-#define wxODBC_FWD_ONLY_CURSORS 1
-                                // Some databases/ODBC drivers only allow forward scrolling cursors.
-                                // Unless you specifically want to use backward scrolling
-                                // cursors, and you know that all of the databases/ODBC drivers
-                                // that you will use these odbc classes with allow backward
-                                // scrolling cursors, this setting should remain set to 1
-                                // for maximum database/driver compatibilty
+#define wxODBC_FWD_ONLY_CURSORS         1
+                                // 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::GetDbConnection() to indicate whether the connection
+                                // (and any wxTable()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.
 
 #ifndef __MWERKS__
 #define wxUSE_IOSTREAMH     1
                                 // Use PCX bitmap/image code
 #define wxUSE_SERIAL        0
                                 // Use serialization (requires utils/serialize)
-#define wxUSE_DYNLIB_CLASS  0
+#define wxUSE_DYNLIB_CLASS  1
                                 // Compile in wxLibrary class for run-time
                                 // DLL loading and function calling
 #define wxUSE_TOOLTIPS      1
                                 // wxWindow::SetToolTip() method
 #define wxUSE_SOCKETS       1
                                 // Set to 1 to use socket classes
-#define wxUSE_HTML          1
-                                // Set to 1 to use wxHTML sub-library
+#define wxUSE_FILESYSTEM    1   
+                                // Set to 1 to enable virtual file systems
+                                // (needed by wxHTML)
 #define wxUSE_FS_ZIP        1
-#define wxUSE_FS_INET       1   // Set to 1 to enable virtual file systems
+#define wxUSE_FS_INET       1   
+                                // Set to 1 to enable virtual file systems
 
 #define wxUSE_BUSYINFO      1
                                 // wxBusyInfo displays window with message
 #endif
 #endif
 
-#if (!defined(WIN32) && !defined(__WIN32__)) || (defined(__GNUWIN32__) && !defined(wxUSE_NORLANDER_HEADERS))
+#if (!defined(WIN32) && !defined(__WIN32__)) || (defined(__GNUWIN32__) && !wxUSE_NORLANDER_HEADERS)
 // Can't use OLE drag and drop in Windows 3.1 because we don't know how
 // to implement UUIDs
 // GnuWin32 doesn't have appropriate headers for e.g. IUnknown.