diff --git a/build/cmake/setup.h.in b/build/cmake/setup.h.in index 826be84bbd..79b36148a7 100644 --- a/build/cmake/setup.h.in +++ b/build/cmake/setup.h.in @@ -482,7 +482,6 @@ #cmakedefine01 wxUSE_DIRDLG - #cmakedefine01 wxUSE_FILEDLG #cmakedefine01 wxUSE_FINDREPLDLG @@ -582,7 +581,6 @@ #cmakedefine01 wxUSE_DC_TRANSFORM_MATRIX - #cmakedefine01 wxUSE_IMAGE #cmakedefine01 wxUSE_LIBPNG diff --git a/include/wx/android/setup.h b/include/wx/android/setup.h index 9138445694..04eb147ddc 100644 --- a/include/wx/android/setup.h +++ b/include/wx/android/setup.h @@ -28,9 +28,10 @@ // This setting determines the compatibility with 3.0 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 -// change to 0 in the next version and the deprecated functions will disappear -// in the version after it completely. +// Default is 0, but you may still set it to 1 if you can't update the existing +// code relying on the deprecated functions. Please do consider updating it if +// at all possible instead of changing this to 1, however, as these functions +// will completely disappear in the next wxWidgets release. // // Recommended setting: 0 (please update your code) #define WXWIN_COMPATIBILITY_3_0 0 @@ -213,9 +214,10 @@ // Set wxUSE_EXTENDED_RTTI to 1 to use extended RTTI // -// Default is 0 +// This feature is incomplete and experimental, please only enable it if +// you want to participate in its development. // -// Recommended setting: 0 (this is still work in progress...) +// Recommended setting: 0 (unless you wish to try working on it). #define wxUSE_EXTENDED_RTTI 0 // Support for message/error logging. This includes wxLogXXX() functions and @@ -470,7 +472,7 @@ // wxFileConfig #define wxUSE_TEXTFILE 1 -// i18n support: _() macro, wxLocale class. Requires wxTextFile. +// i18n support: _() macro, wxLocale class. #define wxUSE_INTL 1 // Provide wxFoo_l() functions similar to standard foo() functions but taking @@ -530,9 +532,8 @@ #define wxUSE_CONFIG 1 // If wxUSE_CONFIG is 1, you may choose to use either the native config -// classes under Windows (using .INI files under Win16 and the registry under -// Win32) or the portable text file format used by the config classes under -// Unix. +// classes under Windows (using the registry) or the portable text file +// format used by the config classes under Unix. // // Default is 1 to use native classes. Note that you may still use // wxFileConfig even if you set this to 1 - just the config object created by @@ -711,14 +712,11 @@ // or your compiler cannot for some reason cope with complexity of templates used. #define wxUSE_ANY 1 -// 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. // -// Default is 0 +// Default is 1. // -// Recommended setting: 1 if your compiler supports it, if it doesn't please -// contribute us a makefile for src/regex for it +// Recommended setting: 1 #define wxUSE_REGEX 1 // wxSystemOptions class @@ -741,8 +739,7 @@ // 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. +// XML parsing classes. // // Default is 1 // @@ -770,7 +767,7 @@ // Recommended setting: 1 #define wxUSE_PROPGRID 1 -// Use wxStyledTextCtrl, a wxWidgets implementation of Scintilla. +// Use wxStyledTextCtrl, a wxWidgets Scintilla wrapper. // // Default is 1 // @@ -1106,8 +1103,8 @@ #define wxUSE_ARTPROVIDER_STD 1 // Use art provider providing Tango icons: this art provider has higher quality -// icons than the default ones using smaller size XPM icons without -// transparency but the embedded PNG icons add to the library size. +// icons than the default one. It uses SVG format which allows much better scaling +// then when bitmaps are used, at the expense of somewhat larger library size. // // Default is 1 under non-GTK ports. Under wxGTK the native art provider using // the GTK+ stock icons replaces it so it is normally not necessary. @@ -1115,7 +1112,7 @@ // Recommended setting: 1 but can be turned off to reduce the library size. #define wxUSE_ARTPROVIDER_TANGO 1 -// Hotkey support (currently Windows only) +// Hotkey support (currently Windows and macOS only) #define wxUSE_HOTKEY 1 // Use wxCaret: a class implementing a "cursor" in a text control (called caret @@ -1250,13 +1247,12 @@ // common dialogs // ---------------------------------------------------------------------------- -// 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. +// Use common dialogs (e.g. file selector, printer dialog). Switching this off +// also switches off the printing architecture and interactive wxPrinterDC. // // Default is 1 // -// Recommended setting: 1 (unless it really doesn't work) +// Recommended setting: 1 #define wxUSE_COMMON_DIALOGS 1 // wxBusyInfo displays window with message when app is busy. Works in same way @@ -1280,8 +1276,6 @@ // wxDirDlg class for getting a directory name from user #define wxUSE_DIRDLG 1 -// TODO: setting to choose the generic or native one - // Use file open/save dialogs. // // Default is 1 @@ -1394,20 +1388,18 @@ // Set to 0 to disable print/preview architecture code #define wxUSE_PRINTING_ARCHITECTURE 1 -// wxHTML sublibrary allows to display HTML in wxWindow programs and much, -// much more. +// wxHTML allows displaying simple HTML. // // Default is 1. // -// Recommended setting: 1 (wxHTML is great!), set to 0 if you want compile a -// smaller library. +// Recommended setting: 1 #define wxUSE_HTML 1 // Setting wxUSE_GLCANVAS to 1 enables OpenGL support. You need to have OpenGL // headers and libraries to be able to compile the library with wxUSE_GLCANVAS // set to 1 and, under Windows, also to add opengl32.lib and glu32.lib to the -// list of libraries used to link your application (although this is done -// implicitly for Microsoft Visual C++ users). +// list of libraries used to link your application when linking to wxWidgets +// statically (although this is done implicitly for Microsoft Visual C++ users). // // Default is 1. // @@ -1549,9 +1541,10 @@ // disabled if you don't plan to use images in such format sometimes saving // substantial amount of code in the final library. // -// Some formats require an extra library which is included in wxWin sources -// which is mentioned if it is the case. - +// Some formats require an extra library (e.g. libpng) which is always included in +// wxWidgets sources but some build systems (cmake, configure) can be configured to +// to use the system or user-provided version. +// // Set to 1 for wxImage support (recommended). #define wxUSE_IMAGE 1 diff --git a/include/wx/gtk/setup.h b/include/wx/gtk/setup.h index 395960cc8d..0dd052d801 100644 --- a/include/wx/gtk/setup.h +++ b/include/wx/gtk/setup.h @@ -29,9 +29,10 @@ // This setting determines the compatibility with 3.0 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 -// change to 0 in the next version and the deprecated functions will disappear -// in the version after it completely. +// Default is 0, but you may still set it to 1 if you can't update the existing +// code relying on the deprecated functions. Please do consider updating it if +// at all possible instead of changing this to 1, however, as these functions +// will completely disappear in the next wxWidgets release. // // Recommended setting: 0 (please update your code) #define WXWIN_COMPATIBILITY_3_0 0 @@ -214,9 +215,10 @@ // Set wxUSE_EXTENDED_RTTI to 1 to use extended RTTI // -// Default is 0 +// This feature is incomplete and experimental, please only enable it if +// you want to participate in its development. // -// Recommended setting: 0 (this is still work in progress...) +// Recommended setting: 0 (unless you wish to try working on it). #define wxUSE_EXTENDED_RTTI 0 // Support for message/error logging. This includes wxLogXXX() functions and @@ -471,7 +473,7 @@ // wxFileConfig #define wxUSE_TEXTFILE 1 -// i18n support: _() macro, wxLocale class. Requires wxTextFile. +// i18n support: _() macro, wxLocale class. #define wxUSE_INTL 1 // Provide wxFoo_l() functions similar to standard foo() functions but taking @@ -531,9 +533,8 @@ #define wxUSE_CONFIG 1 // If wxUSE_CONFIG is 1, you may choose to use either the native config -// classes under Windows (using .INI files under Win16 and the registry under -// Win32) or the portable text file format used by the config classes under -// Unix. +// classes under Windows (using the registry) or the portable text file +// format used by the config classes under Unix. // // Default is 1 to use native classes. Note that you may still use // wxFileConfig even if you set this to 1 - just the config object created by @@ -712,14 +713,11 @@ // or your compiler cannot for some reason cope with complexity of templates used. #define wxUSE_ANY 1 -// 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. // -// Default is 0 +// Default is 1. // -// Recommended setting: 1 if your compiler supports it, if it doesn't please -// contribute us a makefile for src/regex for it +// Recommended setting: 1 #define wxUSE_REGEX 1 // wxSystemOptions class @@ -742,8 +740,7 @@ // 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. +// XML parsing classes. // // Default is 1 // @@ -771,7 +768,7 @@ // Recommended setting: 1 #define wxUSE_PROPGRID 1 -// Use wxStyledTextCtrl, a wxWidgets implementation of Scintilla. +// Use wxStyledTextCtrl, a wxWidgets Scintilla wrapper. // // Default is 1 // @@ -1107,8 +1104,8 @@ #define wxUSE_ARTPROVIDER_STD 1 // Use art provider providing Tango icons: this art provider has higher quality -// icons than the default ones using smaller size XPM icons without -// transparency but the embedded PNG icons add to the library size. +// icons than the default one. It uses SVG format which allows much better scaling +// then when bitmaps are used, at the expense of somewhat larger library size. // // Default is 1 under non-GTK ports. Under wxGTK the native art provider using // the GTK+ stock icons replaces it so it is normally not necessary. @@ -1116,7 +1113,7 @@ // Recommended setting: 1 but can be turned off to reduce the library size. #define wxUSE_ARTPROVIDER_TANGO 1 -// Hotkey support (currently Windows only) +// Hotkey support (currently Windows and macOS only) #define wxUSE_HOTKEY 1 // Use wxCaret: a class implementing a "cursor" in a text control (called caret @@ -1251,13 +1248,12 @@ // common dialogs // ---------------------------------------------------------------------------- -// 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. +// Use common dialogs (e.g. file selector, printer dialog). Switching this off +// also switches off the printing architecture and interactive wxPrinterDC. // // Default is 1 // -// Recommended setting: 1 (unless it really doesn't work) +// Recommended setting: 1 #define wxUSE_COMMON_DIALOGS 1 // wxBusyInfo displays window with message when app is busy. Works in same way @@ -1281,8 +1277,6 @@ // wxDirDlg class for getting a directory name from user #define wxUSE_DIRDLG 1 -// TODO: setting to choose the generic or native one - // Use file open/save dialogs. // // Default is 1 @@ -1395,20 +1389,18 @@ // Set to 0 to disable print/preview architecture code #define wxUSE_PRINTING_ARCHITECTURE 1 -// wxHTML sublibrary allows to display HTML in wxWindow programs and much, -// much more. +// wxHTML allows displaying simple HTML. // // Default is 1. // -// Recommended setting: 1 (wxHTML is great!), set to 0 if you want compile a -// smaller library. +// Recommended setting: 1 #define wxUSE_HTML 1 // Setting wxUSE_GLCANVAS to 1 enables OpenGL support. You need to have OpenGL // headers and libraries to be able to compile the library with wxUSE_GLCANVAS // set to 1 and, under Windows, also to add opengl32.lib and glu32.lib to the -// list of libraries used to link your application (although this is done -// implicitly for Microsoft Visual C++ users). +// list of libraries used to link your application when linking to wxWidgets +// statically (although this is done implicitly for Microsoft Visual C++ users). // // Default is 1. // @@ -1550,9 +1542,10 @@ // disabled if you don't plan to use images in such format sometimes saving // substantial amount of code in the final library. // -// Some formats require an extra library which is included in wxWin sources -// which is mentioned if it is the case. - +// Some formats require an extra library (e.g. libpng) which is always included in +// wxWidgets sources but some build systems (cmake, configure) can be configured to +// to use the system or user-provided version. +// // Set to 1 for wxImage support (recommended). #define wxUSE_IMAGE 1 diff --git a/include/wx/msw/setup.h b/include/wx/msw/setup.h index 4b132886b9..a1905621cd 100644 --- a/include/wx/msw/setup.h +++ b/include/wx/msw/setup.h @@ -29,9 +29,10 @@ // This setting determines the compatibility with 3.0 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 -// change to 0 in the next version and the deprecated functions will disappear -// in the version after it completely. +// Default is 0, but you may still set it to 1 if you can't update the existing +// code relying on the deprecated functions. Please do consider updating it if +// at all possible instead of changing this to 1, however, as these functions +// will completely disappear in the next wxWidgets release. // // Recommended setting: 0 (please update your code) #define WXWIN_COMPATIBILITY_3_0 0 @@ -214,9 +215,10 @@ // Set wxUSE_EXTENDED_RTTI to 1 to use extended RTTI // -// Default is 0 +// This feature is incomplete and experimental, please only enable it if +// you want to participate in its development. // -// Recommended setting: 0 (this is still work in progress...) +// Recommended setting: 0 (unless you wish to try working on it). #define wxUSE_EXTENDED_RTTI 0 // Support for message/error logging. This includes wxLogXXX() functions and @@ -471,7 +473,7 @@ // wxFileConfig #define wxUSE_TEXTFILE 1 -// i18n support: _() macro, wxLocale class. Requires wxTextFile. +// i18n support: _() macro, wxLocale class. #define wxUSE_INTL 1 // Provide wxFoo_l() functions similar to standard foo() functions but taking @@ -531,9 +533,8 @@ #define wxUSE_CONFIG 1 // If wxUSE_CONFIG is 1, you may choose to use either the native config -// classes under Windows (using .INI files under Win16 and the registry under -// Win32) or the portable text file format used by the config classes under -// Unix. +// classes under Windows (using the registry) or the portable text file +// format used by the config classes under Unix. // // Default is 1 to use native classes. Note that you may still use // wxFileConfig even if you set this to 1 - just the config object created by @@ -712,14 +713,11 @@ // or your compiler cannot for some reason cope with complexity of templates used. #define wxUSE_ANY 1 -// 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. // -// Default is 0 +// Default is 1. // -// Recommended setting: 1 if your compiler supports it, if it doesn't please -// contribute us a makefile for src/regex for it +// Recommended setting: 1 #define wxUSE_REGEX 1 // wxSystemOptions class @@ -742,8 +740,7 @@ // 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. +// XML parsing classes. // // Default is 1 // @@ -771,7 +768,7 @@ // Recommended setting: 1 #define wxUSE_PROPGRID 1 -// Use wxStyledTextCtrl, a wxWidgets implementation of Scintilla. +// Use wxStyledTextCtrl, a wxWidgets Scintilla wrapper. // // Default is 1 // @@ -1107,8 +1104,8 @@ #define wxUSE_ARTPROVIDER_STD 1 // Use art provider providing Tango icons: this art provider has higher quality -// icons than the default ones using smaller size XPM icons without -// transparency but the embedded PNG icons add to the library size. +// icons than the default one. It uses SVG format which allows much better scaling +// then when bitmaps are used, at the expense of somewhat larger library size. // // Default is 1 under non-GTK ports. Under wxGTK the native art provider using // the GTK+ stock icons replaces it so it is normally not necessary. @@ -1116,7 +1113,7 @@ // Recommended setting: 1 but can be turned off to reduce the library size. #define wxUSE_ARTPROVIDER_TANGO 1 -// Hotkey support (currently Windows only) +// Hotkey support (currently Windows and macOS only) #define wxUSE_HOTKEY 1 // Use wxCaret: a class implementing a "cursor" in a text control (called caret @@ -1251,13 +1248,12 @@ // common dialogs // ---------------------------------------------------------------------------- -// 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. +// Use common dialogs (e.g. file selector, printer dialog). Switching this off +// also switches off the printing architecture and interactive wxPrinterDC. // // Default is 1 // -// Recommended setting: 1 (unless it really doesn't work) +// Recommended setting: 1 #define wxUSE_COMMON_DIALOGS 1 // wxBusyInfo displays window with message when app is busy. Works in same way @@ -1281,8 +1277,6 @@ // wxDirDlg class for getting a directory name from user #define wxUSE_DIRDLG 1 -// TODO: setting to choose the generic or native one - // Use file open/save dialogs. // // Default is 1 @@ -1395,20 +1389,18 @@ // Set to 0 to disable print/preview architecture code #define wxUSE_PRINTING_ARCHITECTURE 1 -// wxHTML sublibrary allows to display HTML in wxWindow programs and much, -// much more. +// wxHTML allows displaying simple HTML. // // Default is 1. // -// Recommended setting: 1 (wxHTML is great!), set to 0 if you want compile a -// smaller library. +// Recommended setting: 1 #define wxUSE_HTML 1 // Setting wxUSE_GLCANVAS to 1 enables OpenGL support. You need to have OpenGL // headers and libraries to be able to compile the library with wxUSE_GLCANVAS // set to 1 and, under Windows, also to add opengl32.lib and glu32.lib to the -// list of libraries used to link your application (although this is done -// implicitly for Microsoft Visual C++ users). +// list of libraries used to link your application when linking to wxWidgets +// statically (although this is done implicitly for Microsoft Visual C++ users). // // Default is 1. // @@ -1550,9 +1542,10 @@ // disabled if you don't plan to use images in such format sometimes saving // substantial amount of code in the final library. // -// Some formats require an extra library which is included in wxWin sources -// which is mentioned if it is the case. - +// Some formats require an extra library (e.g. libpng) which is always included in +// wxWidgets sources but some build systems (cmake, configure) can be configured to +// to use the system or user-provided version. +// // Set to 1 for wxImage support (recommended). #define wxUSE_IMAGE 1 diff --git a/include/wx/osx/setup.h b/include/wx/osx/setup.h index 50b6985912..d2cc1f0d8a 100644 --- a/include/wx/osx/setup.h +++ b/include/wx/osx/setup.h @@ -35,9 +35,10 @@ // This setting determines the compatibility with 3.0 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 -// change to 0 in the next version and the deprecated functions will disappear -// in the version after it completely. +// Default is 0, but you may still set it to 1 if you can't update the existing +// code relying on the deprecated functions. Please do consider updating it if +// at all possible instead of changing this to 1, however, as these functions +// will completely disappear in the next wxWidgets release. // // Recommended setting: 0 (please update your code) #define WXWIN_COMPATIBILITY_3_0 0 @@ -220,9 +221,10 @@ // Set wxUSE_EXTENDED_RTTI to 1 to use extended RTTI // -// Default is 0 +// This feature is incomplete and experimental, please only enable it if +// you want to participate in its development. // -// Recommended setting: 0 (this is still work in progress...) +// Recommended setting: 0 (unless you wish to try working on it). #define wxUSE_EXTENDED_RTTI 0 // Support for message/error logging. This includes wxLogXXX() functions and @@ -477,7 +479,7 @@ // wxFileConfig #define wxUSE_TEXTFILE 1 -// i18n support: _() macro, wxLocale class. Requires wxTextFile. +// i18n support: _() macro, wxLocale class. #define wxUSE_INTL 1 // Provide wxFoo_l() functions similar to standard foo() functions but taking @@ -537,9 +539,8 @@ #define wxUSE_CONFIG 1 // If wxUSE_CONFIG is 1, you may choose to use either the native config -// classes under Windows (using .INI files under Win16 and the registry under -// Win32) or the portable text file format used by the config classes under -// Unix. +// classes under Windows (using the registry) or the portable text file +// format used by the config classes under Unix. // // Default is 1 to use native classes. Note that you may still use // wxFileConfig even if you set this to 1 - just the config object created by @@ -718,14 +719,11 @@ // or your compiler cannot for some reason cope with complexity of templates used. #define wxUSE_ANY 1 -// 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. // -// Default is 0 +// Default is 1. // -// Recommended setting: 1 if your compiler supports it, if it doesn't please -// contribute us a makefile for src/regex for it +// Recommended setting: 1 #define wxUSE_REGEX 1 // wxSystemOptions class @@ -748,8 +746,7 @@ // 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. +// XML parsing classes. // // Default is 1 // @@ -777,7 +774,7 @@ // Recommended setting: 1 #define wxUSE_PROPGRID 1 -// Use wxStyledTextCtrl, a wxWidgets implementation of Scintilla. +// Use wxStyledTextCtrl, a wxWidgets Scintilla wrapper. // // Default is 1 // @@ -1113,8 +1110,8 @@ #define wxUSE_ARTPROVIDER_STD 1 // Use art provider providing Tango icons: this art provider has higher quality -// icons than the default ones using smaller size XPM icons without -// transparency but the embedded PNG icons add to the library size. +// icons than the default one. It uses SVG format which allows much better scaling +// then when bitmaps are used, at the expense of somewhat larger library size. // // Default is 1 under non-GTK ports. Under wxGTK the native art provider using // the GTK+ stock icons replaces it so it is normally not necessary. @@ -1122,7 +1119,7 @@ // Recommended setting: 1 but can be turned off to reduce the library size. #define wxUSE_ARTPROVIDER_TANGO 1 -// Hotkey support (currently Windows only) +// Hotkey support (currently Windows and macOS only) #define wxUSE_HOTKEY 1 // Use wxCaret: a class implementing a "cursor" in a text control (called caret @@ -1257,13 +1254,12 @@ // common dialogs // ---------------------------------------------------------------------------- -// 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. +// Use common dialogs (e.g. file selector, printer dialog). Switching this off +// also switches off the printing architecture and interactive wxPrinterDC. // // Default is 1 // -// Recommended setting: 1 (unless it really doesn't work) +// Recommended setting: 1 #define wxUSE_COMMON_DIALOGS 1 // wxBusyInfo displays window with message when app is busy. Works in same way @@ -1287,8 +1283,6 @@ // wxDirDlg class for getting a directory name from user #define wxUSE_DIRDLG 1 -// TODO: setting to choose the generic or native one - // Use file open/save dialogs. // // Default is 1 @@ -1401,20 +1395,18 @@ // Set to 0 to disable print/preview architecture code #define wxUSE_PRINTING_ARCHITECTURE 1 -// wxHTML sublibrary allows to display HTML in wxWindow programs and much, -// much more. +// wxHTML allows displaying simple HTML. // // Default is 1. // -// Recommended setting: 1 (wxHTML is great!), set to 0 if you want compile a -// smaller library. +// Recommended setting: 1 #define wxUSE_HTML 1 // Setting wxUSE_GLCANVAS to 1 enables OpenGL support. You need to have OpenGL // headers and libraries to be able to compile the library with wxUSE_GLCANVAS // set to 1 and, under Windows, also to add opengl32.lib and glu32.lib to the -// list of libraries used to link your application (although this is done -// implicitly for Microsoft Visual C++ users). +// list of libraries used to link your application when linking to wxWidgets +// statically (although this is done implicitly for Microsoft Visual C++ users). // // Default is 1. // @@ -1556,9 +1548,10 @@ // disabled if you don't plan to use images in such format sometimes saving // substantial amount of code in the final library. // -// Some formats require an extra library which is included in wxWin sources -// which is mentioned if it is the case. - +// Some formats require an extra library (e.g. libpng) which is always included in +// wxWidgets sources but some build systems (cmake, configure) can be configured to +// to use the system or user-provided version. +// // Set to 1 for wxImage support (recommended). #define wxUSE_IMAGE 1 diff --git a/include/wx/setup_inc.h b/include/wx/setup_inc.h index 495af5ed8e..f76e744321 100644 --- a/include/wx/setup_inc.h +++ b/include/wx/setup_inc.h @@ -25,9 +25,10 @@ // This setting determines the compatibility with 3.0 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 -// change to 0 in the next version and the deprecated functions will disappear -// in the version after it completely. +// Default is 0, but you may still set it to 1 if you can't update the existing +// code relying on the deprecated functions. Please do consider updating it if +// at all possible instead of changing this to 1, however, as these functions +// will completely disappear in the next wxWidgets release. // // Recommended setting: 0 (please update your code) #define WXWIN_COMPATIBILITY_3_0 0 @@ -210,9 +211,10 @@ // Set wxUSE_EXTENDED_RTTI to 1 to use extended RTTI // -// Default is 0 +// This feature is incomplete and experimental, please only enable it if +// you want to participate in its development. // -// Recommended setting: 0 (this is still work in progress...) +// Recommended setting: 0 (unless you wish to try working on it). #define wxUSE_EXTENDED_RTTI 0 // Support for message/error logging. This includes wxLogXXX() functions and @@ -467,7 +469,7 @@ // wxFileConfig #define wxUSE_TEXTFILE 1 -// i18n support: _() macro, wxLocale class. Requires wxTextFile. +// i18n support: _() macro, wxLocale class. #define wxUSE_INTL 1 // Provide wxFoo_l() functions similar to standard foo() functions but taking @@ -527,9 +529,8 @@ #define wxUSE_CONFIG 1 // If wxUSE_CONFIG is 1, you may choose to use either the native config -// classes under Windows (using .INI files under Win16 and the registry under -// Win32) or the portable text file format used by the config classes under -// Unix. +// classes under Windows (using the registry) or the portable text file +// format used by the config classes under Unix. // // Default is 1 to use native classes. Note that you may still use // wxFileConfig even if you set this to 1 - just the config object created by @@ -708,14 +709,11 @@ // or your compiler cannot for some reason cope with complexity of templates used. #define wxUSE_ANY 1 -// 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. // -// Default is 0 +// Default is 1. // -// Recommended setting: 1 if your compiler supports it, if it doesn't please -// contribute us a makefile for src/regex for it +// Recommended setting: 1 #define wxUSE_REGEX 1 // wxSystemOptions class @@ -738,8 +736,7 @@ // 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. +// XML parsing classes. // // Default is 1 // @@ -767,7 +764,7 @@ // Recommended setting: 1 #define wxUSE_PROPGRID 1 -// Use wxStyledTextCtrl, a wxWidgets implementation of Scintilla. +// Use wxStyledTextCtrl, a wxWidgets Scintilla wrapper. // // Default is 1 // @@ -1103,8 +1100,8 @@ #define wxUSE_ARTPROVIDER_STD 1 // Use art provider providing Tango icons: this art provider has higher quality -// icons than the default ones using smaller size XPM icons without -// transparency but the embedded PNG icons add to the library size. +// icons than the default one. It uses SVG format which allows much better scaling +// then when bitmaps are used, at the expense of somewhat larger library size. // // Default is 1 under non-GTK ports. Under wxGTK the native art provider using // the GTK+ stock icons replaces it so it is normally not necessary. @@ -1112,7 +1109,7 @@ // Recommended setting: 1 but can be turned off to reduce the library size. #define wxUSE_ARTPROVIDER_TANGO 1 -// Hotkey support (currently Windows only) +// Hotkey support (currently Windows and macOS only) #define wxUSE_HOTKEY 1 // Use wxCaret: a class implementing a "cursor" in a text control (called caret @@ -1247,13 +1244,12 @@ // common dialogs // ---------------------------------------------------------------------------- -// 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. +// Use common dialogs (e.g. file selector, printer dialog). Switching this off +// also switches off the printing architecture and interactive wxPrinterDC. // // Default is 1 // -// Recommended setting: 1 (unless it really doesn't work) +// Recommended setting: 1 #define wxUSE_COMMON_DIALOGS 1 // wxBusyInfo displays window with message when app is busy. Works in same way @@ -1277,8 +1273,6 @@ // wxDirDlg class for getting a directory name from user #define wxUSE_DIRDLG 1 -// TODO: setting to choose the generic or native one - // Use file open/save dialogs. // // Default is 1 @@ -1391,20 +1385,18 @@ // Set to 0 to disable print/preview architecture code #define wxUSE_PRINTING_ARCHITECTURE 1 -// wxHTML sublibrary allows to display HTML in wxWindow programs and much, -// much more. +// wxHTML allows displaying simple HTML. // // Default is 1. // -// Recommended setting: 1 (wxHTML is great!), set to 0 if you want compile a -// smaller library. +// Recommended setting: 1 #define wxUSE_HTML 1 // Setting wxUSE_GLCANVAS to 1 enables OpenGL support. You need to have OpenGL // headers and libraries to be able to compile the library with wxUSE_GLCANVAS // set to 1 and, under Windows, also to add opengl32.lib and glu32.lib to the -// list of libraries used to link your application (although this is done -// implicitly for Microsoft Visual C++ users). +// list of libraries used to link your application when linking to wxWidgets +// statically (although this is done implicitly for Microsoft Visual C++ users). // // Default is 1. // @@ -1546,9 +1538,10 @@ // disabled if you don't plan to use images in such format sometimes saving // substantial amount of code in the final library. // -// Some formats require an extra library which is included in wxWin sources -// which is mentioned if it is the case. - +// Some formats require an extra library (e.g. libpng) which is always included in +// wxWidgets sources but some build systems (cmake, configure) can be configured to +// to use the system or user-provided version. +// // Set to 1 for wxImage support (recommended). #define wxUSE_IMAGE 1 diff --git a/include/wx/univ/setup.h b/include/wx/univ/setup.h index babf336bb9..fcda796cec 100644 --- a/include/wx/univ/setup.h +++ b/include/wx/univ/setup.h @@ -28,9 +28,10 @@ // This setting determines the compatibility with 3.0 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 -// change to 0 in the next version and the deprecated functions will disappear -// in the version after it completely. +// Default is 0, but you may still set it to 1 if you can't update the existing +// code relying on the deprecated functions. Please do consider updating it if +// at all possible instead of changing this to 1, however, as these functions +// will completely disappear in the next wxWidgets release. // // Recommended setting: 0 (please update your code) #define WXWIN_COMPATIBILITY_3_0 0 @@ -213,9 +214,10 @@ // Set wxUSE_EXTENDED_RTTI to 1 to use extended RTTI // -// Default is 0 +// This feature is incomplete and experimental, please only enable it if +// you want to participate in its development. // -// Recommended setting: 0 (this is still work in progress...) +// Recommended setting: 0 (unless you wish to try working on it). #define wxUSE_EXTENDED_RTTI 0 // Support for message/error logging. This includes wxLogXXX() functions and @@ -470,7 +472,7 @@ // wxFileConfig #define wxUSE_TEXTFILE 1 -// i18n support: _() macro, wxLocale class. Requires wxTextFile. +// i18n support: _() macro, wxLocale class. #define wxUSE_INTL 1 // Provide wxFoo_l() functions similar to standard foo() functions but taking @@ -530,9 +532,8 @@ #define wxUSE_CONFIG 1 // If wxUSE_CONFIG is 1, you may choose to use either the native config -// classes under Windows (using .INI files under Win16 and the registry under -// Win32) or the portable text file format used by the config classes under -// Unix. +// classes under Windows (using the registry) or the portable text file +// format used by the config classes under Unix. // // Default is 1 to use native classes. Note that you may still use // wxFileConfig even if you set this to 1 - just the config object created by @@ -711,14 +712,11 @@ // or your compiler cannot for some reason cope with complexity of templates used. #define wxUSE_ANY 1 -// 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. // -// Default is 0 +// Default is 1. // -// Recommended setting: 1 if your compiler supports it, if it doesn't please -// contribute us a makefile for src/regex for it +// Recommended setting: 1 #define wxUSE_REGEX 1 // wxSystemOptions class @@ -741,8 +739,7 @@ // 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. +// XML parsing classes. // // Default is 1 // @@ -770,7 +767,7 @@ // Recommended setting: 1 #define wxUSE_PROPGRID 1 -// Use wxStyledTextCtrl, a wxWidgets implementation of Scintilla. +// Use wxStyledTextCtrl, a wxWidgets Scintilla wrapper. // // Default is 1 // @@ -1106,8 +1103,8 @@ #define wxUSE_ARTPROVIDER_STD 1 // Use art provider providing Tango icons: this art provider has higher quality -// icons than the default ones using smaller size XPM icons without -// transparency but the embedded PNG icons add to the library size. +// icons than the default one. It uses SVG format which allows much better scaling +// then when bitmaps are used, at the expense of somewhat larger library size. // // Default is 1 under non-GTK ports. Under wxGTK the native art provider using // the GTK+ stock icons replaces it so it is normally not necessary. @@ -1115,7 +1112,7 @@ // Recommended setting: 1 but can be turned off to reduce the library size. #define wxUSE_ARTPROVIDER_TANGO 1 -// Hotkey support (currently Windows only) +// Hotkey support (currently Windows and macOS only) #define wxUSE_HOTKEY 1 // Use wxCaret: a class implementing a "cursor" in a text control (called caret @@ -1250,13 +1247,12 @@ // common dialogs // ---------------------------------------------------------------------------- -// 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. +// Use common dialogs (e.g. file selector, printer dialog). Switching this off +// also switches off the printing architecture and interactive wxPrinterDC. // // Default is 1 // -// Recommended setting: 1 (unless it really doesn't work) +// Recommended setting: 1 #define wxUSE_COMMON_DIALOGS 1 // wxBusyInfo displays window with message when app is busy. Works in same way @@ -1280,8 +1276,6 @@ // wxDirDlg class for getting a directory name from user #define wxUSE_DIRDLG 1 -// TODO: setting to choose the generic or native one - // Use file open/save dialogs. // // Default is 1 @@ -1394,20 +1388,18 @@ // Set to 0 to disable print/preview architecture code #define wxUSE_PRINTING_ARCHITECTURE 1 -// wxHTML sublibrary allows to display HTML in wxWindow programs and much, -// much more. +// wxHTML allows displaying simple HTML. // // Default is 1. // -// Recommended setting: 1 (wxHTML is great!), set to 0 if you want compile a -// smaller library. +// Recommended setting: 1 #define wxUSE_HTML 1 // Setting wxUSE_GLCANVAS to 1 enables OpenGL support. You need to have OpenGL // headers and libraries to be able to compile the library with wxUSE_GLCANVAS // set to 1 and, under Windows, also to add opengl32.lib and glu32.lib to the -// list of libraries used to link your application (although this is done -// implicitly for Microsoft Visual C++ users). +// list of libraries used to link your application when linking to wxWidgets +// statically (although this is done implicitly for Microsoft Visual C++ users). // // Default is 1. // @@ -1549,9 +1541,10 @@ // disabled if you don't plan to use images in such format sometimes saving // substantial amount of code in the final library. // -// Some formats require an extra library which is included in wxWin sources -// which is mentioned if it is the case. - +// Some formats require an extra library (e.g. libpng) which is always included in +// wxWidgets sources but some build systems (cmake, configure) can be configured to +// to use the system or user-provided version. +// // Set to 1 for wxImage support (recommended). #define wxUSE_IMAGE 1 diff --git a/setup.h.in b/setup.h.in index 1f191f98a9..384e818e4e 100644 --- a/setup.h.in +++ b/setup.h.in @@ -485,7 +485,6 @@ #define wxUSE_DIRDLG 0 - #define wxUSE_FILEDLG 0 #define wxUSE_FINDREPLDLG 0 @@ -585,7 +584,6 @@ #define wxUSE_DC_TRANSFORM_MATRIX 0 - #define wxUSE_IMAGE 0 #define wxUSE_LIBPNG 0