MicroPythonOS
diff --git a/‎internal_filesystem/lib/mpos/ui/keyboard.py‎
Lines changed: 304 additions & 0 deletions b/‎internal_filesystem/lib/mpos/ui/keyboard.py‎
Lines changed: 304 additions & 0 deletions
@@ -0,0 +1,304 @@
+"""
+Custom keyboard for MicroPythonOS.
+
+This module provides an enhanced on-screen keyboard with better layout,
+more characters (including emoticons), and improved usability compared
+to the default LVGL keyboard.
+
+Usage:
+    from mpos.ui.keyboard import CustomKeyboard
+
+    # Create keyboard
+    keyboard = CustomKeyboard(parent_obj)
+    keyboard.set_textarea(my_textarea)
+    keyboard.align(lv.ALIGN.BOTTOM_MID, 0, 0)
+
+    # Or use factory function for drop-in replacement
+    from mpos.ui.keyboard import create_keyboard
+    keyboard = create_keyboard(parent_obj, custom=True)
+"""
+
+import lvgl as lv
+import mpos.ui.theme
+
+
+class CustomKeyboard:
+    """
+    Enhanced keyboard widget with multiple layouts and emoticons.
+
+    Features:
+    - Lowercase and uppercase letter modes
+    - Numbers and special characters
+    - Additional special characters with emoticons
+    - Automatic mode switching
+    - Compatible with LVGL keyboard API
+    """
+
+    # Keyboard layout labels
+    LABEL_NUMBERS_SPECIALS = "?123"
+    LABEL_SPECIALS = "=\<"
+    LABEL_LETTERS = "abc"
+    LABEL_SPACE = "     "
+
+    # Keyboard modes (using LVGL's USER modes)
+    MODE_LOWERCASE = lv.keyboard.MODE.USER_1
+    MODE_UPPERCASE = lv.keyboard.MODE.USER_2
+    MODE_NUMBERS = lv.keyboard.MODE.USER_3
+    MODE_SPECIALS = lv.keyboard.MODE.USER_4
+
+    def __init__(self, parent):
+        """
+        Create a custom keyboard.
+
+        Args:
+            parent: Parent LVGL object to attach keyboard to
+        """
+        # Create underlying LVGL keyboard widget
+        self._keyboard = lv.keyboard(parent)
+
+        # Configure layouts
+        self._setup_layouts()
+
+        # Set default mode to lowercase
+        self._keyboard.set_mode(self.MODE_LOWERCASE)
+
+        # Add event handler for custom behavior
+        self._keyboard.add_event_cb(self._handle_events, lv.EVENT.VALUE_CHANGED, None)
+
+        # Apply theme fix for light mode visibility
+        mpos.ui.theme.fix_keyboard_button_style(self._keyboard)
+
+        # Set reasonable default height
+        self._keyboard.set_style_min_height(145, 0)
+
+    def _setup_layouts(self):
+        """Configure all keyboard layout modes."""
+
+        # Lowercase letters
+        lowercase_map = [
+            "q", "w", "e", "r", "t", "y", "u", "i", "o", "p", "\n",
+            "a", "s", "d", "f", "g", "h", "j", "k", "l", "\n",
+            lv.SYMBOL.UP, "z", "x", "c", "v", "b", "n", "m", lv.SYMBOL.BACKSPACE, "\n",
+            self.LABEL_NUMBERS_SPECIALS, ",", self.LABEL_SPACE, ".", lv.SYMBOL.NEW_LINE, None
+        ]
+        lowercase_ctrl = [10] * len(lowercase_map)
+        self._keyboard.set_map(self.MODE_LOWERCASE, lowercase_map, lowercase_ctrl)
+
+        # Uppercase letters
+        uppercase_map = [
+            "Q", "W", "E", "R", "T", "Y", "U", "I", "O", "P", "\n",
+            "A", "S", "D", "F", "G", "H", "J", "K", "L", "\n",
+            lv.SYMBOL.DOWN, "Z", "X", "C", "V", "B", "N", "M", lv.SYMBOL.BACKSPACE, "\n",
+            self.LABEL_NUMBERS_SPECIALS, ",", self.LABEL_SPACE, ".", lv.SYMBOL.NEW_LINE, None
+        ]
+        uppercase_ctrl = [10] * len(uppercase_map)
+        self._keyboard.set_map(self.MODE_UPPERCASE, uppercase_map, uppercase_ctrl)
+
+        # Numbers and common special characters
+        numbers_map = [
+            "1", "2", "3", "4", "5", "6", "7", "8", "9", "0", "\n",
+            "@", "#", "$", "_", "&", "-", "+", "(", ")", "/", "\n",
+            self.LABEL_SPECIALS, "*", "\"", "'", ":", ";", "!", "?", lv.SYMBOL.BACKSPACE, "\n",
+            self.LABEL_LETTERS, ",", self.LABEL_SPACE, ".", lv.SYMBOL.NEW_LINE, None
+        ]
+        numbers_ctrl = [10] * len(numbers_map)
+        self._keyboard.set_map(self.MODE_NUMBERS, numbers_map, numbers_ctrl)
+
+        # Additional special characters with emoticons
+        specials_map = [
+            "~", "`", "|", "•", ":-)", ";-)", ":-D", "\n",
+            ":-(" , ":'-(", "^", "°", "=", "{", "}", "\\", "\n",
+            self.LABEL_NUMBERS_SPECIALS, ":-o", ":-P", "[", "]", lv.SYMBOL.BACKSPACE, "\n",
+            self.LABEL_LETTERS, "<", self.LABEL_SPACE, ">", lv.SYMBOL.NEW_LINE, None
+        ]
+        specials_ctrl = [10] * len(specials_map)
+        self._keyboard.set_map(self.MODE_SPECIALS, specials_map, specials_ctrl)
+
+    def _handle_events(self, event):
+        """
+        Handle keyboard button presses.
+
+        Args:
+            event: LVGL event object
+        """
+        # Get the pressed button and its text
+        button = self._keyboard.get_selected_button()
+        text = self._keyboard.get_button_text(button)
+
+        # Get current textarea content
+        ta = self._keyboard.get_textarea()
+        if not ta:
+            return
+
+        current_text = ta.get_text()
+        new_text = current_text
+
+        # Handle special keys
+        if text == lv.SYMBOL.BACKSPACE:
+            # Delete last character
+            new_text = current_text[:-1]
+
+        elif text == lv.SYMBOL.UP:
+            # Switch to uppercase
+            self._keyboard.set_mode(self.MODE_UPPERCASE)
+            return  # Don't modify text
+
+        elif text == lv.SYMBOL.DOWN or text == self.LABEL_LETTERS:
+            # Switch to lowercase
+            self._keyboard.set_mode(self.MODE_LOWERCASE)
+            return  # Don't modify text
+
+        elif text == self.LABEL_NUMBERS_SPECIALS:
+            # Switch to numbers/specials
+            self._keyboard.set_mode(self.MODE_NUMBERS)
+            return  # Don't modify text
+
+        elif text == self.LABEL_SPECIALS:
+            # Switch to additional specials
+            self._keyboard.set_mode(self.MODE_SPECIALS)
+            return  # Don't modify text
+
+        elif text == self.LABEL_SPACE:
+            # Space bar
+            new_text = current_text + " "
+
+        elif text == lv.SYMBOL.NEW_LINE:
+            # Handle newline (only for multi-line textareas)
+            if ta.get_one_line():
+                # For single-line, trigger READY event
+                self._keyboard.send_event(lv.EVENT.READY, None)
+                return
+            else:
+                new_text = current_text + "\n"
+
+        else:
+            # Regular character
+            new_text = current_text + text
+
+        # Update textarea
+        ta.set_text(new_text)
+
+    # ========================================================================
+    # LVGL keyboard-compatible API
+    # ========================================================================
+
+    def set_textarea(self, textarea):
+        """Set the textarea that this keyboard should edit."""
+        self._keyboard.set_textarea(textarea)
+
+    def get_textarea(self):
+        """Get the currently associated textarea."""
+        return self._keyboard.get_textarea()
+
+    def set_mode(self, mode):
+        """Set keyboard mode (use MODE_* constants)."""
+        self._keyboard.set_mode(mode)
+
+    def align(self, align_type, x_offset=0, y_offset=0):
+        """Align the keyboard."""
+        self._keyboard.align(align_type, x_offset, y_offset)
+
+    def set_style_min_height(self, height, selector):
+        """Set minimum height."""
+        self._keyboard.set_style_min_height(height, selector)
+
+    def set_style_height(self, height, selector):
+        """Set height."""
+        self._keyboard.set_style_height(height, selector)
+
+    def set_style_max_height(self, height, selector):
+        """Set maximum height."""
+        self._keyboard.set_style_max_height(height, selector)
+
+    def set_style_opa(self, opacity, selector):
+        """Set opacity (required for fade animations)."""
+        self._keyboard.set_style_opa(opacity, selector)
+
+    def get_x(self):
+        """Get X position."""
+        return self._keyboard.get_x()
+
+    def set_x(self, x):
+        """Set X position."""
+        self._keyboard.set_x(x)
+
+    def get_y(self):
+        """Get Y position."""
+        return self._keyboard.get_y()
+
+    def set_y(self, y):
+        """Set Y position."""
+        self._keyboard.set_y(y)
+
+    def set_pos(self, x, y):
+        """Set position."""
+        self._keyboard.set_pos(x, y)
+
+    def get_height(self):
+        """Get height."""
+        return self._keyboard.get_height()
+
+    def get_width(self):
+        """Get width."""
+        return self._keyboard.get_width()
+
+    def add_flag(self, flag):
+        """Add object flag (e.g., HIDDEN)."""
+        self._keyboard.add_flag(flag)
+
+    def remove_flag(self, flag):
+        """Remove object flag."""
+        self._keyboard.remove_flag(flag)
+
+    def has_flag(self, flag):
+        """Check if object has flag."""
+        return self._keyboard.has_flag(flag)
+
+    def add_event_cb(self, callback, event_code, user_data):
+        """Add event callback."""
+        self._keyboard.add_event_cb(callback, event_code, user_data)
+
+    def remove_event_cb(self, callback):
+        """Remove event callback."""
+        self._keyboard.remove_event_cb(callback)
+
+    def send_event(self, event_code, param):
+        """Send event to keyboard."""
+        self._keyboard.send_event(event_code, param)
+
+    def get_lvgl_obj(self):
+        """
+        Get the underlying LVGL keyboard object.
+
+        Use this if you need direct access to LVGL methods not wrapped here.
+        """
+        return self._keyboard
+
+
+def create_keyboard(parent, custom=False):
+    """
+    Factory function to create a keyboard.
+
+    This provides a simple way to switch between standard LVGL keyboard
+    and custom keyboard.
+
+    Args:
+        parent: Parent LVGL object
+        custom: If True, create CustomKeyboard; if False, create standard lv.keyboard
+
+    Returns:
+        CustomKeyboard instance or lv.keyboard instance
+
+    Example:
+        # Use custom keyboard
+        keyboard = create_keyboard(screen, custom=True)
+
+        # Use standard LVGL keyboard
+        keyboard = create_keyboard(screen, custom=False)
+    """
+    if custom:
+        return CustomKeyboard(parent)
+    else:
+        keyboard = lv.keyboard(parent)
+        mpos.ui.theme.fix_keyboard_button_style(keyboard)
+        return keyboard