Issue #156: We should be able to take ranges of std::string for choic…

…es, list boxes, etc
rmpowell77 · Nov 30, 2023 · ce0bf68 · ce0bf68
1 parent 900f77e
commit ce0bf68
Show file tree

Hide file tree

Showing 31 changed files with 654 additions and 196 deletions.
diff --git a/LATEST_RELEASE_NOTES.md b/LATEST_RELEASE_NOTES.md
@@ -5,5 +5,6 @@ Bugs addressed in this release:
 Other changes:
 
 * [#144](../../issues/144) RadioButtons are too easy to lay out incorrectly because of withStyle
+* [#156](../../issues/156) We should be able to take ranges of std::string for choices, list boxes, etc
 * [#157](../../issues/157) Text needs withWrap
 
diff --git a/README.md b/README.md
@@ -50,15 +50,15 @@ ExampleDialog::ExampleDialog(wxWindow* parent)
             Text { "GCD = " },
             result = Text { "1" },
         },
-        RadioBox { "&Log Levels:", { "&Information", "&Warning", "&Error", "&None", "&Custom" } }
+        RadioBox { "&Log Levels:", RadioBox::withChoices {}, { "&Information", "&Warning", "&Error", "&None", "&Custom" } }
             .setStyle(wxRA_SPECIFY_ROWS)
             .withMajorDim(1)
             .withSelection(1),
 
         HSizer {
             "Details",
             CheckBox { "Show" },
-            Choice { { "Less", "More" } },
+            Choice { "Less", "More" },
             TextCtrl { wxSizerFlags(1).Expand().Border(), "Fill in the blank" }
                 .withStyle(wxALIGN_LEFT),
         },

diff --git a/docs/ProgrammersGuide.md b/docs/ProgrammersGuide.md
@@ -215,7 +215,7 @@ Essentially, you supply a object that converts to `wxSizer*` or `wxWindow*`, or
         HSizer {
             "Details",
             CheckBox { "Show" },
-            Choice { { "Less", "More" } },
+            Choice { "Less", "More" },
             TextCtrl { wxSizerFlags(1).Expand().Border(), "Fill in the blank" }
                 .withStyle(wxALIGN_LEFT),
         },
@@ -334,6 +334,6 @@ An example of how to use could be as follows:
 
 #### Misc notes.
 
-`wxRadioBox` requires a list of strings to operate correctly, so `RadioBox` requires a `std::vector` of strings.  Note, you *can* provide an empty `std::vector`, but a crash may occur if you do so.
+`wxRadioBox` requires a list of strings to operate correctly, so `RadioBox` requires a `std::vector` of strings.  Note, you *can* provide an empty `std::vector`, but a crash may occur if you do so.  In addition, because `RadioBox` can take in a string as a "caption", a key-value is necessary to prevent `char`-arrays from being interpreted as `initializer_list<std::string>`.
 
 `Button` and `BitmapButton` support the `setDefault` function which allows you to set them as the default button.
diff --git a/docs/src/docs/ProgrammersGuide.md b/docs/src/docs/ProgrammersGuide.md
@@ -208,6 +208,6 @@ An example of how to use could be as follows:
 
 #### Misc notes.
 
-`wxRadioBox` requires a list of strings to operate correctly, so `RadioBox` requires a `std::vector` of strings.  Note, you *can* provide an empty `std::vector`, but a crash may occur if you do so.
+`wxRadioBox` requires a list of strings to operate correctly, so `RadioBox` requires a `std::vector` of strings.  Note, you *can* provide an empty `std::vector`, but a crash may occur if you do so.  In addition, because `RadioBox` can take in a string as a "caption", a key-value is necessary to prevent `char`-arrays from being interpreted as `initializer_list<std::string>`.
 
 `Button` and `BitmapButton` support the `setDefault` function which allows you to set them as the default button.
diff --git a/examples/HelloWorld/ExtendedExample.cpp b/examples/HelloWorld/ExtendedExample.cpp
@@ -49,7 +49,7 @@ ExtendedExample::ExtendedExample(wxWindow* parent)
             BitmapButton { wxBitmap {} },
         },
         HSizer {
-            BitmapComboBox { { std::tuple { "", wxBitmap {} } } },
+            BitmapComboBox { std::tuple { "", wxBitmap {} } },
         },
         HSizer {
             BitmapToggleButton { wxBitmap {} },
@@ -81,10 +81,10 @@ ExtendedExample::ExtendedExample(wxWindow* parent)
             Line {},
         },
         HSizer {
-            ListBox { {} },
+            ListBox {},
         },
         HSizer {
-            RadioBox { std::vector<wxString> { "hello" } },
+            RadioBox { RadioBox::withChoices {}, "hello" },
         },
         HSizer {
             Slider {},

diff --git a/examples/HelloWorld/HelloWorld.cpp b/examples/HelloWorld/HelloWorld.cpp
@@ -311,7 +311,7 @@ ExampleDialog::ExampleDialog(wxWindow* parent)
             result = Text { "1" },
         },
         // endsnippet withwxUI
-        RadioBox { "&Log Levels:", { "&Information", "&Warning", "&Error", "&None", "&Custom" } }
+        RadioBox { "&Log Levels:", RadioBox::withChoices {}, { "&Information", "&Warning", "&Error", "&None", "&Custom" } }
             .setStyle(wxRA_SPECIFY_ROWS)
             .withMajorDim(1)
             .withSelection(1),
@@ -320,7 +320,7 @@ ExampleDialog::ExampleDialog(wxWindow* parent)
         HSizer {
             "Details",
             CheckBox { "Show" },
-            Choice { { "Less", "More" } },
+            Choice { "Less", "More" },
             TextCtrl { wxSizerFlags(1).Expand().Border(), "Fill in the blank" }
                 .withStyle(wxALIGN_LEFT),
         },

diff --git a/include/wxUI/Bitmap.h b/include/wxUI/Bitmap.h
@@ -34,14 +34,19 @@ namespace wxUI {
 struct Bitmap : public details::WidgetDetails<Bitmap, wxStaticBitmap> {
     using super = details::WidgetDetails<Bitmap, wxStaticBitmap>;
 
+    explicit Bitmap(wxBitmap const& bitmap)
+        : Bitmap(wxID_ANY, bitmap)
+    {
+    }
+
     Bitmap(wxWindowID identity, wxBitmap const& bitmap)
         : super(identity)
         , bitmap(bitmap)
     {
     }
 
-    explicit Bitmap(wxBitmap const& bitmap)
-        : Bitmap(wxID_ANY, bitmap)
+    explicit Bitmap(wxSizerFlags const& flags, wxBitmap const& bitmap)
+        : Bitmap(flags, wxID_ANY, bitmap)
     {
     }
 
@@ -51,11 +56,6 @@ struct Bitmap : public details::WidgetDetails<Bitmap, wxStaticBitmap> {
     {
     }
 
-    explicit Bitmap(wxSizerFlags const& flags, wxBitmap const& bitmap)
-        : Bitmap(flags, wxID_ANY, bitmap)
-    {
-    }
-
     struct Proxy : super::WidgetProxy {
         PROXY_BOILERPLATE();
     };

diff --git a/include/wxUI/BitmapButton.h b/include/wxUI/BitmapButton.h
@@ -34,14 +34,19 @@ namespace wxUI {
 struct BitmapButton : public details::WidgetDetails<BitmapButton, wxBitmapButton> {
     using super = details::WidgetDetails<BitmapButton, wxBitmapButton>;
 
+    explicit BitmapButton(wxBitmap const& bitmap)
+        : BitmapButton(wxID_ANY, bitmap)
+    {
+    }
+
     BitmapButton(wxWindowID identity, wxBitmap const& bitmap)
         : super(identity)
         , bitmap(bitmap)
     {
     }
 
-    explicit BitmapButton(wxBitmap const& bitmap)
-        : BitmapButton(wxID_ANY, bitmap)
+    BitmapButton(wxSizerFlags const& flags, wxBitmap const& bitmap)
+        : BitmapButton(flags, wxID_ANY, bitmap)
     {
     }
 
@@ -51,11 +56,6 @@ struct BitmapButton : public details::WidgetDetails<BitmapButton, wxBitmapButton
     {
     }
 
-    BitmapButton(wxSizerFlags const& flags, wxBitmap const& bitmap)
-        : BitmapButton(flags, wxID_ANY, bitmap)
-    {
-    }
-
     auto setDefault() -> BitmapButton&
     {
         isDefault = true;

diff --git a/include/wxUI/BitmapComboBox.h b/include/wxUI/BitmapComboBox.h
@@ -25,6 +25,7 @@ SOFTWARE.
 
 #include "GetterSetter.h"
 #include "Widget.h"
+#include <ranges>
 #include <wx/bmpcbox.h>
 
 #include "HelperMacros.h"
@@ -35,7 +36,12 @@ namespace wxUI {
 struct BitmapComboBox : public details::WidgetDetails<BitmapComboBox, wxBitmapComboBox> {
     using super = details::WidgetDetails<BitmapComboBox, wxBitmapComboBox>;
 
-    BitmapComboBox(wxWindowID identity, std::vector<std::tuple<wxString, wxBitmap>> const& bitmapChoices)
+    explicit BitmapComboBox(std::initializer_list<std::tuple<std::string, wxBitmap>> bitmapChoices)
+        : BitmapComboBox(wxID_ANY, bitmapChoices)
+    {
+    }
+
+    BitmapComboBox(wxWindowID identity, std::initializer_list<std::tuple<std::string, wxBitmap>> bitmapChoices)
         : super(identity)
         , choices([&bitmapChoices] {
             std::vector<wxString> result;
@@ -56,12 +62,12 @@ struct BitmapComboBox : public details::WidgetDetails<BitmapComboBox, wxBitmapCo
     {
     }
 
-    explicit BitmapComboBox(std::vector<std::tuple<wxString, wxBitmap>> const& bitmapChoices)
-        : BitmapComboBox(wxID_ANY, bitmapChoices)
+    BitmapComboBox(wxSizerFlags const& flags, std::initializer_list<std::tuple<std::string, wxBitmap>> bitmapChoices)
+        : BitmapComboBox(flags, wxID_ANY, bitmapChoices)
     {
     }
 
-    BitmapComboBox(wxSizerFlags const& flags, wxWindowID identity, std::vector<std::tuple<wxString, wxBitmap>> const& bitmapChoices)
+    BitmapComboBox(wxSizerFlags const& flags, wxWindowID identity, std::initializer_list<std::tuple<std::string, wxBitmap>> bitmapChoices)
         : super(flags, identity)
         , choices([&bitmapChoices] {
             std::vector<wxString> result;
@@ -82,8 +88,27 @@ struct BitmapComboBox : public details::WidgetDetails<BitmapComboBox, wxBitmapCo
     {
     }
 
-    BitmapComboBox(wxSizerFlags const& flags, std::vector<std::tuple<wxString, wxBitmap>> const& bitmapChoices)
-        : BitmapComboBox(flags, wxID_ANY, bitmapChoices)
+    explicit BitmapComboBox(details::Ranges::input_range_of<std::tuple<wxString, wxBitmap>> auto&& choices)
+        : BitmapComboBox(wxID_ANY, std::forward<decltype(choices)>(choices))
+    {
+    }
+
+    BitmapComboBox(wxWindowID identity, details::Ranges::input_range_of<std::tuple<wxString, wxBitmap>> auto&& choices)
+        : super(identity)
+        , choices(details::Ranges::ToVector<wxString>(choices | std::views::transform([](auto&& item) { return std::get<0>(item); })))
+        , bitmaps(details::Ranges::ToVector<wxBitmap>(choices | std::views::transform([](auto&& item) { return std::get<1>(item); })))
+    {
+    }
+
+    BitmapComboBox(wxSizerFlags const& flags, details::Ranges::input_range_of<std::tuple<wxString, wxBitmap>> auto&& choices)
+        : BitmapComboBox(flags, wxID_ANY, std::forward<decltype(choices)>(choices))
+    {
+    }
+
+    BitmapComboBox(wxSizerFlags const& flags, wxWindowID identity, details::Ranges::input_range_of<std::tuple<wxString, wxBitmap>> auto&& choices)
+        : super(flags, identity)
+        , choices(details::Ranges::ToVector<wxString>(choices | std::views::transform([](auto&& item) { return std::get<0>(item); })))
+        , bitmaps(details::Ranges::ToVector<wxBitmap>(choices | std::views::transform([](auto&& item) { return std::get<1>(item); })))
     {
     }
 

diff --git a/include/wxUI/BitmapToggleButton.h b/include/wxUI/BitmapToggleButton.h
@@ -35,15 +35,20 @@ namespace wxUI {
 struct BitmapToggleButton : public details::WidgetDetails<BitmapToggleButton, wxBitmapToggleButton> {
     using super = details::WidgetDetails<BitmapToggleButton, wxBitmapToggleButton>;
 
+    explicit BitmapToggleButton(wxBitmap const& bitmap, std::optional<wxBitmap> bitmapPressed = {})
+        : BitmapToggleButton(wxID_ANY, bitmap, std::move(bitmapPressed))
+    {
+    }
+
     BitmapToggleButton(wxWindowID identity, wxBitmap const& bitmap, std::optional<wxBitmap> bitmapPressed = {})
         : super(identity)
         , bitmap(bitmap)
         , bitmapPressed(std::move(bitmapPressed))
     {
     }
 
-    explicit BitmapToggleButton(wxBitmap const& bitmap, std::optional<wxBitmap> bitmapPressed = {})
-        : BitmapToggleButton(wxID_ANY, bitmap, std::move(bitmapPressed))
+    BitmapToggleButton(wxSizerFlags const& flags, wxBitmap const& bitmap, std::optional<wxBitmap> bitmapPressed = {})
+        : BitmapToggleButton(flags, wxID_ANY, bitmap, std::move(bitmapPressed))
     {
     }
 
@@ -54,11 +59,6 @@ struct BitmapToggleButton : public details::WidgetDetails<BitmapToggleButton, wx
     {
     }
 
-    BitmapToggleButton(wxSizerFlags const& flags, wxBitmap const& bitmap, std::optional<wxBitmap> bitmapPressed = {})
-        : BitmapToggleButton(flags, wxID_ANY, bitmap, std::move(bitmapPressed))
-    {
-    }
-
     using super::bind;
     template <typename Function>
     auto bind(Function func)

diff --git a/include/wxUI/Button.h b/include/wxUI/Button.h
@@ -35,19 +35,13 @@ struct Button : public details::WidgetDetails<Button, wxButton> {
     using super = details::WidgetDetails<Button, wxButton>;
     using details::WidgetDetails<Button, wxButton>::underlying_t;
 
-    explicit Button(wxWindowID identity, std::string text = "")
-        : super(identity)
-        , text(std::move(text))
-    {
-    }
-
     explicit Button(std::string text = "")
         : Button(wxID_ANY, std::move(text))
     {
     }
 
-    explicit Button(wxSizerFlags const& flags, wxWindowID identity, std::string text = "")
-        : super(flags, identity)
+    explicit Button(wxWindowID identity, std::string text = "")
+        : super(identity)
         , text(std::move(text))
     {
     }
@@ -57,6 +51,12 @@ struct Button : public details::WidgetDetails<Button, wxButton> {
     {
     }
 
+    Button(wxSizerFlags const& flags, wxWindowID identity, std::string text = "")
+        : super(flags, identity)
+        , text(std::move(text))
+    {
+    }
+
     auto setDefault() -> Button&
     {
         isDefault = true;

diff --git a/include/wxUI/CheckBox.h b/include/wxUI/CheckBox.h
@@ -35,19 +35,13 @@ namespace wxUI {
 struct CheckBox : public details::WidgetDetails<CheckBox, wxCheckBox> {
     using super = details::WidgetDetails<CheckBox, wxCheckBox>;
 
-    explicit CheckBox(wxWindowID identity, std::string text = "")
-        : super(identity)
-        , text(std::move(text))
-    {
-    }
-
     explicit CheckBox(std::string text = "")
         : CheckBox(wxID_ANY, std::move(text))
     {
     }
 
-    explicit CheckBox(wxSizerFlags const& flags, wxWindowID identity, std::string text = "")
-        : super(flags, identity)
+    explicit CheckBox(wxWindowID identity, std::string text = "")
+        : super(identity)
         , text(std::move(text))
     {
     }
@@ -57,6 +51,12 @@ struct CheckBox : public details::WidgetDetails<CheckBox, wxCheckBox> {
     {
     }
 
+    CheckBox(wxSizerFlags const& flags, wxWindowID identity, std::string text = "")
+        : super(flags, identity)
+        , text(std::move(text))
+    {
+    }
+
     auto createImpl(wxWindow* parent) -> wxWindow* override
     {
         auto* widget = setProxy(new underlying_t(parent, getIdentity(), text, getPos(), getSize(), getStyle()));

diff --git a/include/wxUI/Choice.h b/include/wxUI/Choice.h
@@ -35,25 +35,47 @@ namespace wxUI {
 struct Choice : public details::WidgetDetails<Choice, wxChoice> {
     using super = details::WidgetDetails<Choice, wxChoice>;
 
-    explicit Choice(wxWindowID identity, std::vector<wxString> choices = {})
+    Choice(std::initializer_list<std::string> choices = {})
+        : Choice(wxID_ANY, choices)
+    {
+    }
+
+    explicit Choice(wxWindowID identity, std::initializer_list<std::string> choices = {})
         : super(identity)
-        , choices(std::move(choices))
+        , choices(details::Ranges::convertTo(choices))
     {
     }
 
-    explicit Choice(std::vector<wxString> choices = {})
-        : Choice(wxID_ANY, std::move(choices))
+    explicit Choice(wxSizerFlags const& flags, std::initializer_list<std::string> choices = {})
+        : Choice(flags, wxID_ANY, choices)
     {
     }
 
-    explicit Choice(wxSizerFlags const& flags, wxWindowID identity, std::vector<wxString> choices = {})
+    Choice(wxSizerFlags const& flags, wxWindowID identity, std::initializer_list<std::string> choices = {})
         : super(flags, identity)
-        , choices(std::move(choices))
+        , choices(details::Ranges::convertTo(choices))
+    {
+    }
+
+    explicit Choice(details::Ranges::input_range_of<wxString> auto&& choices)
+        : Choice(wxID_ANY, std::forward<decltype(choices)>(choices))
+    {
+    }
+
+    Choice(wxWindowID identity, details::Ranges::input_range_of<wxString> auto&& choices)
+        : super(identity)
+        , choices(details::Ranges::ToVector<wxString>(std::forward<decltype(choices)>(choices)))
     {
     }
 
-    explicit Choice(wxSizerFlags const& flags, std::vector<wxString> choices = {})
-        : Choice(flags, wxID_ANY, std::move(choices))
+    explicit Choice(wxSizerFlags const& flags, details::Ranges::input_range_of<wxString> auto&& choices)
+        : Choice(flags, wxID_ANY, std::forward<decltype(choices)>(choices))
+    {
+    }
+
+    explicit Choice(wxSizerFlags const& flags, wxWindowID identity, details::Ranges::input_range_of<wxString> auto&& choices)
+        : super(flags, identity)
+        , choices(details::Ranges::ToVector<wxString>(choices))
     {
     }