RADWeb.h

Go to the documentation of this file.

#ifndef RADWEB_H
#define RADWEB_H
 
#pragma once
 
#include <RADCore/RADCore.h>
 
#include <cstdint>
#include <memory>
#include <string>
#include <vector>
 
namespace RADWeb {
 
    enum class RADWebCookiePolicy {
        AcceptAlways,
        AcceptNever,
        AcceptNoThirdParty
    };
 
    enum class RADWebPermissionPolicy {
        Ask,
        Allow,
        Deny
    };
 
    struct RADWebDownloadInfo {
        int id = 0;
        std::string uri;
        std::string destination;
        std::string suggestedFileName;
        double progress = 0.0;
        uint64_t receivedBytes = 0;
        bool finished = false;
    };
 
    struct RADWebHistoryItem {
        std::string url;
        std::string title;
        int64_t lastVisitedUnixMs = 0;
        int64_t visitCount = 0;
    };
 
    struct RADWebBookmark {
        int64_t id = 0;
        std::string url;
        std::string title;
        int64_t createdUnixMs = 0;
    };
 
    struct RADWebTabInfo {
        int id = 0;
        int index = -1;
        std::string url;
        std::string title;
        bool active = false;
    };
 
    struct RADWebSettings {
        bool javaScriptEnabled = true;
        bool imagesEnabled = true;
        bool developerExtrasEnabled = true;
        bool webGlEnabled = true;
        bool hardwareAccelerationEnabled = true;
        bool mediaPlaybackRequiresUserGesture = false;
        bool sessionRestoreEnabled = true;
        RADWebCookiePolicy cookiePolicy = RADWebCookiePolicy::AcceptNoThirdParty;
        RADWebPermissionPolicy permissionPolicy = RADWebPermissionPolicy::Ask;
        std::string downloadsDirectory;
    };
 
    struct RADWebWindowOptions {
        int width = 1200;
        int height = 800;
        std::string title = "RADWeb Browser";
        std::string profileDirectory;
        bool ephemeralProfile = false;
        bool navigationBarVisible = true;
        bool sessionRestoreEnabled = true;
    };
 
    class RADWebBrowserWindow : public RADCore::RADObject {
    public:
        RADEvents:
            RAD_EVENT(loadStarted, (std::string));
            RAD_EVENT(loadFinished, (std::string));
            RAD_EVENT(loadFailed, (std::string, std::string));
            RAD_EVENT(titleChanged, (std::string));
            RAD_EVENT(uriChanged, (std::string));
            RAD_EVENT(javaScriptFinished, (std::string));
            RAD_EVENT(javaScriptFailed, (std::string));
            RAD_EVENT(errorOccurred, (std::string));
            RAD_EVENT(tabAdded, (int));
            RAD_EVENT(tabClosed, (int));
            RAD_EVENT(activeTabChanged, (int));
            RAD_EVENT(downloadStarted, (RADWeb::RADWebDownloadInfo));
            RAD_EVENT(downloadUpdated, (RADWeb::RADWebDownloadInfo));
            RAD_EVENT(downloadFinished, (RADWeb::RADWebDownloadInfo));
            RAD_EVENT(downloadFailed, (int, std::string));
            RAD_EVENT(permissionRequested, (std::string, std::string));
            RAD_EVENT(historyChanged, ());
            RAD_EVENT(bookmarksChanged, ());
            RAD_EVENT(closed, ());
 
        RADWebBrowserWindow();
        ~RADWebBrowserWindow() override;
 
        void setProfileDirectory(const std::string& directory);
        const std::string& profileDirectory() const;
        void setEphemeralProfile(bool enabled);
        bool ephemeralProfile() const;
 
        bool create(int width = 1200, int height = 800, const std::string& title = "RADWeb Browser");
        bool create(const RADWebWindowOptions& options);
        bool isCreated() const;
 
        void setNavigationBarVisible(bool visible);
        bool navigationBarVisible() const;
 
        int newTab(const std::string& url = "about:blank", bool makeActive = true);
        bool closeTab(int index);
        bool duplicateTab(int index, bool makeActive = true);
        bool moveTab(int fromIndex, int toIndex);
        int tabCount() const;
        int activeTabIndex() const;
        RADWebTabInfo activeTab() const;
        std::vector<RADWebTabInfo> tabs() const;
        bool setActiveTab(int index);
 
        void loadUrl(const std::string& url);
        void loadUrl(int tabIndex, const std::string& url);
        void loadHtml(const std::string& html, const std::string& baseUri = "about:blank");
        void evaluateJavaScript(const std::string& script);
 
        void show();
        void close();
        void run();
        void quit();
 
        bool canGoBack() const;
        bool canGoForward() const;
        void goBack();
        void goForward();
        void reload();
        void stop();
 
        void focusUrlEntry();
        void focusFindEntry();
        void showHistory();
        void showDownloads();
        void showBookmarks();
        void showSettings();
        void showDevTools();
 
        void setZoomLevel(double zoomLevel);
        double zoomLevel() const;
 
        void searchText(const std::string& text, bool caseSensitive = false, bool wrap = true, unsigned maxMatchCount = 1000);
        void searchNext();
        void searchPrevious();
        void clearSearch();
 
        void setJavaScriptEnabled(bool enabled);
        void setImagesEnabled(bool enabled);
        void setDeveloperExtrasEnabled(bool enabled);
        void setWebGlEnabled(bool enabled);
        void setMediaPlaybackRequiresUserGesture(bool required);
        void setHardwareAccelerationEnabled(bool enabled);
        RADWebSettings settings() const;
        void applySettings(const RADWebSettings& settings);
 
        void setDownloadsDirectory(const std::string& directory);
        const std::string& downloadsDirectory() const;
 
        void setPermissionPolicy(RADWebPermissionPolicy policy);
        RADWebPermissionPolicy permissionPolicy() const;
        void rememberPermissionDecision(const std::string& origin, const std::string& permission, bool allowed);
        void clearPermissionDecisions();
 
        void setCookiePolicy(RADWebCookiePolicy policy);
        RADWebCookiePolicy cookiePolicy() const;
        void clearCookies();
        void clearCache();
 
        void setSessionRestoreEnabled(bool enabled);
        bool sessionRestoreEnabled() const;
        bool saveSession();
        bool restoreSession();
 
        std::vector<RADWebHistoryItem> history(size_t limit = 100) const;
        void clearHistory();
        bool addBookmark(const std::string& url, const std::string& title = {});
        bool removeBookmark(int64_t id);
        std::vector<RADWebBookmark> bookmarks() const;
        std::vector<RADWebDownloadInfo> downloads(size_t limit = 100) const;
        bool cancelDownload(int id);
        bool openDownload(int id);
        bool openDownloadsDirectory();
        void clearCompletedDownloads();
 
        std::string uri() const;
        std::string title() const;
 
        void* nativeWindow() const;
        void* nativeWebView() const;
 
    private:
        struct Impl;
        std::shared_ptr<Impl> pImpl_;
    };
 
} // namespace RADWeb
 
#endif