feature(emojis): add an emojis picker

Author: Guts

qchat/gui/dck_qchat.py

@@ -13,8 +13,8 @@
 from qgis.core import Qgis, QgsApplication, QgsJsonExporter, QgsMapLayer, QgsProject
 from qgis.gui import QgisInterface, QgsDockWidget
 from qgis.PyQt import uic
-from qgis.PyQt.QtCore import QPoint, Qt
-from qgis.PyQt.QtGui import QCursor, QIcon
+from qgis.PyQt.QtCore import QPoint, Qt, QUrl
+from qgis.PyQt.QtGui import QCursor, QFont, QFontDatabase, QIcon
 from qgis.PyQt.QtWidgets import (
     QAction,
     QFileDialog,
@@ -44,6 +44,7 @@
     QCHAT_NICKNAME_MAXLENGTH_DEFAULT,
     QCHAT_NICKNAME_MINLENGTH,
 )
+from qchat.gui.emojis.fra_emoji_picker_quick import EmojiButtonHandler
 from qchat.gui.qchat_tree_widget_items import (
     MESSAGE_COLUMN,
     QChatAdminTreeWidgetItem,
@@ -105,6 +106,7 @@ def __init__(
         self.task_manager = QgsApplication.taskManager()
         self.log = PlgLogger().log
         self.plg_settings = PlgOptionsManager()
+
         uic.loadUi(Path(__file__).parent / f"{Path(__file__).stem}.ui", self)
 
         # set channel to autoreconnect to when widget will open
@@ -191,6 +193,10 @@ def __init__(
             QIcon(QgsApplication.iconPath("mActionDoubleArrowRight.svg"))
         )
 
+        # emoji picker
+        self.emoji_handler = EmojiButtonHandler(parent_button=self.btn_emojis_picker)
+        self.emoji_handler.emoji_selected.connect(self.insert_emoji)
+
         # send image message signal listener
         self.btn_send_image.pressed.connect(self.on_send_image_button_clicked)
         self.btn_send_image.setIcon(
@@ -957,14 +963,26 @@ def on_send_crs_button_clicked(self) -> None:
         self.qchat_ws.send_message(message)
 
     def add_admin_message(self, text: str, timestamp: Optional[int] = None) -> None:
+        """Adds an admin message to QTreeWidget chat.
+
+        :param text: admin message to insert
+        :type text: str
+        :param timestamp: datetime, defaults to None
+        :type timestamp: Optional[int], optional
         """
-        Adds an admin message to QTreeWidget chat
-        """
+
         item = QChatAdminTreeWidgetItem(self.twg_chat, text, timestamp)
         self.add_tree_widget_item(item)
 
     def add_tree_widget_item(self, item: QTreeWidgetItem) -> None:
+        """Adds a QTreeWidgetItem to the chat QTreeWidget.
+
+        :param item: item to insert
+        :type item: QTreeWidgetItem
+        """
         self.twg_chat.addTopLevelItem(item)
+        if isinstance(item, QChatTextTreeWidgetItem):
+            item.setFont(MESSAGE_COLUMN, QFont("Noto Color Emoji"))
         if self.ckb_autoscroll.isChecked():
             self.twg_chat.scrollToItem(item)
 
@@ -1155,3 +1173,73 @@ def on_send_geojson_layer_to_qchat(self) -> None:
             style=qml_style,
         )
         self.qchat_ws.send_message(message)
+
+    # -- FONTS --
+    def is_font_available(self, font_family: str) -> bool:
+        available_fonts = QFontDatabase().families()
+        return font_family in available_fonts
+
+    # -- EMOJIS --
+
+    def check_emoji_font(self) -> bool:
+        """Check if the font used for displaying emojis is installed. If not, try to
+            download it.
+
+        :return: _description_
+        :rtype: _type_
+        """
+        if self.is_font_available(font_family=self.plg_settings.font_emoji_family):
+            self.log(
+                message=self.tr(
+                    "Required font to display emojis is already installed: {}".format(
+                        self.plg_settings.font_emoji_family
+                    )
+                ),
+                push=False,
+                log_level=Qgis.MessageLevel.NoLevel,
+            )
+            return True
+        else:
+            self.log(
+                message="Required font for emojis needs to be installed: {}".format(
+                    self.plg_settings.font_emoji_family
+                ),
+                push=False,
+            )
+            font_manager = QgsApplication.fontManager()
+            font_manager.fontDownloadErrorOccurred.connect(self.on_font_download_failed)
+            auto_downloaded = font_manager.tryToDownloadFontFamily(
+                self.plg_settings.font_emoji_family
+            )
+            if not auto_downloaded:
+                self.log(message="not downloaded", log_level=Qgis.MessageLevel.Warning)
+
+            font_manager.downloadAndInstallFont(
+                url=QUrl(self.plg_settings.font_emoji_download_url),
+                identifier="qchat-emoji-font",
+            )
+
+    def on_font_download_failed(self, error_message: Optional[str] = None):
+        """Handle pyqtsignal emitted by QgsFontManager when font downloading failed.
+
+        :param error_message: error message, defaults to None
+        :type error_message: Optional[str], optional
+        """
+        self.log(
+            message=self.tr(
+                "Downloading the font {} from {} failed. Since it's required to "
+                "correctly display emojis, consider to add it manually to your system. "
+                "Trace: {}".format(
+                    self.EMOJI_FONT_FAMILY, self.EMOJI_FONT_DOWNLOAD_URL, error_message
+                )
+            )
+        )
+
+    def insert_emoji(self, emoji):
+        """Insert selected emoji at cursor position"""
+        cursor_pos = self.lne_message.cursorPosition()
+        current_text = self.lne_message.text()
+        new_text = current_text[:cursor_pos] + emoji + current_text[cursor_pos:]
+        self.lne_message.setText(new_text)
+        self.lne_message.setCursorPosition(cursor_pos + len(emoji))
+        self.lne_message.setFocus()

qchat/gui/dck_qchat.ui

@@ -6,7 +6,7 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>446</width>
+    <width>467</width>
     <height>887</height>
    </rect>
   </property>
@@ -219,6 +219,11 @@
           <property name="text">
            <string notr="true">3</string>
           </property>
+          <property name="font">
+           <font>
+            <kerning>false</kerning>
+           </font>
+          </property>
          </column>
         </widget>
        </item>
@@ -284,11 +289,40 @@
          </item>
          <item>
           <widget class="QgsFilterLineEdit" name="lne_message">
+           <property name="font">
+            <font>
+             <family>Noto Color Emoji</family>
+            </font>
+           </property>
+           <property name="placeholderText">
+            <string>Type your message here...</string>
+           </property>
            <property name="qgisRelation" stdset="0">
             <string notr="true"/>
            </property>
           </widget>
          </item>
+         <item>
+          <widget class="QPushButton" name="btn_emojis_picker">
+           <property name="maximumSize">
+            <size>
+             <width>35</width>
+             <height>35</height>
+            </size>
+           </property>
+           <property name="font">
+            <font>
+             <family>Noto Color Emoji</family>
+            </font>
+           </property>
+           <property name="toolTip">
+            <string>Pick an emoji to insert</string>
+           </property>
+           <property name="text">
+            <string>😀</string>
+           </property>
+          </widget>
+         </item>
          <item>
           <widget class="QPushButton" name="btn_send">
            <property name="cursor">

qchat/gui/emojis/__init__.py

@@ -0,0 +1,125 @@
+# standard library
+import json
+from pathlib import Path
+from typing import Optional
+
+# PyQGIS
+from qgis.core import Qgis
+from qgis.PyQt import uic
+from qgis.PyQt.QtCore import pyqtSignal
+from qgis.PyQt.QtGui import QFont, QIcon
+from qgis.PyQt.QtWidgets import QDialog, QGridLayout, QPushButton, QScrollArea, QWidget
+
+# plugin
+from qchat.__about__ import DIR_PLUGIN_ROOT, __icon_path__
+from qchat.toolbelt import PlgLogger, PlgOptionsManager
+
+
+class FullEmojiPicker(QDialog):
+    """Full emoji picker."""
+
+    emoji_selected = pyqtSignal(str)
+
+    def __init__(self, parent: Optional[QWidget] = None):
+        super().__init__(parent)
+        self.log = PlgLogger().log
+        self.plg_settings = PlgOptionsManager()
+
+        # Load UI
+        uic.loadUi(Path(__file__).parent / f"{Path(__file__).stem}.ui", self)
+        self.setWindowIcon(QIcon(str(__icon_path__)))
+
+        # Load emoji data
+        self.emoji_categories = self.load_emojis_from_json()
+
+        # Setup the picker
+        self.setup_emoji_tabs()
+
+        # Connect search
+        self.lne_search_box.textChanged.connect(self.filter_emojis)
+
+    def load_emojis_from_json(self):
+        """Load emoji categories from JSON file"""
+        try:
+            with DIR_PLUGIN_ROOT.joinpath("resources/emojis/selection.json").open(
+                mode="r", encoding="utf-8"
+            ) as file:
+                data = json.load(file)
+
+            # Convert JSON structure
+            categories = {}
+            json_categories = data.get("categories", {})
+
+            for category_id, category_data in json_categories.items():
+                category_name = category_data.get("name", category_id.title())
+                emojis_list = []
+
+                for emoji_data in category_data.get("emojis", []):
+                    emojis_list.append(emoji_data.get("emoji", ""))
+
+                if emojis_list:
+                    categories[category_name] = emojis_list
+
+            return categories
+
+        except (FileNotFoundError, json.JSONDecodeError) as err:
+            self.log(
+                message=self.tr("Error loading emojis: {}\nUsing defaults.").format(
+                    err
+                ),
+                log_level=Qgis.MessageLevel.Warning,
+                duration=3,
+                push=True,
+            )
+            return self.get_default_emojis()
+
+    def get_default_emojis(self):
+        """Fallback emoji categories"""
+        return {
+            "Smileys": ["😀", "😃", "😄", "😁", "😆", "😅", "😂", "🤣", "😊", "😇"],
+            "Gestures": ["👍", "👎", "👌", "✌️", "🤞", "👋", "👏", "🙌", "🙏", "💪"],
+        }
+
+    def setup_emoji_tabs(self):
+        """Create tabs with emoji grids"""
+        for category_name, emojis in self.emoji_categories.items():
+            emojis_tab = self.create_emoji_tab(emojis)
+            self.tabWidget.addTab(emojis_tab, category_name.title())
+
+    def create_emoji_tab(self, emojis):
+        """Create a tab with emoji buttons"""
+        plg_settings = self.plg_settings.get_plg_settings()
+        scroll_area = QScrollArea()
+        scroll_widget = QWidget()
+        grid_layout = QGridLayout(scroll_widget)
+
+        row, col = 0, 0
+        for emoji in emojis:
+            if not emoji:
+                continue
+
+            btn = QPushButton(emoji)
+            btn.setFixedSize(40, 40)
+            btn.setFont(QFont(plg_settings.font_emoji_family, 14))
+            btn.clicked.connect(lambda checked, e=emoji: self.emoji_clicked(e))
+            btn.setToolTip(f"Insert {emoji}")
+
+            grid_layout.addWidget(btn, row, col)
+            col += 1
+            if col >= 10:
+                col = 0
+                row += 1
+
+        scroll_area.setWidget(scroll_widget)
+        scroll_area.setWidgetResizable(True)
+        return scroll_area
+
+    def emoji_clicked(self, emoji):
+        """Handle emoji selection"""
+        self.emoji_selected.emit(emoji)
+        self.close()
+
+    def filter_emojis(self, search_text):
+        """Basic emoji filtering"""
+        if search_text:
+            self.tabWidget.setCurrentIndex(0)