Merge pull request #168 from rmpowell77/dev/splitter_work

Issue #167: VSplitter and HSplitter proxy's are hard to use
rmpowell77 · Dec 26, 2023 · 4f60165 · 4f60165
2 parents bf3af5d + 01cce6f
commit 4f60165
Show file tree

Hide file tree

Showing 21 changed files with 62 additions and 44 deletions.
diff --git a/LATEST_RELEASE_NOTES.md b/LATEST_RELEASE_NOTES.md
@@ -9,4 +9,5 @@ Other changes:
 * [#157](../../issues/157) Text needs withWrap
 * [#161](../../issues/161) Need to have a setEnabled for Widgets
 * [#164](../../issues/164) Add ForEach, which would allow a list of Controllers to be added
+* [#167](../../issues/167) VSplitter and HSplitter proxy's are hard to use
 
diff --git a/include/wxUI/Bitmap.h b/include/wxUI/Bitmap.h
@@ -56,7 +56,7 @@ struct Bitmap : public details::WidgetDetails<Bitmap, wxStaticBitmap> {
     {
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
     };
     RULE_OF_SIX_BOILERPLATE(Bitmap);

diff --git a/include/wxUI/BitmapButton.h b/include/wxUI/BitmapButton.h
@@ -69,7 +69,7 @@ struct BitmapButton : public details::WidgetDetails<BitmapButton, wxBitmapButton
         return super::bind(wxEVT_BUTTON, func);
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
     };
     RULE_OF_SIX_BOILERPLATE(BitmapButton);

diff --git a/include/wxUI/BitmapComboBox.h b/include/wxUI/BitmapComboBox.h
@@ -125,7 +125,7 @@ struct BitmapComboBox : public details::WidgetDetails<BitmapComboBox, wxBitmapCo
         return super::bind(wxEVT_COMBOBOX, func);
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
         [[nodiscard]] auto value() const
         {

diff --git a/include/wxUI/BitmapToggleButton.h b/include/wxUI/BitmapToggleButton.h
@@ -66,7 +66,7 @@ struct BitmapToggleButton : public details::WidgetDetails<BitmapToggleButton, wx
         return super::bind(wxEVT_TOGGLEBUTTON, func);
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
         [[nodiscard]] auto value() const
         {

diff --git a/include/wxUI/Button.h b/include/wxUI/Button.h
@@ -70,7 +70,7 @@ struct Button : public details::WidgetDetails<Button, wxButton> {
         return super::bind(wxEVT_BUTTON, func);
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
     };
     RULE_OF_SIX_BOILERPLATE(Button);

diff --git a/include/wxUI/CheckBox.h b/include/wxUI/CheckBox.h
@@ -77,7 +77,7 @@ struct CheckBox : public details::WidgetDetails<CheckBox, wxCheckBox> {
         return super::bind(wxEVT_CHECKBOX, func);
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
         [[nodiscard]] auto value() const
         {

diff --git a/include/wxUI/Choice.h b/include/wxUI/Choice.h
@@ -92,7 +92,7 @@ struct Choice : public details::WidgetDetails<Choice, wxChoice> {
         return super::bind(wxEVT_CHOICE, func);
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
         [[nodiscard]] auto selection() const
         {

diff --git a/include/wxUI/ComboBox.h b/include/wxUI/ComboBox.h
@@ -102,7 +102,7 @@ struct ComboBox : public details::WidgetDetails<ComboBox, wxComboBox> {
         return super::bind(wxEVT_COMBOBOX, func);
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
         [[nodiscard]] auto value() const
         {

diff --git a/include/wxUI/Hyperlink.h b/include/wxUI/Hyperlink.h
@@ -58,7 +58,7 @@ struct Hyperlink : public details::WidgetDetails<Hyperlink, wxHyperlinkCtrl> {
     {
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
     };
     RULE_OF_SIX_BOILERPLATE(Hyperlink);

diff --git a/include/wxUI/Line.h b/include/wxUI/Line.h
@@ -49,7 +49,7 @@ struct Line : public details::WidgetDetails<Line, wxStaticLine> {
         return setProxy(new underlying_t(parent, getIdentity(), getPos(), getSize(), getStyle()));
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
     };
     RULE_OF_SIX_BOILERPLATE(Line);

diff --git a/include/wxUI/ListBox.h b/include/wxUI/ListBox.h
@@ -98,7 +98,7 @@ struct ListBox : public details::WidgetDetails<ListBox, wxListBox> {
         return super::bind(wxEVT_LISTBOX, func);
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
         [[nodiscard]] auto selection() const
         {

diff --git a/include/wxUI/RadioBox.h b/include/wxUI/RadioBox.h
@@ -173,7 +173,7 @@ struct RadioBox : details::WidgetDetails<RadioBox, wxRadioBox> {
         return super::bind(wxEVT_RADIOBOX, func);
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
         [[nodiscard]] auto selection() const
         {

diff --git a/include/wxUI/Slider.h b/include/wxUI/Slider.h
@@ -66,7 +66,7 @@ struct Slider : public details::WidgetDetails<Slider, wxSlider> {
         return super::bind(wxEVT_SLIDER, func);
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
         [[nodiscard]] auto value() const
         {

diff --git a/include/wxUI/SpinCtrl.h b/include/wxUI/SpinCtrl.h
@@ -74,7 +74,7 @@ struct SpinCtrl : public details::WidgetDetails<SpinCtrl, wxSpinCtrl> {
         return super::bind(wxEVT_SPINCTRL, func);
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
 
         [[nodiscard]] auto value() const

diff --git a/include/wxUI/Splitter.h b/include/wxUI/Splitter.h
@@ -84,7 +84,7 @@ struct HSplitter : public details::WidgetDetails<HSplitter<W1, W2>, wxSplitterWi
     {
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
     };
     RULE_OF_SIX_BOILERPLATE(HSplitter);
@@ -148,7 +148,7 @@ struct VSplitter : public details::WidgetDetails<VSplitter<W1, W2>, wxSplitterWi
     {
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
     };
     RULE_OF_SIX_BOILERPLATE(VSplitter);
@@ -164,5 +164,9 @@ struct VSplitter : public details::WidgetDetails<VSplitter<W1, W2>, wxSplitterWi
     }
 };
 
+struct SplitterProxy : details::WidgetProxy<wxSplitterWindow> {
+    PROXY_BOILERPLATE();
+};
+
 }
 #include "ZapMacros.h"
diff --git a/include/wxUI/Text.h b/include/wxUI/Text.h
@@ -63,7 +63,7 @@ struct Text : public details::WidgetDetails<Text, wxStaticText> {
         return *this;
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
 
         [[nodiscard]] auto label() const

diff --git a/include/wxUI/TextCtrl.h b/include/wxUI/TextCtrl.h
@@ -65,7 +65,7 @@ struct TextCtrl : public details::WidgetDetails<TextCtrl, wxTextCtrl> {
         return super::bind(wxEVT_TEXT, func);
     }
 
-    struct Proxy : super::WidgetProxy {
+    struct Proxy : details::WidgetProxy<underlying_t> {
         PROXY_BOILERPLATE();
 
         [[nodiscard]] auto label() const

diff --git a/include/wxUI/Widget.h b/include/wxUI/Widget.h
@@ -89,8 +89,26 @@ struct overloaded : Ts... {
 template <class... Ts>
 overloaded(Ts...) -> overloaded<Ts...>;
 
-template <typename Controller, typename Underlying>
-struct WidgetProxy;
+template <typename Underlying>
+struct WidgetProxy {
+    [[nodiscard]] auto control() const -> Underlying*
+    {
+        if (!controller) {
+            throw std::runtime_error("Proxy class has not been attached");
+        }
+        return controller;
+    }
+
+    void setUnderlying(Underlying* control)
+    {
+        controller = control;
+    }
+
+    auto operator->() const { return control(); }
+
+private:
+    Underlying* controller {};
+};
 
 // The WidgetDetails are the base class of the Controllers.  The common details
 // across many controllers are stored in the base class.
@@ -103,27 +121,6 @@ struct WidgetDetails {
     using Controller = ConcreteWidget;
     using underlying_t = Underlying;
 
-    struct WidgetProxy {
-        using Controller = ConcreteWidget;
-        [[nodiscard]] auto control() const -> Underlying*
-        {
-            if (!controller) {
-                throw std::runtime_error("Proxy class has not been attached");
-            }
-            return controller;
-        }
-
-        void setUnderlying(Underlying* control)
-        {
-            controller = control;
-        }
-
-        auto operator->() const { return control(); }
-
-    private:
-        Underlying* controller {};
-    };
-
     struct WithStyle {
         int64_t mStyle;
     };
@@ -258,7 +255,7 @@ struct WidgetDetails {
     auto getSize() const { return size; }
     auto getStyle() const { return style; }
 
-    void setProxyHandle(WidgetProxy* proxy)
+    void setProxyHandle(WidgetProxy<Underlying>* proxy)
     {
         proxyHandle = proxy;
     }
@@ -267,7 +264,7 @@ struct WidgetDetails {
     auto setProxy(Underlying* widget) -> Underlying*
     {
         if (proxyHandle) {
-            (*proxyHandle)->setUnderlying(widget);
+            proxyHandle->setUnderlying(widget);
         }
         return widget;
     }
@@ -285,7 +282,7 @@ struct WidgetDetails {
     int64_t style {};
     bool enabled = true;
     std::optional<wxFontInfo> fontInfo {};
-    std::optional<WidgetProxy*> proxyHandle {};
+    details::WidgetProxy<Underlying>* proxyHandle {}; // optional WidgetProxy
     std::vector<BindInfo> boundedFunctions;
 };
 

diff --git a/tests/wxUI_HSplitterTests.cpp b/tests/wxUI_HSplitterTests.cpp
@@ -74,6 +74,14 @@ TEST_CASE("HSplitter")
         CHECK(10000 == window->GetId());
     }
 
+    SECTION("proxy")
+    {
+        wxFrame frame { nullptr, wxID_ANY, "" };
+        wxUI::SplitterProxy proxy;
+        auto uut = proxy = TypeUnderTest { wxUI::TextCtrl {}, wxUI::TextCtrl {} };
+        [[maybe_unused]] auto* window = dynamic_cast<TypeUnderTest::underlying_t*>(uut.create(&frame));
+    }
+
     COMMON_TESTS(HSplitterTestPolicy)
 }
 // NOLINTEND(cppcoreguidelines-avoid-magic-numbers, readability-magic-numbers, readability-function-cognitive-complexity, misc-use-anonymous-namespace, cppcoreguidelines-avoid-do-while)
diff --git a/tests/wxUI_VSplitterTests.cpp b/tests/wxUI_VSplitterTests.cpp
@@ -74,6 +74,14 @@ TEST_CASE("VSplitter")
         CHECK(10000 == window->GetId());
     }
 
+    SECTION("proxy")
+    {
+        wxFrame frame { nullptr, wxID_ANY, "" };
+        wxUI::SplitterProxy proxy;
+        auto uut = proxy = TypeUnderTest { wxUI::TextCtrl {}, wxUI::TextCtrl {} };
+        [[maybe_unused]] auto* window = dynamic_cast<TypeUnderTest::underlying_t*>(uut.create(&frame));
+    }
+
     COMMON_TESTS(VSplitterTestPolicy)
 }
 // NOLINTEND(cppcoreguidelines-avoid-magic-numbers, readability-magic-numbers, readability-function-cognitive-complexity, misc-use-anonymous-namespace, cppcoreguidelines-avoid-do-while)