mirror of
https://github.com/RGBCube/serenity
synced 2025-07-25 13:17:35 +00:00
LibGUI: add a rudimentary framework for Wizards.
This patch provides the basic components needed for developers to create consistent wizard interface experiences in their applications. `WizardDialog` provides the dialog frame for the wizard, handling navigation and presentation. `AbstractWizardPage`s form the base class of Wizard pages, which are pushed onto the `WizardDialog` page stack via `WizardDialog::push_page`. `CoverWizardPage` and `WizardPage` are provided to ease the creation of Wizard interfaces consistent with the Serenity visual language.
This commit is contained in:
parent
610cec6e72
commit
e241dba8d3
12 changed files with 621 additions and 0 deletions
168
Userland/Libraries/LibGUI/Wizards/WizardDialog.cpp
Normal file
168
Userland/Libraries/LibGUI/Wizards/WizardDialog.cpp
Normal file
|
@ -0,0 +1,168 @@
|
|||
/*
|
||||
* Copyright (c) 2021, Nick Vella <nick@nxk.io>
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
*
|
||||
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
#include <LibGUI/BoxLayout.h>
|
||||
#include <LibGUI/Button.h>
|
||||
#include <LibGUI/SeparatorWidget.h>
|
||||
#include <LibGUI/Widget.h>
|
||||
#include <LibGUI/Wizards/AbstractWizardPage.h>
|
||||
#include <LibGUI/Wizards/WizardDialog.h>
|
||||
#include <LibGfx/Orientation.h>
|
||||
#include <LibGfx/SystemTheme.h>
|
||||
|
||||
namespace GUI {
|
||||
|
||||
WizardDialog::WizardDialog(Window* parent_window)
|
||||
: Dialog(parent_window)
|
||||
, m_page_stack()
|
||||
{
|
||||
resize(500, 360);
|
||||
set_title(String::formatted("Sample wizard"));
|
||||
set_resizable(false);
|
||||
|
||||
if (parent_window)
|
||||
set_icon(parent_window->icon());
|
||||
|
||||
auto& main_widget = set_main_widget<Widget>();
|
||||
main_widget.set_fill_with_background_color(true);
|
||||
main_widget.set_layout<VerticalBoxLayout>();
|
||||
main_widget.layout()->set_spacing(0);
|
||||
|
||||
m_page_container_widget = main_widget.add<Widget>();
|
||||
m_page_container_widget->set_fixed_size(500, 315);
|
||||
m_page_container_widget->set_layout<VerticalBoxLayout>();
|
||||
|
||||
auto& separator = main_widget.add<SeparatorWidget>(Gfx::Orientation::Horizontal);
|
||||
separator.set_fixed_height(2);
|
||||
|
||||
auto& nav_container_widget = main_widget.add<Widget>();
|
||||
nav_container_widget.set_layout<HorizontalBoxLayout>();
|
||||
nav_container_widget.set_fixed_height(42);
|
||||
nav_container_widget.layout()->set_margins({ 10, 0, 10, 0 });
|
||||
nav_container_widget.layout()->set_spacing(0);
|
||||
nav_container_widget.layout()->add_spacer();
|
||||
|
||||
m_back_button = nav_container_widget.add<Button>("< Back");
|
||||
m_back_button->set_fixed_width(75);
|
||||
m_back_button->on_click = [&]() {
|
||||
pop_page();
|
||||
};
|
||||
|
||||
m_next_button = nav_container_widget.add<Button>("Next >");
|
||||
m_next_button->set_fixed_width(75);
|
||||
m_next_button->on_click = [&]() {
|
||||
VERIFY(has_pages());
|
||||
|
||||
if (!current_page().can_go_next())
|
||||
return done(ExecOK);
|
||||
|
||||
push_page(*current_page().next_page());
|
||||
};
|
||||
|
||||
auto& button_spacer = nav_container_widget.add<Widget>();
|
||||
button_spacer.set_fixed_width(10);
|
||||
|
||||
m_cancel_button = nav_container_widget.add<Button>("Cancel");
|
||||
m_cancel_button->set_fixed_width(75);
|
||||
m_cancel_button->on_click = [&]() {
|
||||
handle_cancel();
|
||||
};
|
||||
|
||||
update_navigation();
|
||||
}
|
||||
|
||||
WizardDialog::~WizardDialog()
|
||||
{
|
||||
}
|
||||
|
||||
void WizardDialog::push_page(AbstractWizardPage& page)
|
||||
{
|
||||
if (!m_page_stack.is_empty())
|
||||
m_page_stack.last().page_leave();
|
||||
|
||||
m_page_stack.append(page);
|
||||
m_page_container_widget->remove_all_children();
|
||||
m_page_container_widget->add_child(page);
|
||||
|
||||
update_navigation();
|
||||
page.page_enter();
|
||||
}
|
||||
|
||||
void WizardDialog::replace_page(AbstractWizardPage& page)
|
||||
{
|
||||
if (!m_page_stack.is_empty())
|
||||
m_page_stack.take_last()->page_leave();
|
||||
|
||||
m_page_stack.append(page);
|
||||
m_page_container_widget->remove_all_children();
|
||||
m_page_container_widget->add_child(page);
|
||||
|
||||
update_navigation();
|
||||
page.page_enter();
|
||||
}
|
||||
|
||||
void WizardDialog::pop_page()
|
||||
{
|
||||
if (m_page_stack.size() <= 1)
|
||||
return;
|
||||
|
||||
auto page = m_page_stack.take_last();
|
||||
page->page_leave();
|
||||
|
||||
m_page_container_widget->remove_all_children();
|
||||
m_page_container_widget->add_child(m_page_stack.last());
|
||||
|
||||
update_navigation();
|
||||
m_page_stack.last().page_enter();
|
||||
}
|
||||
|
||||
void WizardDialog::update_navigation()
|
||||
{
|
||||
m_back_button->set_enabled(m_page_stack.size() > 1);
|
||||
if (has_pages()) {
|
||||
m_next_button->set_enabled(current_page().is_final_page() || current_page().can_go_next());
|
||||
m_next_button->set_text(current_page().is_final_page() ? "Finish" : "Next >");
|
||||
} else {
|
||||
m_next_button->set_text("Next >");
|
||||
m_next_button->set_enabled(false);
|
||||
}
|
||||
}
|
||||
|
||||
AbstractWizardPage& WizardDialog::current_page()
|
||||
{
|
||||
VERIFY(has_pages());
|
||||
return m_page_stack.last();
|
||||
}
|
||||
|
||||
void WizardDialog::handle_cancel()
|
||||
{
|
||||
if (on_cancel)
|
||||
return on_cancel();
|
||||
|
||||
done(ExecCancel);
|
||||
}
|
||||
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue