jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
3 * Copyright (c) 2023, Kenneth Myhra <kennethmyhra@serenityos.org>
4 *
5 * SPDX-License-Identifier: BSD-2-Clause
6 */
7
8#pragma once
9
10#include <LibWeb/ARIA/Roles.h>
11#include <LibWeb/HTML/HTMLElement.h>
12#include <LibWeb/HTML/HTMLInputElement.h>
13
14namespace Web::HTML {
15
16class HTMLFormElement final : public HTMLElement {
17 WEB_PLATFORM_OBJECT(HTMLFormElement, HTMLElement);
18
19public:
20 virtual ~HTMLFormElement() override;
21
22 DeprecatedString action() const;
23 DeprecatedString method() const { return attribute(HTML::AttributeNames::method); }
24
25 ErrorOr<void> submit_form(JS::GCPtr<HTMLElement> submitter, bool from_submit_binding = false);
26
27 void reset_form();
28
29 // NOTE: This is for the JS bindings. Use submit_form instead.
30 WebIDL::ExceptionOr<void> submit();
31
32 // NOTE: This is for the JS bindings. Use submit_form instead.
33 void reset();
34
35 void add_associated_element(Badge<FormAssociatedElement>, HTMLElement&);
36 void remove_associated_element(Badge<FormAssociatedElement>, HTMLElement&);
37
38 ErrorOr<Vector<JS::NonnullGCPtr<DOM::Element>>> get_submittable_elements();
39
40 JS::NonnullGCPtr<DOM::HTMLCollection> elements() const;
41 unsigned length() const;
42
43 // https://www.w3.org/TR/html-aria/#el-form
44 virtual Optional<ARIA::Role> default_role() const override { return ARIA::Role::form; }
45
46 // https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#constructing-entry-list
47 bool constructing_entry_list() const { return m_constructing_entry_list; }
48 void set_constructing_entry_list(bool value) { m_constructing_entry_list = value; }
49
50private:
51 HTMLFormElement(DOM::Document&, DOM::QualifiedName);
52
53 virtual JS::ThrowCompletionOr<void> initialize(JS::Realm&) override;
54 virtual void visit_edges(Cell::Visitor&) override;
55
56 ErrorOr<void> populate_vector_with_submittable_elements_in_tree_order(JS::NonnullGCPtr<DOM::Element> element, Vector<JS::NonnullGCPtr<DOM::Element>>& elements);
57
58 bool m_firing_submission_events { false };
59
60 // https://html.spec.whatwg.org/multipage/forms.html#locked-for-reset
61 bool m_locked_for_reset { false };
62
63 Vector<JS::GCPtr<HTMLElement>> m_associated_elements;
64
65 JS::GCPtr<DOM::HTMLCollection> mutable m_elements;
66
67 bool m_constructing_entry_list { false };
68};
69
70}