From 20b3c887f5aea1bdcaa0c6ac09536161b41c5a75 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sun, 23 Apr 2023 17:33:46 +0100 Subject: [PATCH] Improve wxUSE_STD_IOSTREAM documentation Clarify that it is 1 by default in the documentation, instead of implying that it's off by default and needs to be enabled. Improve the description of this option in setup.h files. And also document this compilation option in the summary page. --- docs/doxygen/mainpages/const_wxusedef.h | 1 + include/wx/android/setup.h | 8 ++++++-- include/wx/gtk/setup.h | 8 ++++++-- include/wx/msw/setup.h | 8 ++++++-- include/wx/osx/setup.h | 8 ++++++-- include/wx/setup_inc.h | 8 ++++++-- include/wx/univ/setup.h | 8 ++++++-- interface/wx/log.h | 5 +++-- interface/wx/textctrl.h | 8 ++------ 9 files changed, 42 insertions(+), 20 deletions(-) diff --git a/docs/doxygen/mainpages/const_wxusedef.h b/docs/doxygen/mainpages/const_wxusedef.h index 6e013cae7f..c34151c662 100644 --- a/docs/doxygen/mainpages/const_wxusedef.h +++ b/docs/doxygen/mainpages/const_wxusedef.h @@ -221,6 +221,7 @@ library: @itemdef{wxUSE_STATUSBAR, Use wxStatusBar class.} @itemdef{wxUSE_STC, Use wxStyledTextCtrl.} @itemdef{wxUSE_STDPATHS, Use wxStandardPaths class.} +@itemdef{wxUSE_STD_IOSTREAM, Use standard stream classes in addition to or, in wxDocument, instead of, wx streams.} @itemdef{wxUSE_STOPWATCH, Use wxStopWatch class.} @itemdef{wxUSE_STREAMS, Enable stream classes.} @itemdef{wxUSE_SVG, Use wxSVGFileDC class.} diff --git a/include/wx/android/setup.h b/include/wx/android/setup.h index 5a8063ef31..6ec8a23ed0 100644 --- a/include/wx/android/setup.h +++ b/include/wx/android/setup.h @@ -272,11 +272,15 @@ // disabled, wx streams are used instead. // // Notice that enabling this does not replace wx streams with std streams -// everywhere, in a lot of places wx streams are used no matter what. +// everywhere, in a lot of places wx streams are used no matter what and in +// other places this option enables the use of standard streams in _addition_ +// to the wx ones. The only exception is wxDocument which defines functions +// working with standard streams only when this option is on, and only +// functions working with wx streams when it's off. // // Default is 1. // -// Recommended setting: 1. +// Recommended setting: 1, there should be no reason to disable it. #define wxUSE_STD_IOSTREAM 1 // ---------------------------------------------------------------------------- diff --git a/include/wx/gtk/setup.h b/include/wx/gtk/setup.h index 7e7a69ec46..0d7947785a 100644 --- a/include/wx/gtk/setup.h +++ b/include/wx/gtk/setup.h @@ -273,11 +273,15 @@ // disabled, wx streams are used instead. // // Notice that enabling this does not replace wx streams with std streams -// everywhere, in a lot of places wx streams are used no matter what. +// everywhere, in a lot of places wx streams are used no matter what and in +// other places this option enables the use of standard streams in _addition_ +// to the wx ones. The only exception is wxDocument which defines functions +// working with standard streams only when this option is on, and only +// functions working with wx streams when it's off. // // Default is 1. // -// Recommended setting: 1. +// Recommended setting: 1, there should be no reason to disable it. #define wxUSE_STD_IOSTREAM 1 // ---------------------------------------------------------------------------- diff --git a/include/wx/msw/setup.h b/include/wx/msw/setup.h index 43e84a82a3..f5b66d6949 100644 --- a/include/wx/msw/setup.h +++ b/include/wx/msw/setup.h @@ -273,11 +273,15 @@ // disabled, wx streams are used instead. // // Notice that enabling this does not replace wx streams with std streams -// everywhere, in a lot of places wx streams are used no matter what. +// everywhere, in a lot of places wx streams are used no matter what and in +// other places this option enables the use of standard streams in _addition_ +// to the wx ones. The only exception is wxDocument which defines functions +// working with standard streams only when this option is on, and only +// functions working with wx streams when it's off. // // Default is 1. // -// Recommended setting: 1. +// Recommended setting: 1, there should be no reason to disable it. #define wxUSE_STD_IOSTREAM 1 // ---------------------------------------------------------------------------- diff --git a/include/wx/osx/setup.h b/include/wx/osx/setup.h index 678b8ea182..ed5f34f586 100644 --- a/include/wx/osx/setup.h +++ b/include/wx/osx/setup.h @@ -279,11 +279,15 @@ // disabled, wx streams are used instead. // // Notice that enabling this does not replace wx streams with std streams -// everywhere, in a lot of places wx streams are used no matter what. +// everywhere, in a lot of places wx streams are used no matter what and in +// other places this option enables the use of standard streams in _addition_ +// to the wx ones. The only exception is wxDocument which defines functions +// working with standard streams only when this option is on, and only +// functions working with wx streams when it's off. // // Default is 1. // -// Recommended setting: 1. +// Recommended setting: 1, there should be no reason to disable it. #define wxUSE_STD_IOSTREAM 1 // ---------------------------------------------------------------------------- diff --git a/include/wx/setup_inc.h b/include/wx/setup_inc.h index 2562857e09..50d248136c 100644 --- a/include/wx/setup_inc.h +++ b/include/wx/setup_inc.h @@ -269,11 +269,15 @@ // disabled, wx streams are used instead. // // Notice that enabling this does not replace wx streams with std streams -// everywhere, in a lot of places wx streams are used no matter what. +// everywhere, in a lot of places wx streams are used no matter what and in +// other places this option enables the use of standard streams in _addition_ +// to the wx ones. The only exception is wxDocument which defines functions +// working with standard streams only when this option is on, and only +// functions working with wx streams when it's off. // // Default is 1. // -// Recommended setting: 1. +// Recommended setting: 1, there should be no reason to disable it. #define wxUSE_STD_IOSTREAM 1 // ---------------------------------------------------------------------------- diff --git a/include/wx/univ/setup.h b/include/wx/univ/setup.h index cdbcb73daf..d86ed7d29a 100644 --- a/include/wx/univ/setup.h +++ b/include/wx/univ/setup.h @@ -272,11 +272,15 @@ // disabled, wx streams are used instead. // // Notice that enabling this does not replace wx streams with std streams -// everywhere, in a lot of places wx streams are used no matter what. +// everywhere, in a lot of places wx streams are used no matter what and in +// other places this option enables the use of standard streams in _addition_ +// to the wx ones. The only exception is wxDocument which defines functions +// working with standard streams only when this option is on, and only +// functions working with wx streams when it's off. // // Default is 1. // -// Recommended setting: 1. +// Recommended setting: 1, there should be no reason to disable it. #define wxUSE_STD_IOSTREAM 1 // ---------------------------------------------------------------------------- diff --git a/interface/wx/log.h b/interface/wx/log.h index 116bb19cff..f0c6927398 100644 --- a/interface/wx/log.h +++ b/interface/wx/log.h @@ -790,8 +790,9 @@ public: This class can be used to redirect the log messages to a C++ stream. - Please note that this class is only available if wxWidgets was compiled with - the standard iostream library support (@c wxUSE_STD_IOSTREAM must be on). + @note + This class is not available if `wxUSE_STD_IOSTREAM` is set to 0 (which + is done by `--disable-std_iostreams` option when using configure). @library{wxbase} @category{logging} diff --git a/interface/wx/textctrl.h b/interface/wx/textctrl.h index 7b3ed5e1e1..7b60ebaf3e 100644 --- a/interface/wx/textctrl.h +++ b/interface/wx/textctrl.h @@ -1850,12 +1850,8 @@ public: ostream object to a wxTextCtrl instead. @note - Some compilers and/or build configurations don't support multiply - inheriting wxTextCtrl from @c std::streambuf in which case this class is - not compiled in. - You also must have @c wxUSE_STD_IOSTREAM option on (i.e. set to 1) in your - @c setup.h to be able to use it. Under Unix, specify @c \--enable-std_iostreams - switch when running configure for this. + This class is not available if `wxUSE_STD_IOSTREAM` is set to 0 (which + is done by `--disable-std_iostreams` option when using configure). Example of usage: