ladybird/Userland/Libraries/LibWeb/HTML/NavigationDestination.h
Andrew Kaster 4989375191 LibWeb: Add NavigationDestination, used for NavigateEvents
This class will be used in the algorithms for the navigate event firing
algorithms to populate the destination field of the NavigateEvent.
2023-08-24 11:03:57 -06:00

60 lines
2.0 KiB
C++

/*
* Copyright (c) 2023, Andrew Kaster <akaster@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/URL.h>
#include <LibWeb/Bindings/PlatformObject.h>
#include <LibWeb/HTML/StructuredSerialize.h>
namespace Web::HTML {
// https://html.spec.whatwg.org/multipage/nav-history-apis.html#navigationdestination
class NavigationDestination : public Bindings::PlatformObject {
WEB_PLATFORM_OBJECT(NavigationDestination, Bindings::PlatformObject);
public:
[[nodiscard]] static JS::NonnullGCPtr<NavigationDestination> create(JS::Realm&);
WebIDL::ExceptionOr<String> url() const;
String key() const;
String id() const;
i64 index() const;
bool same_document() const;
WebIDL::ExceptionOr<JS::Value> get_state();
// Non-spec'd getter, not exposed to JS
JS::GCPtr<NavigationHistoryEntry> navigation_history_entry() const { return m_entry; }
// Setters are not available to JS, but expected in many spec algorithms
void set_url(AK::URL const& url) { m_url = url; }
void set_entry(JS::GCPtr<NavigationHistoryEntry> entry) { m_entry = entry; }
void set_state(SerializationRecord state) { m_state = move(state); }
void set_is_same_document(bool b) { m_is_same_document = b; }
virtual ~NavigationDestination() override;
private:
NavigationDestination(JS::Realm&);
virtual void initialize(JS::Realm&) override;
virtual void visit_edges(JS::Cell::Visitor&) override;
// https://html.spec.whatwg.org/multipage/nav-history-apis.html#concept-navigationdestination-url
AK::URL m_url;
// https://html.spec.whatwg.org/multipage/nav-history-apis.html#concept-navigationdestination-url
JS::GCPtr<NavigationHistoryEntry> m_entry;
// https://html.spec.whatwg.org/multipage/nav-history-apis.html#concept-navigationdestination-state
SerializationRecord m_state;
// https://html.spec.whatwg.org/multipage/nav-history-apis.html#concept-navigationdestination-samedocument
bool m_is_same_document { false };
};
}