Incl cleanup

docs/changes.txt

@@ -127,6 +127,10 @@ Changes in behaviour not resulting in compilation errors
   the page on screen, which doesn't make sense without reference to the tab
   control containing it, use GetPagePosition() to retrieve both of them.
 
+- wxListbook and wxChoicebook now interpret (but ignore) mnemonics in their
+  page titles, just as the other wx*book classes already did. Double "&"
+  in the page text if it should be interpreted as a literal "&".
+
 
 Changes in behaviour which may result in build errors
 -----------------------------------------------------

include/wx/aui/auibar.h

@@ -337,6 +337,12 @@ class WXDLLIMPEXP_AUI wxAuiToolBarArt
                          wxWindow* wnd,
                          const wxAuiToolBarItem& item) = 0;
 
+    // This function should be used for querying element sizes in the new code,
+    // as it scales them by the DPI of the provided window. GetElementSize()
+    // still exists (and is simpler to override), but is usually _not_ what you
+    // need.
+    virtual int GetElementSizeForWindow(int elementId, const wxWindow* window);
+
     // Note that these functions work with the size in DIPs, not physical
     // pixels.
     virtual int GetElementSize(int elementId) = 0;

include/wx/aui/barartmsw.h

@@ -76,9 +76,6 @@ class WXDLLIMPEXP_AUI wxAuiMSWToolBarArt : public wxAuiGenericToolBarArt
         wxWindow* wnd,
         const wxAuiToolBarItem& item) override;
 
-    virtual int GetElementSize(int element) override;
-    virtual void SetElementSize(int elementId, int size) override;
-
     virtual int ShowDropDown(wxWindow* wnd,
         const wxAuiToolBarItemArray& items) override;
 

include/wx/aui/dockart.h

@@ -38,6 +38,13 @@ class WXDLLIMPEXP_AUI wxAuiDockArt
     virtual ~wxAuiDockArt() = default;
 
     virtual wxAuiDockArt* Clone() = 0;
+
+    // This function should be used for querying metrics in the new code, as it
+    // will scale them by the DPI of the provided window if necessary. The
+    // older GetMetric() function is kept for compatibility and shouldn't be
+    // used outside of this class itself.
+    virtual int GetMetricForWindow(int id, wxWindow* window);
+
     virtual int GetMetric(int id) = 0;
     virtual void SetMetric(int id, int newVal) = 0;
     virtual void SetFont(int id, const wxFont& font) = 0;

include/wx/aui/serializer.h

@@ -65,11 +65,16 @@ struct wxAuiPaneLayoutInfo : wxAuiDockLayoutInfo
     wxSize floating_size = wxDefaultSize;
 
 
+    // The remaining fields correspond to individual bits of the pane state
+    // flags instead of corresponding to wxAuiPaneInfo fields directly because
+    // we prefer not storing the entire state -- this would be less readable
+    // and extensible.
+
     // True if the pane is currently maximized.
-    //
-    // Note that it's the only field of this struct which doesn't directly
-    // correspond to a field of wxAuiPaneInfo.
     bool is_maximized   = false;
+
+    // True if the pane is currently hidden.
+    bool is_hidden      = false;
 };
 
 // wxAuiBookSerializer is used for serializing wxAuiNotebook layout.

include/wx/datetime.h

@@ -19,8 +19,6 @@
 
 #include <vector>
 
-#include <limits.h>             // for INT_MIN
-
 #include "wx/longlong.h"
 #include "wx/anystr.h"
 

include/wx/filefn.h

@@ -10,7 +10,6 @@
 #ifndef   _FILEFN_H_
 #define   _FILEFN_H_
 
-#include "wx/list.h"
 #include "wx/arrstr.h"
 
 #include <time.h>

include/wx/filesys.h

@@ -16,6 +16,7 @@
 #include "wx/stream.h"
 #include "wx/datetime.h"
 #include "wx/filename.h"
+#include "wx/list.h"
 
 #include <unordered_map>
 

include/wx/hashmap.h

@@ -569,6 +569,7 @@ struct WXDLLIMPEXP_BASE wxStringEqual
 #define wxPTROP_NOP(pointer)
 
 #define _WX_DECLARE_HASH_MAP( KEY_T, VALUE_T, HASH_T, KEY_EQ_T, CLASSNAME, CLASSEXP ) \
+wxCLANG_WARNING_SUPPRESS(unused-member-function) \
 _WX_DECLARE_PAIR( KEY_T, VALUE_T, CLASSNAME##_wxImplementation_Pair, CLASSEXP ) \
 _WX_DECLARE_HASH_MAP_KEY_EX( KEY_T, CLASSNAME##_wxImplementation_Pair, CLASSNAME##_wxImplementation_KeyEx, CLASSEXP ) \
 _WX_DECLARE_HASHTABLE( CLASSNAME##_wxImplementation_Pair, KEY_T, HASH_T, \
@@ -621,7 +622,8 @@ public: \
     { \
         return GetNode( key ) ? 1u : 0u; \
     } \
-}
+} \
+wxCLANG_WARNING_RESTORE(unused-member-function)
 
 #endif // wxNEEDS_WX_HASH_MAP
 

include/wx/osx/notebook.h

@@ -14,6 +14,8 @@
 // ----------------------------------------------------------------------------
 #include "wx/event.h"
 
+#include <vector>
+
 // ----------------------------------------------------------------------------
 // types
 // ----------------------------------------------------------------------------
@@ -128,8 +130,25 @@ class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase
 
   int DoSetSelection(size_t nPage, int flags = 0) override;
 
-  // the icon indices
-  wxArrayInt m_images;
+private:
+  // this vector is synchronized with m_pages in the base class
+  struct PageData
+  {
+      PageData(const wxString& text_, int image_)
+          : text{text_}, image{image_}
+      {
+      }
+
+      PageData(const PageData&) = default;
+      PageData& operator=(const PageData&) = default;
+
+      PageData(PageData&&) = default;
+      PageData& operator=(PageData&&) = default;
+
+      wxString text;
+      int image = wxNOT_FOUND;
+  };
+  std::vector<PageData> m_pagesData;
 
   wxDECLARE_DYNAMIC_CLASS(wxNotebook);
   wxDECLARE_EVENT_TABLE();

include/wx/statusbr.h

@@ -15,7 +15,6 @@
 #if wxUSE_STATUSBAR
 
 #include "wx/control.h"
-#include "wx/list.h"
 #include "wx/dynarray.h"
 #include "wx/weakref.h"
 

include/wx/strconv.h

@@ -15,8 +15,6 @@
 #include "wx/chartype.h"
 #include "wx/buffer.h"
 
-#include <stdlib.h>
-
 class WXDLLIMPEXP_FWD_BASE wxString;
 
 // the error value returned by wxMBConv methods

include/wx/stream.h

@@ -14,7 +14,6 @@
 
 #if wxUSE_STREAMS
 
-#include <stdio.h>
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/filefn.h"  // for wxFileOffset, wxInvalidOffset and wxSeekMode

include/wx/string.h

@@ -27,10 +27,7 @@
 #endif
 
 #include <string.h>
-#include <stdio.h>
 #include <stdarg.h>
-#include <limits.h>
-#include <stdlib.h>
 
 #include "wx/chartype.h"    // for wxChar
 #include "wx/wxcrtbase.h"   // for wxChar, wxStrlen() etc.

include/wx/unix/private/uilocale.h

@@ -41,6 +41,7 @@ namespace
 class TempLocaleSetter
 {
 public:
+    wxCLANG_WARNING_SUPPRESS(unused-member-function)
     explicit TempLocaleSetter(int localeCategory,
                               const wxString& localeId = wxString())
         : m_localeCategory(localeCategory),
@@ -54,6 +55,7 @@ class TempLocaleSetter
         setlocale(m_localeCategory, m_localeOrig);
         free(m_localeOrig);
     }
+    wxCLANG_WARNING_RESTORE(unused-member-function)
 
 private:
     const int m_localeCategory;

include/wx/utils.h

@@ -15,7 +15,6 @@
 // ----------------------------------------------------------------------------
 
 #include "wx/object.h"
-#include "wx/list.h"
 #include "wx/filefn.h"
 #include "wx/versioninfo.h"
 #include "wx/meta/implicitconversion.h"
@@ -48,8 +47,6 @@ class WXDLLIMPEXP_FWD_BASE wxArrayInt;
     #include <unistd.h>
 #endif
 
-#include <stdio.h>
-
 #include <unordered_map>
 
 // ----------------------------------------------------------------------------

include/wx/xml/xml.h

@@ -17,7 +17,6 @@
 
 #include "wx/string.h"
 #include "wx/object.h"
-#include "wx/list.h"
 #include "wx/textbuf.h"
 #include "wx/versioninfo.h"
 #include "wx/filefn.h"

include/wx/xrc/xmlres.h

@@ -18,7 +18,6 @@
 #include "wx/dynarray.h"
 #include "wx/arrstr.h"
 #include "wx/datetime.h"
-#include "wx/list.h"
 #include "wx/gdicmn.h"
 #include "wx/filesys.h"
 #include "wx/bitmap.h"

interface/wx/aui/auibar.h

@@ -102,7 +102,7 @@ enum wxAuiToolBarArtSetting
     /**
       Overflow button size in wxAuiToolBar.
     */
-    wxAUI_TBART_OVERFLOW_SIZE = 2
+    wxAUI_TBART_OVERFLOW_SIZE = 2,
 
     /**
       Drop down button size in wxAuiToolBar.
@@ -547,8 +547,56 @@ class wxAuiToolBarArt
                          wxWindow* wnd,
                          const wxAuiToolBarItem& item) = 0;
 
-    virtual int GetElementSize(int element_id) = 0;
-    virtual void SetElementSize(int element_id, int size) = 0;
+    /**
+        Get the element size scaled by the DPI of the given window.
+
+        This function should be used to get the size of the element in pixels.
+
+        The default version delegates to GetElementSize(), override this
+        function if a different behaviour (e.g. to use some smarter algorithm
+        for scaling instead of just multiplying by the DPI factor) is needed.
+
+        @param elementId
+            One of ::wxAuiToolBarArtSetting elements.
+        @param window
+            A valid window, typically wxAuiToolBar itself.
+        @return
+            The size of the element in pixels.
+
+        @see SetElementSize()
+
+        @since 3.3.0
+     */
+    virtual int GetElementSizeForWindow(int elementId, const wxWindow* window);
+
+    /**
+        Returns the size of the given element in DIPs.
+
+        This function is typically more convenient to override, as it can just
+        return the same value as was passed to SetElementSize(), but it
+        shouldn't usually be called, use GetElementSizeForWindow() instead.
+
+        @param elementId
+            One of ::wxAuiToolBarArtSetting elements.
+        @return
+            The size of the element in DIPs.
+     */
+    virtual int GetElementSize(int elementId) = 0;
+
+    /**
+        Sets the size of the given element in DIPs.
+
+        Note that this function takes the size in DPI-independent pixels and
+        this size will be scaled by the factor depending on the DPI being
+        actually used by GetElementSizeForWindow(). In particular, do _not_ use
+        wxWindow::FromDIP() for the @a size argument passed to this function.
+
+        @param elementId
+            One of ::wxAuiToolBarArtSetting elements.
+        @param size
+            The size of the element in DIPs.
+     */
+    virtual void SetElementSize(int elementId, int size) = 0;
 
     virtual int ShowDropDown(
                          wxWindow* wnd,
@@ -638,8 +686,24 @@ class wxAuiDefaultToolBarArt : public wxAuiToolBarArt
                 wxWindow* wnd,
                 const wxAuiToolBarItem& item);
 
-    virtual int GetElementSize(int element);
-    virtual void SetElementSize(int element_id, int size);
+    /**
+        Return the size of the element.
+
+        Implement the base class pure virtual function by returning the default
+        element size or the last value passed to SetElementSize().
+     */
+    virtual int GetElementSize(int elementId);
+
+    /**
+        Change the size of the element.
+
+        Implements the base class pure virtual function by storing the value to
+        be returned by GetElementSize() and used by GetElementSizeForWindow().
+
+        As for the base class function, @a size is in DIPs, _not_ pixels, so
+        wxWindow::FromDIP() should _not_ be used for it.
+     */
+    virtual void SetElementSize(int elementId, int size);
 
     virtual int ShowDropDown(wxWindow* wnd,
                              const wxAuiToolBarItemArray& items);
@@ -925,7 +989,19 @@ class wxAuiToolBar : public wxControl
     void SetToolProportion(int toolId, int proportion);
     int  GetToolProportion(int toolId) const;
 
+    /**
+        Set the tool separation in DIPs.
+
+        Please note that because this function passes @a separation to
+        wxAuiToolBarArt::SetElementSize() it should be given in DIPs, not in
+        (logical) pixels. I.e. do _not_ use wxWindow::FromDIP() for this
+        function argument.
+     */
     void SetToolSeparation(int separation);
+
+    /**
+        Returns the separation between tools in logical pixels.
+     */
     int GetToolSeparation() const;
 
     void SetToolSticky(int toolId, bool sticky);

interface/wx/aui/dockart.h

@@ -265,10 +265,34 @@ class wxAuiDockArt
     /**
         Get the value of a certain setting.
         @a id can be one of the size values of @b wxAuiPaneDockArtSetting.
-        Sizes are in DPI-independent pixel values.
+
+        This function returns the same value that was set by SetMetric(), use
+        GetMetricForWindow() to get the value appropriate for the given window
+        for metrics that express sizes.
     */
     virtual int GetMetric(int id) = 0;
 
+    /**
+        Get metric value scaled by the DPI of the given window if appropriate.
+
+        Call this function instead of GetMetric() to get the metric value
+        scaled by the window DPI for the metrics that are expressed in pixels
+        and must be scaled.
+
+        The default implementation doesn't scale ::wxAUI_DOCKART_SASH_SIZE and
+        ::wxAUI_DOCKART_PANE_BORDER_SIZE metrics in order to allow setting them
+        to just a single pixel (which is the default value for the latter in
+        wxAuiDefaultDockArt) even in high DPI. You may override this function
+        in your custom art implementation to scale these metrics too if you
+        prefer to have thicker borders in high DPI.
+
+        Note that values of ::wxAUI_DOCKART_GRADIENT_TYPE are not expressed in
+        pixels and so should never be scaled by this function.
+
+        @since 3.3.0
+     */
+    virtual int GetMetricForWindow(int id, wxWindow* window);
+
     /**
         Set a certain setting with the value @e colour.
         @a id can be one of the colour values of @b wxAuiPaneDockArtSetting.
@@ -282,8 +306,11 @@ class wxAuiDockArt
 
     /**
         Set a certain setting with the value @e new_val.
+
         @a id can be one of the size values of @b wxAuiPaneDockArtSetting.
-        Sizes should be in DPI-independent pixel values.
+
+        The interpretation of @a new_val depends on the metric being set, see
+        GetMetricForWindow().
     */
     virtual void SetMetric(int id, int new_val) = 0;
 };