diff --git a/build/cmake/setup.h.in b/build/cmake/setup.h.in index bce33a73f3..0646ae5784 100644 --- a/build/cmake/setup.h.in +++ b/build/cmake/setup.h.in @@ -500,7 +500,6 @@ #cmakedefine01 wxUSE_DIRDLG - #cmakedefine01 wxUSE_FILEDLG #cmakedefine01 wxUSE_FINDREPLDLG @@ -600,7 +599,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 5003359a78..248a9b1471 100644 --- a/include/wx/android/setup.h +++ b/include/wx/android/setup.h @@ -213,9 +213,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 +471,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 +531,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 +711,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 +738,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 +766,7 @@ // Recommended setting: 1 #define wxUSE_PROPGRID 1 -// Use wxStyledTextCtrl, a wxWidgets implementation of Scintilla. +// Use wxStyledTextCtrl, a wxWidgets Scintilla wrapper. // // Default is 1 // @@ -1123,8 +1119,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. @@ -1132,7 +1128,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 @@ -1267,13 +1263,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 @@ -1297,8 +1292,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 @@ -1411,20 +1404,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. // @@ -1566,9 +1557,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 81278c57ab..367d95e50f 100644 --- a/include/wx/gtk/setup.h +++ b/include/wx/gtk/setup.h @@ -214,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 @@ -471,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 @@ -531,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 @@ -712,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 @@ -742,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 // @@ -771,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 // @@ -1124,8 +1120,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. @@ -1133,7 +1129,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 @@ -1268,13 +1264,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 @@ -1298,8 +1293,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 @@ -1412,20 +1405,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. // @@ -1567,9 +1558,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/motif/setup.h b/include/wx/motif/setup.h index 6ac6bf82de..e3ab139389 100644 --- a/include/wx/motif/setup.h +++ b/include/wx/motif/setup.h @@ -214,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 @@ -471,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 @@ -531,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 @@ -712,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 @@ -742,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 // @@ -771,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 // @@ -1124,8 +1120,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. @@ -1133,7 +1129,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 @@ -1268,13 +1264,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 @@ -1298,8 +1293,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 @@ -1412,20 +1405,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. // @@ -1567,9 +1558,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 bcdd486940..b1d20d927c 100644 --- a/include/wx/msw/setup.h +++ b/include/wx/msw/setup.h @@ -214,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 @@ -471,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 @@ -531,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 @@ -712,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 @@ -742,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 // @@ -771,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 // @@ -1124,8 +1120,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. @@ -1133,7 +1129,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 @@ -1268,13 +1264,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 @@ -1298,8 +1293,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 @@ -1412,20 +1405,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. // @@ -1567,9 +1558,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 edb835cc8c..3afbc020f8 100644 --- a/include/wx/osx/setup.h +++ b/include/wx/osx/setup.h @@ -220,9 +220,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 +478,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 +538,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 +718,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 +745,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 +773,7 @@ // Recommended setting: 1 #define wxUSE_PROPGRID 1 -// Use wxStyledTextCtrl, a wxWidgets implementation of Scintilla. +// Use wxStyledTextCtrl, a wxWidgets Scintilla wrapper. // // Default is 1 // @@ -1130,8 +1126,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. @@ -1139,7 +1135,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 @@ -1274,13 +1270,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 @@ -1304,8 +1299,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 @@ -1418,20 +1411,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. // @@ -1573,9 +1564,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 8b7a63c15f..6fdcd93906 100644 --- a/include/wx/setup_inc.h +++ b/include/wx/setup_inc.h @@ -210,9 +210,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 +468,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 +528,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 +708,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 +735,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 +763,7 @@ // Recommended setting: 1 #define wxUSE_PROPGRID 1 -// Use wxStyledTextCtrl, a wxWidgets implementation of Scintilla. +// Use wxStyledTextCtrl, a wxWidgets Scintilla wrapper. // // Default is 1 // @@ -1120,8 +1116,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. @@ -1129,7 +1125,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 @@ -1264,13 +1260,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 @@ -1294,8 +1289,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 @@ -1408,20 +1401,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. // @@ -1563,9 +1554,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 0291378abd..b507d42160 100644 --- a/include/wx/univ/setup.h +++ b/include/wx/univ/setup.h @@ -213,9 +213,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 +471,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 +531,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 +711,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 +738,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 +766,7 @@ // Recommended setting: 1 #define wxUSE_PROPGRID 1 -// Use wxStyledTextCtrl, a wxWidgets implementation of Scintilla. +// Use wxStyledTextCtrl, a wxWidgets Scintilla wrapper. // // Default is 1 // @@ -1123,8 +1119,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. @@ -1132,7 +1128,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 @@ -1267,13 +1263,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 @@ -1297,8 +1292,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 @@ -1411,20 +1404,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. // @@ -1566,9 +1557,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 f76293bab4..fa74d8fbc0 100644 --- a/setup.h.in +++ b/setup.h.in @@ -500,7 +500,6 @@ #define wxUSE_DIRDLG 0 - #define wxUSE_FILEDLG 0 #define wxUSE_FINDREPLDLG 0 @@ -600,7 +599,6 @@ #define wxUSE_DC_TRANSFORM_MATRIX 0 - #define wxUSE_IMAGE 0 #define wxUSE_LIBPNG 0