Allow QTermWidget to be used as a Qt Plugin (#469)

* Allow QTermWidget to be used as a Qt Plugin

* Adding metadata to JSON file

* Exporting interface file

* Restore includes in qtermwidget.h

* Adding Q_INTERFACES to the impl class

* Adding factory method

* Allowing retrieving the color schemes

* Applying changes in the PR

* Adding name to the copyright in ReadMe

* Fix issue in .sip file

CMakeLists.txt

@@ -113,6 +113,7 @@ set(HDRS_DISTRIB
     lib/Emulation.h
     lib/KeyboardTranslator.h
     lib/Filter.h
+    lib/qtermwidget_interface.h
 )
 
 # dirs

README.md

@@ -25,12 +25,14 @@ Files: example/main.cpp
        lib/kptyprocess.h
        lib/qtermwidget.cpp
        lib/qtermwidget.h
+       lib/qtermwidget_interface.h
 Copyright: Author Adriaan de Groot <[email protected]>
            2010, KDE e.V <[email protected]>
            2002-2007, Oswald Buddenhagen <[email protected]>
            2006-2008, Robert Knight <[email protected]>
            2002, Waldo Bastian <[email protected]>
            2008, e_k <[email protected]>
+           2022, Francesc Martinez <[email protected]>
 License: LGPL-2+
 
 Files: cmake/FindUtf8Proc.cmake
@@ -124,6 +126,7 @@ void | setTextCodec(QTextCodec *_codec_)
 void | setWorkingDirectory(const QString &_dir_)
 void | startShellProgram()
 void | startTerminalTeletype()
+QStringList | availableColorSchemes()
 
 ### Public Slots
 Type | Function

lib/qtermwidget.cpp

@@ -470,6 +470,11 @@ void QTermWidget::setColorScheme(const QString& origName)
     m_impl->m_terminalDisplay->setColorTable(table);
 }
 
+QStringList QTermWidget::getAvailableColorSchemes()
+{
+   return QTermWidget::availableColorSchemes();
+}
+
 QStringList QTermWidget::availableColorSchemes()
 {
     QStringList ret;
@@ -814,3 +819,8 @@ void QTermWidget::setConfirmMultilinePaste(bool confirmMultilinePaste) {
 void QTermWidget::setTrimPastedTrailingNewlines(bool trimPastedTrailingNewlines) {
     m_impl->m_terminalDisplay->setTrimPastedTrailingNewlines(trimPastedTrailingNewlines);
 }
+
+QTermWidgetInterface* QTermWidget::createWidget(int startnow) const
+{
+   return new QTermWidget(startnow);
+}

lib/qtermwidget.h

@@ -26,27 +26,19 @@
 #include "Filter.h"
 #include "qtermwidget_export.h"
 #include "qtermwidget_version.h"
+#include "qtermwidget_interface.h"
 
 class QVBoxLayout;
 class TermWidgetImpl;
 class SearchBar;
 class QUrl;
 
-class QTERMWIDGET_EXPORT QTermWidget : public QWidget {
+class QTERMWIDGET_EXPORT QTermWidget : public QWidget, public QTermWidgetInterface {
     Q_OBJECT
-public:
+    Q_PLUGIN_METADATA(IID "lxqt.qtermwidget" FILE "qtermwidget.json")
+    Q_INTERFACES(QTermWidgetInterface)
 
-    /**
-     * This enum describes the location where the scroll bar is positioned in the display widget.
-     */
-    enum ScrollBarPosition {
-        /** Do not show the scroll bar. */
-        NoScrollBar = 0,
-        /** Show the scroll bar on the left side of the display. */
-        ScrollBarLeft = 1,
-        /** Show the scroll bar on the right side of the display. */
-        ScrollBarRight = 2
-    };
+public:
 
     using KeyboardCursorShape = Konsole::Emulation::KeyboardCursorShape;
 
@@ -62,56 +54,65 @@ class QTERMWIDGET_EXPORT QTermWidget : public QWidget {
     QSize sizeHint() const override;
 
     // expose TerminalDisplay::TerminalSizeHint, setTerminalSizeHint
-    void setTerminalSizeHint(bool enabled);
-    bool terminalSizeHint();
+    void setTerminalSizeHint(bool enabled) override;
+    bool terminalSizeHint() override;
 
     //start shell program if it was not started in constructor
-    void startShellProgram();
+    void startShellProgram() override;
 
     /**
      * Start terminal teletype as is
      * and redirect data for external recipient.
      * It can be used for display and control a remote terminal.
      */
-    void startTerminalTeletype();
+    void startTerminalTeletype() override;
 
-    int getShellPID();
+    int getShellPID() override;
 
-    void changeDir(const QString & dir);
+    void changeDir(const QString & dir) override;
 
     //look-n-feel, if you don`t like defaults
 
     //  Terminal font
     // Default is application font with family Monospace, size 10
     // Beware of a performance penalty and display/alignment issues when using a proportional font.
-    void setTerminalFont(const QFont & font);
-    QFont getTerminalFont();
-    void setTerminalOpacity(qreal level);
-    void setTerminalBackgroundImage(const QString& backgroundImage);
-    void setTerminalBackgroundMode(int mode);
+    void setTerminalFont(const QFont & font) override;
+    QFont getTerminalFont() override;
+    void setTerminalOpacity(qreal level) override;
+    void setTerminalBackgroundImage(const QString& backgroundImage) override;
+    void setTerminalBackgroundMode(int mode) override;
 
     //environment
-    void setEnvironment(const QStringList & environment);
+    void setEnvironment(const QStringList & environment) override;
 
     //  Shell program, default is /bin/bash
-    void setShellProgram(const QString & program);
+    void setShellProgram(const QString & program) override;
 
     //working directory
-    void setWorkingDirectory(const QString & dir);
-    QString workingDirectory();
+    void setWorkingDirectory(const QString & dir) override;
+    QString workingDirectory() override;
 
     // Shell program args, default is none
-    void setArgs(const QStringList & args);
+    void setArgs(const QStringList & args) override;
 
     //Text codec, default is UTF-8
-    void setTextCodec(QTextCodec * codec);
+    void setTextCodec(QTextCodec * codec) override;
 
     /** @brief Sets the color scheme, default is white on black
      *
      * @param[in] name The name of the color scheme, either returned from
      * availableColorSchemes() or a full path to a color scheme.
      */
-    void setColorScheme(const QString & name);
+    void setColorScheme(const QString & name) override;
+
+    /**
+     * @brief Retrieves the available color schemes in the OS for the terminal.
+     *
+     * @note This function is needed in addition to the static one for making it availble when accessing QTermWidget as a plugin.
+     *
+     * @return A list of color schemes.
+     */
+    QStringList getAvailableColorSchemes() override;
     static QStringList availableColorSchemes();
     static void addCustomColorSchemeDir(const QString& custom_dir);
 
@@ -121,65 +122,65 @@ class QTERMWIDGET_EXPORT QTermWidget : public QWidget {
      *  lines = 0, no history
      *  lies < 0, infinite history
      */
-    void setHistorySize(int lines);
+    void setHistorySize(int lines) override;
 
     // Returns the history size (in lines)
-    int historySize() const;
+    int historySize() const override;
 
     // Presence of scrollbar
-    void setScrollBarPosition(ScrollBarPosition);
+    void setScrollBarPosition(QTermWidgetInterface::ScrollBarPosition) override;
 
     // Wrapped, scroll to end.
-    void scrollToEnd();
+    void scrollToEnd() override;
 
     // Send some text to terminal
-    void sendText(const QString & text);
+    void sendText(const QString & text) override;
 
     // Send key event to terminal
-    void sendKeyEvent(QKeyEvent* e);
+    void sendKeyEvent(QKeyEvent* e) override;
 
     // Sets whether flow control is enabled
-    void setFlowControlEnabled(bool enabled);
+    void setFlowControlEnabled(bool enabled) override;
 
     // Returns whether flow control is enabled
-    bool flowControlEnabled(void);
+    bool flowControlEnabled(void) override;
 
     /**
      * Sets whether the flow control warning box should be shown
      * when the flow control stop key (Ctrl+S) is pressed.
      */
-    void setFlowControlWarningEnabled(bool enabled);
+    void setFlowControlWarningEnabled(bool enabled) override;
 
     /*! Get all available keyboard bindings
      */
     static QStringList availableKeyBindings();
 
     //! Return current key bindings
-    QString keyBindings();
+    QString keyBindings() override;
 
-    void setMotionAfterPasting(int);
+    void setMotionAfterPasting(int) override;
 
     /** Return the number of lines in the history buffer. */
-    int historyLinesCount();
+    int historyLinesCount() override;
 
-    int screenColumnsCount();
-    int screenLinesCount();
+    int screenColumnsCount() override;
+    int screenLinesCount() override;
 
-    void setSelectionStart(int row, int column);
-    void setSelectionEnd(int row, int column);
-    void getSelectionStart(int& row, int& column);
-    void getSelectionEnd(int& row, int& column);
+    void setSelectionStart(int row, int column) override;
+    void setSelectionEnd(int row, int column) override;
+    void getSelectionStart(int& row, int& column) override;
+    void getSelectionEnd(int& row, int& column) override;
 
     /**
      * Returns the currently selected text.
      * @param preserveLineBreaks Specifies whether new line characters should
      * be inserted into the returned text at the end of each terminal line.
      */
-    QString selectedText(bool preserveLineBreaks = true);
+    QString selectedText(bool preserveLineBreaks = true) override;
 
-    void setMonitorActivity(bool);
-    void setMonitorSilence(bool);
-    void setSilenceTimeout(int seconds);
+    void setMonitorActivity(bool) override;
+    void setMonitorSilence(bool) override;
+    void setSilenceTimeout(int seconds) override;
 
     /** Returns the available hotspot for the given point \em pos.
      *
@@ -199,58 +200,60 @@ class QTERMWIDGET_EXPORT QTermWidget : public QWidget {
     /*
      * Proxy for TerminalDisplay::filterActions
      * */
-    QList<QAction*> filterActions(const QPoint& position);
+    QList<QAction*> filterActions(const QPoint& position) override;
 
     /**
      * Returns a pty slave file descriptor.
      * This can be used for display and control
      * a remote terminal.
      */
-    int getPtySlaveFd() const;
+    int getPtySlaveFd() const override;
 
     /**
      * Sets the shape of the keyboard cursor.  This is the cursor drawn
      * at the position in the terminal where keyboard input will appear.
      */
     void setKeyboardCursorShape(KeyboardCursorShape shape);
 
-    void setBlinkingCursor(bool blink);
+    void setBlinkingCursor(bool blink) override;
 
     /** Enables or disables bidi text in the terminal. */
-    void setBidiEnabled(bool enabled);
-    bool isBidiEnabled();
+    void setBidiEnabled(bool enabled) override;
+    bool isBidiEnabled() override;
 
     /**
      * Automatically close the terminal session after the shell process exits or
      * keep it running.
      */
-    void setAutoClose(bool);
+    void setAutoClose(bool) override;
 
-    QString title() const;
-    QString icon() const;
+    QString title() const override;
+    QString icon() const override;
 
     /** True if the title() or icon() was (ever) changed by the session. */
-    bool isTitleChanged() const;
+    bool isTitleChanged() const override;
 
     /** change and wrap text corresponding to paste mode **/
-    void bracketText(QString& text);
+    void bracketText(QString& text) override;
 
     /** forcefully disable bracketed paste mode **/
-    void disableBracketedPasteMode(bool disable);
-    bool bracketedPasteModeIsDisabled() const;
+    void disableBracketedPasteMode(bool disable) override;
+    bool bracketedPasteModeIsDisabled() const override;
 
     /** Set the empty space outside the terminal */
-    void setMargin(int);
+    void setMargin(int) override;
 
     /** Get the empty space outside the terminal */
-    int getMargin() const;
+    int getMargin() const override;
+
+    void setDrawLineChars(bool drawLineChars) override;
 
-    void setDrawLineChars(bool drawLineChars);
+    void setBoldIntense(bool boldIntense) override;
 
-    void setBoldIntense(bool boldIntense);
+    void setConfirmMultilinePaste(bool confirmMultilinePaste) override;
+    void setTrimPastedTrailingNewlines(bool trimPastedTrailingNewlines) override;
 
-    void setConfirmMultilinePaste(bool confirmMultilinePaste);
-    void setTrimPastedTrailingNewlines(bool trimPastedTrailingNewlines);
+    QTermWidgetInterface *createWidget(int startnow) const override;
 signals:
     void finished();
     void copyAvailable(bool);

lib/qtermwidget.json

@@ -0,0 +1,8 @@
+{
+   "Name" : "QTermWidget",
+   "Version" : "1.0.0",
+   "Vendor" : "LXQt",
+   "Copyright" : "(C) 2022 LXQt",
+   "Url" : "https://github.com/lxqt/qtermwidget",
+   "License" : "GPLv2"
+}