From 873bf396b904ce477a238f22d1891e1b03f24eff Mon Sep 17 00:00:00 2001 From: Felix Morgner Date: Tue, 29 Apr 2025 15:55:30 +0200 Subject: ui: convert editor into a template_widget --- ui/CMakeLists.txt | 4 +- ui/include/turns/ui/widgets/fwd.hpp | 1 + ui/include/turns/ui/widgets/participant_editor.hpp | 73 +++++++++++ ui/include/turns/ui/windows/fwd.hpp | 1 - ui/include/turns/ui/windows/participant_editor.hpp | 54 -------- ui/src/init.cpp | 2 + ui/src/widgets/participant_editor.cpp | 139 +++++++++++++++++++++ ui/src/widgets/participant_editor.ui | 71 +++++++++++ ui/src/windows/participant_editor.cpp | 106 ---------------- ui/src/windows/participant_editor.ui | 71 ----------- ui/src/windows/tracker/actions.cpp | 13 +- ui/tests/widgets/participant_editor.cpp | 108 ++++++++++++++++ ui/tests/windows/participant_editor.cpp | 113 ----------------- ui/tests/windows/resources.cpp | 10 -- ui/ui.cmb | 2 +- 15 files changed, 400 insertions(+), 368 deletions(-) create mode 100644 ui/include/turns/ui/widgets/participant_editor.hpp delete mode 100644 ui/include/turns/ui/windows/participant_editor.hpp create mode 100644 ui/src/widgets/participant_editor.cpp create mode 100644 ui/src/widgets/participant_editor.ui delete mode 100644 ui/src/windows/participant_editor.cpp delete mode 100644 ui/src/windows/participant_editor.ui create mode 100644 ui/tests/widgets/participant_editor.cpp delete mode 100644 ui/tests/windows/participant_editor.cpp (limited to 'ui') diff --git a/ui/CMakeLists.txt b/ui/CMakeLists.txt index 736db84..212559c 100644 --- a/ui/CMakeLists.txt +++ b/ui/CMakeLists.txt @@ -2,10 +2,10 @@ add_library("ui" "src/init.cpp" + "src/widgets/participant_editor.cpp" "src/widgets/participant_row.cpp" "src/widgets/preferences.cpp" "src/widgets/turn_order_view.cpp" - "src/windows/participant_editor.cpp" "src/windows/tracker.cpp" "src/windows/tracker/actions.cpp" "src/windows/tracker/event_handlers.cpp" @@ -50,7 +50,7 @@ add_executable("ui-tests" "tests/gtk_test_init.cpp" "tests/widgets/participant_row.cpp" - "tests/windows/participant_editor.cpp" + "tests/widgets/participant_editor.cpp" "tests/windows/resources.cpp" "tests/windows/tracker.cpp" ) diff --git a/ui/include/turns/ui/widgets/fwd.hpp b/ui/include/turns/ui/widgets/fwd.hpp index 7bf8714..69f324d 100644 --- a/ui/include/turns/ui/widgets/fwd.hpp +++ b/ui/include/turns/ui/widgets/fwd.hpp @@ -3,6 +3,7 @@ namespace turns::ui::widgets { + struct participant_editor; struct participant_row; struct turn_order_view; struct preferences; diff --git a/ui/include/turns/ui/widgets/participant_editor.hpp b/ui/include/turns/ui/widgets/participant_editor.hpp new file mode 100644 index 0000000..2fab47d --- /dev/null +++ b/ui/include/turns/ui/widgets/participant_editor.hpp @@ -0,0 +1,73 @@ +#ifndef TURNS_UI_WIDGETS_PARTICIPANT_EDITOR_HPP +#define TURNS_UI_WIDGETS_PARTICIPANT_EDITOR_HPP + +#include "turns/core/disposition.hpp" +#include "turns/core/fwd.hpp" +#include "turns/ui/widgets/template_widget.hpp" + +#include + +#include +#include + +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +#include + +namespace turns::ui::widgets +{ + + struct ParticipantEditor : template_widget + { + using SignalFinishedType = sigc::signal; + + auto constexpr inline static children = std::array{ + "disposition", + "finish", + "name", + "priority", + }; + + ParticipantEditor(Glib::RefPtr participant); + + [[nodiscard]] auto get_disposition() const -> core::disposition; + [[nodiscard]] auto get_name() const -> Glib::ustring; + [[nodiscard]] auto get_priority() const -> double; + + auto set_disposition(core::disposition value) -> void; + auto set_name(Glib::ustring const & value) -> void; + auto set_priority(double value) -> void; + + auto signal_finished() -> SignalFinishedType; + + private: + auto handle_finish_clicked() -> void; + auto handle_item_bind(Glib::RefPtr item) -> void; + auto handle_item_setup(Glib::RefPtr item) -> void; + + Adwaita::ComboRow * m_disposition; + Gtk::Button * m_finish; + Adwaita::EntryRow * m_name; + Adwaita::SpinRow * m_priority; + + Glib::RefPtr m_disposition_factory; + Glib::RefPtr m_disposition_model; + + Glib::RefPtr m_participant; + + SignalFinishedType m_signal_finished{}; + }; + +} // namespace turns::ui::widgets + +#endif \ No newline at end of file diff --git a/ui/include/turns/ui/windows/fwd.hpp b/ui/include/turns/ui/windows/fwd.hpp index f228d7b..14dbfd1 100644 --- a/ui/include/turns/ui/windows/fwd.hpp +++ b/ui/include/turns/ui/windows/fwd.hpp @@ -3,7 +3,6 @@ namespace turns::ui::windows { - struct participant_editor; struct tracker; } // namespace turns::ui::windows diff --git a/ui/include/turns/ui/windows/participant_editor.hpp b/ui/include/turns/ui/windows/participant_editor.hpp deleted file mode 100644 index 81ea3e1..0000000 --- a/ui/include/turns/ui/windows/participant_editor.hpp +++ /dev/null @@ -1,54 +0,0 @@ -#ifndef TURNS_UI_WINDOWS_PARTICIPANT_EDITOR_HPP -#define TURNS_UI_WINDOWS_PARTICIPANT_EDITOR_HPP - -#include "turns/core/fwd.hpp" - -#include - -#include -#include - -#include -#include -#include -#include -#include -#include - -#include -#include -#include -#include - -namespace turns::ui::windows -{ - - struct participant_editor : Adwaita::Dialog - { - using signal_finished_type = sigc::signal; - - participant_editor(BaseObjectType * base, Glib::RefPtr const builder, Glib::RefPtr obj = {}); - - auto signal_finished() -> signal_finished_type; - - private: - auto handle_finish_clicked() -> void; - auto handle_item_bind(Glib::RefPtr item) -> void; - auto handle_item_setup(Glib::RefPtr item) -> void; - - Adwaita::ComboRow * m_disposition; - Gtk::Button * m_finish; - Adwaita::EntryRow * m_name; - Adwaita::SpinRow * m_priority; - - Glib::RefPtr m_disposition_factory; - Glib::RefPtr m_disposition_model; - - Glib::RefPtr m_participant; - - signal_finished_type m_signal_finished{}; - }; - -} // namespace turns::ui::windows - -#endif \ No newline at end of file diff --git a/ui/src/init.cpp b/ui/src/init.cpp index f8c9e35..6139044 100644 --- a/ui/src/init.cpp +++ b/ui/src/init.cpp @@ -1,5 +1,6 @@ #include "turns/ui/init.hpp" +#include "turns/ui/widgets/participant_editor.hpp" #include "turns/ui/widgets/participant_row.hpp" #include "turns/ui/widgets/preferences.hpp" #include "turns/ui/widgets/turn_order_view.hpp" @@ -9,6 +10,7 @@ namespace turns::ui auto register_types() -> void { + static_cast(widgets::ParticipantEditor{{}}); static_cast(widgets::participant_row{{}}); static_cast(widgets::preferences{{}}); static_cast(widgets::turn_order_view{{}}); diff --git a/ui/src/widgets/participant_editor.cpp b/ui/src/widgets/participant_editor.cpp new file mode 100644 index 0000000..816ad09 --- /dev/null +++ b/ui/src/widgets/participant_editor.cpp @@ -0,0 +1,139 @@ +#include "turns/ui/widgets/participant_editor.hpp" + +#include "turns/core/disposition.hpp" +#include "turns/core/participant.hpp" +#include "turns/lang/messages.hpp" +#include "turns/ui/widgets/template_widget.hpp" + +#include + +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +#include + +#include +#include +#include + +namespace turns::ui::widgets +{ + namespace + { + auto constexpr static TYPE_NAME = "ParticipantEditor"; + auto constexpr static TEMPLATE = "/ch/arknet/Turns/widgets/participant_editor.ui"; + } // namespace + + ParticipantEditor::ParticipantEditor(Glib::RefPtr participant) + : Glib::ObjectBase{TYPE_NAME} + , template_widget{TEMPLATE} + , m_disposition{get_widget("disposition")} + , m_finish{get_widget("finish")} + , m_name{get_widget("name")} + , m_priority{get_widget("priority")} + , m_disposition_factory{Gtk::SignalListItemFactory::create()} + , m_disposition_model{Gtk::StringList::create()} + , m_participant{participant} + { + set_title(_(m_participant ? lang::edit_participant : lang::add_participant)); + + m_finish->signal_clicked().connect(sigc::mem_fun(*this, &ParticipantEditor::handle_finish_clicked)); + + for (auto n : std::views::iota(std::uint8_t{}, static_cast(core::disposition::END))) + { + m_disposition_model->append(presentation_name_for(core::disposition{n})); + } + + m_disposition_factory->signal_bind().connect(sigc::mem_fun(*this, &ParticipantEditor::handle_item_bind)); + m_disposition_factory->signal_setup().connect(sigc::mem_fun(*this, &ParticipantEditor::handle_item_setup)); + + m_disposition->set_factory(m_disposition_factory); + m_disposition->set_model(m_disposition_model); + + if (m_participant) + { + set_name(m_participant->property_name().get_value()); + set_priority(m_participant->property_priority()); + set_disposition(m_participant->property_disposition().get_value()); + } + } + + auto ParticipantEditor::get_disposition() const -> core::disposition + { + return static_cast(m_disposition->get_selected()); + } + + auto ParticipantEditor::get_name() const -> Glib::ustring + { + return m_name->get_text(); + } + + auto ParticipantEditor::get_priority() const -> double + { + return m_priority->get_value(); + } + + auto ParticipantEditor::set_disposition(core::disposition value) -> void + { + m_disposition->set_selected(static_cast(value)); + } + + auto ParticipantEditor::set_name(Glib::ustring const & value) -> void + { + m_name->set_text(value); + } + + auto ParticipantEditor::set_priority(double value) -> void + { + m_priority->set_value(value); + } + + auto ParticipantEditor::signal_finished() -> SignalFinishedType + { + return m_signal_finished; + } + + auto ParticipantEditor::handle_finish_clicked() -> void + { + auto name = m_name->get_text(); + auto priority = m_priority->get_value(); + auto disposition = static_cast(m_disposition->get_selected()); + + if (m_participant) + { + m_participant->property_name() = name; + m_participant->property_priority() = priority; + m_participant->property_disposition() = disposition; + } + + m_signal_finished.emit(name, priority, disposition); + close(); + } + + auto ParticipantEditor::handle_item_bind(Glib::RefPtr item) -> void + { + auto value = std::dynamic_pointer_cast(item->get_item())->get_string(); + dynamic_cast(item->get_child())->set_label(value); + } + + auto ParticipantEditor::handle_item_setup(Glib::RefPtr item) -> void + { + item->set_child(*Gtk::make_managed()); + } + +} // namespace turns::ui::widgets \ No newline at end of file diff --git a/ui/src/widgets/participant_editor.ui b/ui/src/widgets/participant_editor.ui new file mode 100644 index 0000000..6bcf83e --- /dev/null +++ b/ui/src/widgets/participant_editor.ui @@ -0,0 +1,71 @@ + + + + + + + + diff --git a/ui/src/windows/participant_editor.cpp b/ui/src/windows/participant_editor.cpp deleted file mode 100644 index 9177c9a..0000000 --- a/ui/src/windows/participant_editor.cpp +++ /dev/null @@ -1,106 +0,0 @@ -#include "turns/ui/windows/participant_editor.hpp" - -#include "turns/core/disposition.hpp" -#include "turns/core/participant.hpp" -#include "turns/lang/messages.hpp" - -#include - -#include -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include -#include -#include -#include - -#include -#include - -#include -#include -#include - -namespace turns::ui::windows -{ - - participant_editor::participant_editor(BaseObjectType * base, Glib::RefPtr const builder, Glib::RefPtr obj) - : Dialog{base} - , m_disposition{builder->get_widget("disposition")} - , m_finish{builder->get_widget("finish")} - , m_name{builder->get_widget("name")} - , m_priority{builder->get_widget("priority")} - , m_disposition_factory{Gtk::SignalListItemFactory::create()} - , m_disposition_model{Gtk::StringList::create()} - , m_participant{obj} - - { - set_title(_(obj ? lang::edit_participant : lang::add_participant)); - m_finish->signal_clicked().connect(sigc::mem_fun(*this, &participant_editor::handle_finish_clicked)); - - for (auto n : std::views::iota(std::uint8_t{}, static_cast(core::disposition::END))) - { - m_disposition_model->append(presentation_name_for(core::disposition{n})); - } - - m_disposition_factory->signal_bind().connect(sigc::mem_fun(*this, &participant_editor::handle_item_bind)); - m_disposition_factory->signal_setup().connect(sigc::mem_fun(*this, &participant_editor::handle_item_setup)); - - m_disposition->set_factory(m_disposition_factory); - m_disposition->set_model(m_disposition_model); - - if (m_participant) - { - m_name->set_text(m_participant->property_name().get_value()); - m_priority->set_value(m_participant->property_priority()); - m_disposition->set_selected(static_cast(m_participant->property_disposition().get_value())); - } - } - - auto participant_editor::signal_finished() -> signal_finished_type - { - return m_signal_finished; - } - - auto participant_editor::handle_finish_clicked() -> void - { - auto name = m_name->get_text(); - auto priority = m_priority->get_value(); - auto disposition = static_cast(m_disposition->get_selected()); - - if (m_participant) - { - m_participant->property_name() = name; - m_participant->property_priority() = priority; - m_participant->property_disposition() = disposition; - } - - m_signal_finished.emit(name, priority, disposition); - close(); - } - - auto participant_editor::handle_item_bind(Glib::RefPtr item) -> void - { - auto value = std::dynamic_pointer_cast(item->get_item())->get_string(); - dynamic_cast(item->get_child())->set_label(value); - } - - auto participant_editor::handle_item_setup(Glib::RefPtr item) -> void - { - item->set_child(*Gtk::make_managed()); - } - -} // namespace turns::ui::windows \ No newline at end of file diff --git a/ui/src/windows/participant_editor.ui b/ui/src/windows/participant_editor.ui deleted file mode 100644 index 1cbaf5c..0000000 --- a/ui/src/windows/participant_editor.ui +++ /dev/null @@ -1,71 +0,0 @@ - - - - - - - - - - - - - - True - 18 - 12 - 12 - 18 - vertical - 18 - start - - - - - Name - - - - - - - -1000.0 - 1.0 - 1000.0 - - - 1 - True - Priority - - - - - Disposition - - - - - - - True - Finish - - - - - - - - - - - - - True - - diff --git a/ui/src/windows/tracker/actions.cpp b/ui/src/windows/tracker/actions.cpp index bbb0c7e..54580ca 100644 --- a/ui/src/windows/tracker/actions.cpp +++ b/ui/src/windows/tracker/actions.cpp @@ -1,7 +1,7 @@ #include "turns/core/participant.hpp" #include "turns/lang/messages.hpp" +#include "turns/ui/widgets/participant_editor.hpp" #include "turns/ui/widgets/preferences.hpp" -#include "turns/ui/windows/participant_editor.hpp" #include "turns/ui/windows/tracker.hpp" #include @@ -35,12 +35,6 @@ namespace turns::ui::windows { namespace { - auto editor_for(Glib::RefPtr participant) - { - auto builder = Gtk::Builder::create_from_resource("/ch/arknet/Turns/windows/participant_editor.ui"); - return std::pair{builder, Gtk::Builder::get_widget_derived(builder, "participant_editor", participant)}; - } - auto file_filters() { auto filters = Gio::ListStore::create(); @@ -54,7 +48,7 @@ namespace turns::ui::windows auto tracker::add_participant() -> void { - auto [lifeline, dialog] = editor_for(nullptr); + auto dialog = Gtk::make_managed(nullptr); dialog->present(this); dialog->signal_finished().connect([this](auto n, auto p, auto d) { m_turn_order->add(n, p, d); }); } @@ -67,10 +61,9 @@ namespace turns::ui::windows auto tracker::edit_participant(Glib::VariantBase param) -> void { - static_cast(param); auto index = Glib::VariantBase::cast_dynamic>(param); auto participant = m_turn_order->get_typed_object(index.get()); - auto [lifeline, dialog] = editor_for(participant); + auto dialog = Gtk::make_managed(participant); dialog->present(this); } diff --git a/ui/tests/widgets/participant_editor.cpp b/ui/tests/widgets/participant_editor.cpp new file mode 100644 index 0000000..41ba5bd --- /dev/null +++ b/ui/tests/widgets/participant_editor.cpp @@ -0,0 +1,108 @@ +#include "turns/ui/widgets/participant_editor.hpp" + +#include "turns/core/disposition.hpp" +#include "turns/core/participant.hpp" +#include "turns/lang/messages.hpp" + +#include +#include + +#include +#include +#include + +#include +#include +#include + +#include +#include + +#include + +#include +#include + +namespace turns::ui::widgets::tests +{ + + TEST_CASE("A freshly constructed participant editor without a participant", "[windows]") + { + auto locale = GENERATE("en_US.UTF-8", "de_CH.UTF-8"); + setlocale(LC_ALL, locale); + + auto instance = std::make_shared(nullptr); + auto window = Gtk::Window{}; + + SECTION("was successfully constructed") + { + REQUIRE(instance); + } + + SECTION("has a non-empty title") + { + REQUIRE_FALSE(instance->get_title().empty()); + } + + SECTION("has its title set according to the active language") + { + REQUIRE(instance->get_title() == _(lang::add_participant)); + } + + SECTION("has an empty name") + { + REQUIRE(instance->get_name().empty()); + } + + SECTION("has a zero priority") + { + REQUIRE(instance->get_priority() == 0); + } + + SECTION("allows binding to the finished signal") + { + REQUIRE((instance->signal_finished().connect([](auto, auto, auto) {})).connected()); + } + } + + TEST_CASE("A freshly constructed participant editor with a participant", "[windows]") + { + auto locale = GENERATE("en_US.UTF-8", "de_CH.UTF-8"); + setlocale(LC_ALL, locale); + + auto participant = core::participant::create("Qibi Babblebranch", 12, core::disposition::neutral); + auto instance = std::make_shared(participant); + auto window = Gtk::Window{}; + + SECTION("was successfully constructed") + { + REQUIRE(instance); + } + + SECTION("has a non-empty title") + { + REQUIRE_FALSE(instance->get_title().empty()); + } + + SECTION("has its title set according to the active language") + { + REQUIRE(instance->get_title() == _(lang::edit_participant)); + } + + SECTION("has its name field set according to its participant") + { + REQUIRE(instance->get_name() == participant->property_name().get_value()); + } + + SECTION("has its priority field set according to its participant") + { + REQUIRE(instance->get_priority() == participant->property_priority()); + } + + SECTION("allows binding to the finished signal") + { + REQUIRE((instance->signal_finished().connect([](auto, auto, auto) {})).connected()); + } + } + +} // namespace turns::ui::widgets::tests \ No newline at end of file diff --git a/ui/tests/windows/participant_editor.cpp b/ui/tests/windows/participant_editor.cpp deleted file mode 100644 index 02e387f..0000000 --- a/ui/tests/windows/participant_editor.cpp +++ /dev/null @@ -1,113 +0,0 @@ -#include "turns/ui/windows/participant_editor.hpp" - -#include "turns/core/disposition.hpp" -#include "turns/core/participant.hpp" -#include "turns/lang/messages.hpp" - -#include -#include - -#include -#include -#include - -#include -#include -#include - -#include -#include - -#include - -#include - -namespace turns::ui::windows::tests -{ - - TEST_CASE("A freshly constructed participant editor without a participant", "[windows]") - { - auto locale = GENERATE("en_US.UTF-8", "de_CH.UTF-8"); - setlocale(LC_ALL, locale); - - auto builder = Gtk::Builder::create_from_resource("/ch/arknet/Turns/windows/participant_editor.ui"); - auto instance = Gtk::Builder::get_widget_derived(builder, "participant_editor"); - auto window = Gtk::Window{}; - - SECTION("was successfully constructed") - { - REQUIRE(instance); - } - - SECTION("has a non-empty title") - { - REQUIRE_FALSE(instance->get_title().empty()); - } - - SECTION("has its title set according to the active language") - { - REQUIRE(instance->get_title() == _(lang::add_participant)); - } - - SECTION("has an empty name field") - { - auto widget = builder->get_widget("name"); - REQUIRE(widget->get_text().empty()); - } - - SECTION("has a zero priority field") - { - auto widget = builder->get_widget("priority"); - REQUIRE(widget->get_value() == 0); - } - - SECTION("allows binding to the finished signal") - { - REQUIRE((instance->signal_finished().connect([](auto, auto, auto) {})).connected()); - } - } - - TEST_CASE("A freshly constructed participant editor with a participant", "[windows]") - { - auto locale = GENERATE("en_US.UTF-8", "de_CH.UTF-8"); - setlocale(LC_ALL, locale); - - auto participant = core::participant::create("Qibi Babblebranch", 12, core::disposition::neutral); - auto builder = Gtk::Builder::create_from_resource("/windows/participant_editor.ui"); - auto instance = Gtk::Builder::get_widget_derived(builder, "participant_editor", participant); - auto window = Gtk::Window{}; - - SECTION("was successfully constructed") - { - REQUIRE(instance); - } - - SECTION("has a non-empty title") - { - REQUIRE_FALSE(instance->get_title().empty()); - } - - SECTION("has its title set according to the active language") - { - REQUIRE(instance->get_title() == _(lang::edit_participant)); - } - - SECTION("has its name field set according to its participant") - { - auto widget = builder->get_widget("name"); - REQUIRE(widget->get_text() == participant->property_name().get_value()); - } - - SECTION("has its priority field set according to its participant") - { - auto widget = builder->get_widget("priority"); - REQUIRE(widget->get_value() == participant->property_priority()); - } - - SECTION("allows binding to the finished signal") - { - REQUIRE((instance->signal_finished().connect([](auto, auto, auto) {})).connected()); - } - } - -} // namespace turns::ui::windows::tests \ No newline at end of file diff --git a/ui/tests/windows/resources.cpp b/ui/tests/windows/resources.cpp index b9ac42e..022f3c4 100644 --- a/ui/tests/windows/resources.cpp +++ b/ui/tests/windows/resources.cpp @@ -12,13 +12,3 @@ TEST_CASE("GResource for tracker") REQUIRE(builder); } } - -TEST_CASE("GResource for participant_editor") -{ - auto builder = Gtk::Builder::create_from_resource("/ch/arknet/Turns/windows/participant_editor.ui"); - - SECTION("can create Gtk.Builder for the participant_editor window UI definition") - { - REQUIRE(builder); - } -} \ No newline at end of file diff --git a/ui/ui.cmb b/ui/ui.cmb index c16dfb7..d042398 100644 --- a/ui/ui.cmb +++ b/ui/ui.cmb @@ -3,7 +3,7 @@ - + -- cgit v1.2.3