Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-11-05 07:40:58 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Userland/Libraries/LibGUI/SettingsWindow.cpp

131 lines
4.3 KiB
C++
Raw Normal View History

LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
/*
* Copyright (c) 2020, Idan Horowitz <idan.horowitz@serenityos.org>
Libraries: Use default constructors/destructors in LibGUI https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#cother-other-default-operation-rules "The compiler is more likely to get the default semantics right and you cannot implement these functions better than the compiler."
2022-02-26 10:50:04 -07:00
* Copyright (c) 2021-2022, the SerenityOS developers.
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
* Copyright (c) 2021, Andreas Kling <kling@serenityos.org>
LibGUI+Applications: Give SettingsWindow tabs a string ID This gives us a convenient way to refer to them, which will be used in the following commit.
2022-04-21 15:12:09 +01:00
* Copyright (c) 2021-2022, Sam Atkins <atkinssj@serenityos.org>
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#include <LibGUI/Application.h>
#include <LibGUI/BoxLayout.h>
#include <LibGUI/Button.h>
LibGUI: Support "modified" window state in SettingsWindow SettingsWindow now notices if the window is marked as modified, and shows a confirmation pop-up to check if the user wants to apply or discard their changes. It automatically marks the window as unmodified after restoring defaults or applying the changes, but each Tab subclass needs to call `set_modified(true)` when the user modifies things. The "Apply" button is automatically disabled when there are no unsaved changes to be applied.
2022-04-29 17:00:24 +01:00
#include <LibGUI/MessageBox.h>
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
#include <LibGUI/SettingsWindow.h>
#include <LibGUI/Widget.h>
namespace GUI {
LibGUI: Support "modified" window state in SettingsWindow SettingsWindow now notices if the window is marked as modified, and shows a confirmation pop-up to check if the user wants to apply or discard their changes. It automatically marks the window as unmodified after restoring defaults or applying the changes, but each Tab subclass needs to call `set_modified(true)` when the user modifies things. The "Apply" button is automatically disabled when there are no unsaved changes to be applied.
2022-04-29 17:00:24 +01:00
void SettingsWindow::set_modified(bool modified)
{
Window::set_modified(modified);
if (m_apply_button)
m_apply_button->set_enabled(modified);
}
LibGUI: Move GUI::SettingsWindow setup out of the constructor In order to propagate errors that occur during UI setup, we have to move all that logic out of widget/window subclass constructors. This is a first attempt at doing that, for GUI::SettingsWindow.
2021-11-28 08:34:04 +01:00
ErrorOr<NonnullRefPtr<SettingsWindow>> SettingsWindow::create(String title, ShowDefaultsButton show_defaults_button)
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
{
LibGUI: Move GUI::SettingsWindow setup out of the constructor In order to propagate errors that occur during UI setup, we have to move all that logic out of widget/window subclass constructors. This is a first attempt at doing that, for GUI::SettingsWindow.
2021-11-28 08:34:04 +01:00
auto window = TRY(SettingsWindow::try_create());
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
LibGUI: Move GUI::SettingsWindow setup out of the constructor In order to propagate errors that occur during UI setup, we have to move all that logic out of widget/window subclass constructors. This is a first attempt at doing that, for GUI::SettingsWindow.
2021-11-28 08:34:04 +01:00
window->set_title(move(title));
window->resize(400, 480);
window->set_resizable(false);
window->set_minimizable(false);
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
LibGUI: Move GUI::SettingsWindow setup out of the constructor In order to propagate errors that occur during UI setup, we have to move all that logic out of widget/window subclass constructors. This is a first attempt at doing that, for GUI::SettingsWindow.
2021-11-28 08:34:04 +01:00
auto main_widget = TRY(window->try_set_main_widget<GUI::Widget>());
main_widget->set_fill_with_background_color(true);
LibGUI: Cast unused smart-pointer return values to void
2021-12-02 12:53:02 +00:00
(void)TRY(main_widget->try_set_layout<GUI::VerticalBoxLayout>());
LibGUI: Move GUI::SettingsWindow setup out of the constructor In order to propagate errors that occur during UI setup, we have to move all that logic out of widget/window subclass constructors. This is a first attempt at doing that, for GUI::SettingsWindow.
2021-11-28 08:34:04 +01:00
main_widget->layout()->set_margins(4);
main_widget->layout()->set_spacing(6);
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
LibGUI: Move GUI::SettingsWindow setup out of the constructor In order to propagate errors that occur during UI setup, we have to move all that logic out of widget/window subclass constructors. This is a first attempt at doing that, for GUI::SettingsWindow.
2021-11-28 08:34:04 +01:00
window->m_tab_widget = TRY(main_widget->try_add<GUI::TabWidget>());
auto button_container = TRY(main_widget->try_add<GUI::Widget>());
LibGUI+Applications: Use the new layout system in the settings screens
2022-02-22 20:01:20 +01:00
button_container->set_preferred_size({ SpecialDimension::Grow, SpecialDimension::Fit });
LibGUI: Cast unused smart-pointer return values to void
2021-12-02 12:53:02 +00:00
(void)TRY(button_container->try_set_layout<GUI::HorizontalBoxLayout>());
LibGUI: Move GUI::SettingsWindow setup out of the constructor In order to propagate errors that occur during UI setup, we have to move all that logic out of widget/window subclass constructors. This is a first attempt at doing that, for GUI::SettingsWindow.
2021-11-28 08:34:04 +01:00
button_container->layout()->set_spacing(6);
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
if (show_defaults_button == ShowDefaultsButton::Yes) {
LibGUI: Use new DialogButton for consistency
2022-06-10 23:03:11 +02:00
window->m_reset_button = TRY(button_container->try_add<GUI::DialogButton>("Defaults"));
LibGUI: Move GUI::SettingsWindow setup out of the constructor In order to propagate errors that occur during UI setup, we have to move all that logic out of widget/window subclass constructors. This is a first attempt at doing that, for GUI::SettingsWindow.
2021-11-28 08:34:04 +01:00
window->m_reset_button->on_click = [window = window->make_weak_ptr<SettingsWindow>()](auto) mutable {
LibGUI: Support "modified" window state in SettingsWindow SettingsWindow now notices if the window is marked as modified, and shows a confirmation pop-up to check if the user wants to apply or discard their changes. It automatically marks the window as unmodified after restoring defaults or applying the changes, but each Tab subclass needs to call `set_modified(true)` when the user modifies things. The "Apply" button is automatically disabled when there are no unsaved changes to be applied.
2022-04-29 17:00:24 +01:00
window->reset_default_values();
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
};
}
LibGUI: Move GUI::SettingsWindow setup out of the constructor In order to propagate errors that occur during UI setup, we have to move all that logic out of widget/window subclass constructors. This is a first attempt at doing that, for GUI::SettingsWindow.
2021-11-28 08:34:04 +01:00
TRY(button_container->layout()->try_add_spacer());
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
LibGUI: Use new DialogButton for consistency
2022-06-10 23:03:11 +02:00
window->m_ok_button = TRY(button_container->try_add<GUI::DialogButton>("OK"));
LibGUI: Move GUI::SettingsWindow setup out of the constructor In order to propagate errors that occur during UI setup, we have to move all that logic out of widget/window subclass constructors. This is a first attempt at doing that, for GUI::SettingsWindow.
2021-11-28 08:34:04 +01:00
window->m_ok_button->on_click = [window = window->make_weak_ptr<SettingsWindow>()](auto) mutable {
LibGUI: Support "modified" window state in SettingsWindow SettingsWindow now notices if the window is marked as modified, and shows a confirmation pop-up to check if the user wants to apply or discard their changes. It automatically marks the window as unmodified after restoring defaults or applying the changes, but each Tab subclass needs to call `set_modified(true)` when the user modifies things. The "Apply" button is automatically disabled when there are no unsaved changes to be applied.
2022-04-29 17:00:24 +01:00
window->apply_settings();
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
GUI::Application::the()->quit();
};
LibGUI: Use new DialogButton for consistency
2022-06-10 23:03:11 +02:00
window->m_cancel_button = TRY(button_container->try_add<GUI::DialogButton>("Cancel"));
LibGUI: Move GUI::SettingsWindow setup out of the constructor In order to propagate errors that occur during UI setup, we have to move all that logic out of widget/window subclass constructors. This is a first attempt at doing that, for GUI::SettingsWindow.
2021-11-28 08:34:04 +01:00
window->m_cancel_button->on_click = [window = window->make_weak_ptr<SettingsWindow>()](auto) mutable {
LibGUI: Support "modified" window state in SettingsWindow SettingsWindow now notices if the window is marked as modified, and shows a confirmation pop-up to check if the user wants to apply or discard their changes. It automatically marks the window as unmodified after restoring defaults or applying the changes, but each Tab subclass needs to call `set_modified(true)` when the user modifies things. The "Apply" button is automatically disabled when there are no unsaved changes to be applied.
2022-04-29 17:00:24 +01:00
window->cancel_settings();
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
GUI::Application::the()->quit();
};
LibGUI: Use new DialogButton for consistency
2022-06-10 23:03:11 +02:00
window->m_apply_button = TRY(button_container->try_add<GUI::DialogButton>("Apply"));
LibGUI: Move GUI::SettingsWindow setup out of the constructor In order to propagate errors that occur during UI setup, we have to move all that logic out of widget/window subclass constructors. This is a first attempt at doing that, for GUI::SettingsWindow.
2021-11-28 08:34:04 +01:00
window->m_apply_button->on_click = [window = window->make_weak_ptr<SettingsWindow>()](auto) mutable {
LibGUI: Support "modified" window state in SettingsWindow SettingsWindow now notices if the window is marked as modified, and shows a confirmation pop-up to check if the user wants to apply or discard their changes. It automatically marks the window as unmodified after restoring defaults or applying the changes, but each Tab subclass needs to call `set_modified(true)` when the user modifies things. The "Apply" button is automatically disabled when there are no unsaved changes to be applied.
2022-04-29 17:00:24 +01:00
window->apply_settings();
};
window->on_close_request = [window = window->make_weak_ptr<SettingsWindow>()]() mutable -> Window::CloseRequestDecision {
if (!window->is_modified())
return Window::CloseRequestDecision::Close;
auto result = MessageBox::show(window, "Apply these settings before closing?", "Unsaved changes", MessageBox::Type::Warning, MessageBox::InputType::YesNoCancel);
switch (result) {
LibGUI+Userland: Make Dialog::ExecResult an enum class
2022-05-13 13:10:27 +01:00
case MessageBox::ExecResult::Yes:
LibGUI: Support "modified" window state in SettingsWindow SettingsWindow now notices if the window is marked as modified, and shows a confirmation pop-up to check if the user wants to apply or discard their changes. It automatically marks the window as unmodified after restoring defaults or applying the changes, but each Tab subclass needs to call `set_modified(true)` when the user modifies things. The "Apply" button is automatically disabled when there are no unsaved changes to be applied.
2022-04-29 17:00:24 +01:00
window->apply_settings();
return Window::CloseRequestDecision::Close;
LibGUI+Userland: Make Dialog::ExecResult an enum class
2022-05-13 13:10:27 +01:00
case MessageBox::ExecResult::No:
LibGUI: Support "modified" window state in SettingsWindow SettingsWindow now notices if the window is marked as modified, and shows a confirmation pop-up to check if the user wants to apply or discard their changes. It automatically marks the window as unmodified after restoring defaults or applying the changes, but each Tab subclass needs to call `set_modified(true)` when the user modifies things. The "Apply" button is automatically disabled when there are no unsaved changes to be applied.
2022-04-29 17:00:24 +01:00
window->cancel_settings();
return Window::CloseRequestDecision::Close;
default:
return Window::CloseRequestDecision::StayOpen;
}
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
};
LibGUI: Move GUI::SettingsWindow setup out of the constructor In order to propagate errors that occur during UI setup, we have to move all that logic out of widget/window subclass constructors. This is a first attempt at doing that, for GUI::SettingsWindow.
2021-11-28 08:34:04 +01:00
return window;
}
LibGUI+Applications: Add --open-tab option to FooSettings applications Similar to SystemMonitor's option of the same name, this allows you to launch the given application with the specific tab open.
2022-04-21 15:34:53 +01:00
Optional<NonnullRefPtr<SettingsWindow::Tab>> SettingsWindow::get_tab(StringView id) const
{
auto tab = m_tabs.find(id);
if (tab == m_tabs.end())
return {};
return tab->value;
}
void SettingsWindow::set_active_tab(StringView id)
{
if (auto tab = get_tab(id); tab.has_value())
m_tab_widget->set_active_widget(tab.value());
}
LibGUI: Support "modified" window state in SettingsWindow SettingsWindow now notices if the window is marked as modified, and shows a confirmation pop-up to check if the user wants to apply or discard their changes. It automatically marks the window as unmodified after restoring defaults or applying the changes, but each Tab subclass needs to call `set_modified(true)` when the user modifies things. The "Apply" button is automatically disabled when there are no unsaved changes to be applied.
2022-04-29 17:00:24 +01:00
void SettingsWindow::apply_settings()
{
for (auto& [id, tab] : m_tabs)
tab->apply_settings();
set_modified(false);
}
void SettingsWindow::cancel_settings()
{
for (auto& [id, tab] : m_tabs)
tab->cancel_settings();
}
void SettingsWindow::reset_default_values()
{
for (auto& [id, tab] : m_tabs) {
tab->reset_default_values();
tab->apply_settings();
}
set_modified(false);
}
LibGUI: Add SettingsWindow class The FooSettings apps have quite a lot of boilerplate just around creating a tabbed window with the same styling and the same row of buttons along the bottom. So, let's extract that out into a class we can reuse! :^) You create a SettingsWindow instead of a regular Window, passing a title and a flag to determine if a "Defaults" button is shown. Then call add_tab() to add tabs to it. Tabs are widgets extending SettingsWindow::Tab, which has methods for saving and resetting the values.
2021-11-20 14:28:54 +00:00
}
Reference in a new issue Copy permalink