ilink.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Distributed under the Boost Software License, Version 1.0.
 * (See accompanying file LICENSE or copy at https://www.boost.org/LICENSE_1_0.txt)
 **********************************************************************/
 
#pragma once
 
#include <memory>
#include <QObject>
#include <QMetaType>
#include <QUrl>
#include "coordsbase.h"
 
namespace LC::Monocle
{
    enum class LinkType
    {
        PageLink,

        URL,

        Command,

        OtherLink
    };

    struct NavigationAction
    {
        int PageNumber_;

        std::optional<PageRelativeRectBase> TargetArea_ {};

        std::optional<double> Zoom_ {};
 
        bool operator== (const NavigationAction&) const = default;
        bool operator< (const NavigationAction& other) const
        {
            const auto toTuple = [] (const NavigationAction& act)
            {
                qreal x {};
                qreal y {};
                qreal w {};
                qreal h {};
                act.TargetArea_.value_or (PageRelativeRectBase {}).ToRectF ().getRect (&x, &y, &w, &h);
                return std::tie (act.PageNumber_, x, y, w, h);  // don't care about the zoom
            };
 
            return toTuple (*this) < toTuple (other);
        }
    };

    struct ExternalNavigationAction
    {
        QString TargetDocument_ {};

        NavigationAction DocumentNavigation_;
    };
 
    struct UrlAction
    {
        QUrl Url_;
    };
 
    using CustomAction = std::function<void ()>;
 
    struct NoAction {};
 
    using LinkAction = std::variant<NoAction, NavigationAction, ExternalNavigationAction, UrlAction, CustomAction>;

    class ILink
    {
    public:
        virtual ~ILink () = default;

        virtual LinkType GetLinkType () const = 0;

        virtual PageRelativeRectBase GetArea () const = 0;

        virtual LinkAction GetLinkAction () const = 0;

         virtual QString GetToolTip () const
         {
             return {};
         }
    };
    typedef std::shared_ptr<ILink> ILink_ptr;
}
 
Q_DECLARE_INTERFACE (LC::Monocle::ILink, "org.LeechCraft.Monocle.ILink/1.0")