gbrowserpane.h

/*
 * File: gbrowserpane.h
 * --------------------
 * This file declares the <code>GBrowserPane</code> class, which is a
 * graphical interactor that displays a web page.
 *
 * @version 2021/04/09
 * - added sgl namespace
 * @version 2019/04/23
 * - moved some event-handling code to GInteractor superclass
 * @version 2018/12/28
 * - added methods for text selection, scrolling, cursor position, key/mouse listeners
 * @version 2018/09/17
 * - fixed thread safety bugs
 * - added link listener events
 * @version 2018/09/08
 * - added doc comments for new documentation generation
 * @version 2018/08/23
 * - renamed to gbrowserpane.h to replace Java version
 * @version 2018/07/15
 * - initial version
 */

#ifndef _gbrowserpane_h
#define _gbrowserpane_h

#include <string>
#include <QTextBrowser>
#include "ginteractor.h"

namespace sgl {

class _Internal_QTextBrowser;

class GBrowserPane : public GInteractor {
public:
    GBrowserPane(const string& url = "", QWidget* parent = nullptr);

    ~GBrowserPane() override;

    virtual void clearSelection();

    virtual void clearText();

    virtual string getContentType() const;

    virtual int getCursorPosition() const;

    /* @inherit */
    _Internal_QWidget* getInternalWidget() const override;

    virtual string getPageUrl() const;

    virtual string getSelectedText() const;

    virtual int getSelectionEnd() const;

    virtual int getSelectionLength() const;

    virtual int getSelectionStart() const;

    virtual string getText() const;

    /* @inherit */
    string getType() const override;

    /* @inherit */
    QWidget* getWidget() const override;

    virtual bool isEditable() const;

    virtual bool isLineWrap() const;

    virtual void moveCursorToEnd();

    virtual void moveCursorToStart();

    virtual void readTextFromFile(std::istream& file);

    virtual void readTextFromFile(const string& filename);

    virtual void readTextFromUrl(const string& url);

    virtual void removeLinkListener();

    virtual void removeTextChangeListener();

    virtual void scrollToBottom();

    virtual void scrollToTop();

    virtual void select(int startIndex, int length);

    virtual void selectAll();

    virtual void setContentType(const string& contentType);

    virtual void setCursorPosition(int index, bool keepAnchor = false);

    virtual void setEditable(bool value);

    virtual void setLineWrap(bool wrap);

    virtual void setLinkListener(GEventListener func);

    virtual void setLinkListener(GEventListenerVoid func);

    void setMouseListener(GEventListener func) override;

    void setMouseListener(GEventListenerVoid func) override;

    virtual void setText(const string& text);

    virtual void setTextChangeListener(GEventListener func);

    virtual void setTextChangeListener(GEventListenerVoid func);

private:
    Q_DISABLE_COPY(GBrowserPane)

    string _pageUrl;   // url/filename of the most recently loaded page
    string _contentType;
    _Internal_QTextBrowser* _iqtextbrowser;

    friend class _Internal_QTextBrowser;
};

class _Internal_QTextBrowser : public QTextBrowser, public _Internal_QWidget {
    Q_OBJECT

public:
    _Internal_QTextBrowser(GBrowserPane* gbrowserpane, QWidget* parent = nullptr);
    void detach() override;
    QVariant loadResource(int type, const QUrl &url) override;
    void mousePressEvent(QMouseEvent* event) override;
    void mouseReleaseEvent(QMouseEvent* event) override;
    QSize sizeHint() const override;

private:
    GBrowserPane* _gbrowserpane;
    QString _clickedLink;
};

} // namespace sgl

#endif // _gbrowserpane_h