bl_ui_textbox.py

# ##### BEGIN GPL LICENSE BLOCK #####
#
#  This program is free software; you can redistribute it and/or
#  modify it under the terms of the GNU General Public License
#  as published by the Free Software Foundation; either version 2
#  of the License, or (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program; if not, write to the Free Software Foundation,
#  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# ##### END GPL LICENSE BLOCK #####

# --- ### Header
bl_info = {"name": "BL UI Widgets",
           "description": "UI Widgets to draw in the 3D view",
           "author": "Marcelo M. Marques (fork of Jayanam's original project)",
           "version": (1, 0, 4),
           "blender": (3, 0, 0),
           "location": "View3D > viewport area",
           "support": "COMMUNITY",
           "category": "3D View",
           "warning": "Version numbering diverges from Jayanam's original project",
           "doc_url": "https://github.com/mmmrqs/bl_ui_widgets",
           "tracker_url": "https://github.com/mmmrqs/bl_ui_widgets/issues"
           }

# --- ### Change log

# v1.0.4 (07.29.2024) - by Marcelo M. Marques
# Chang: Conditionally removed deprecated 2D_/3D_ prefix for built-in shader names
# Chang: Conditionally removed deprecated blf.size() dpi argument

# v1.0.3 (05.08.2023) - by atticus-lv
# Chang: Replaced bgl mode (to be deprecated soon) by gpu module

# v1.0.2 (10.31.2021) - by Marcelo M. Marques
# Added: Logic to change state during a mouse move action so that the textbox background color is correctly set

# v1.0.1 (09.20.2021) - by Marcelo M. Marques
# Chang: Just some pep8 code formatting

# v1.0.0 (09.01.2021) - by Marcelo M. Marques
# Added: 'text_highlight' property to allow different text color on the selected textbox (value is standard color tuple).
# Added: 'outline_color' property to allow different color on the textbox outline (value is standard color tuple).
# Added: 'marked_color' property to allow different color on the selected part of the text (value is standard color tuple).
# Added: 'roundness' property to allow the textbox to be painted with rounded corners,
#         same as that property available in Blender's user themes and it works together with 'rounded_corners' below.
# Added: 'corner_radius' property to allow a limit for the roundness curvature, more useful when 'roundness' property
#         is not overriden by programmer and the one from Blender's user themes is used instead.
# Added: 'rounded_corners' property and coding to allow the textbox to be painted with rounded corners (value is a 4 elements tuple).
#         Each elements is a boolean value (0 or 1) which indicates whether the corresponding corner is to be rounded or straight
#         in the following clockwise sequence: bottom left, top left, top right, bottom right.
# Added: 'shadow' property and coding to allow the textbox to be painted with a shadow (value is boolean).
# Added: 'set_value_changed' function to allow assignment of an external function to be called when user finishes editing the text.
# Added: Shadow and Kerning related properties that allow the text to be painted using these characteristics.
# Added: Size, Shadow and Kerning attributes default to values retrieved from user theme (may be overriden by programmer).
# Added: Logic to allow the user to select parts of the text with {shift/ctrl + cursor keys}, {mouse double-click} or {mouse dragging}.
# Chang: Expanded the keypress event handling logic to deal with 'shift' and 'control' key combinations.
# Chang: Included the keypress event handling for 'UP_ARROW', 'DOWN_ARROW' and 'NUMPAD_ENTER' keys.
# Chang: Made it a subclass of 'BL_UI_Button' instead of 'BL_UI_Widget' so that it can inherit the layout features from there.
# Chang: Instead of hardcoded logic it is now leveraging 'BL_UI_Label' to paint the textbox text line.
# Chang: Renamed property 'carret_color' to 'cursor_color'.
# Chang: Renamed function 'text_input' to 'keyboard_press'.
# Chang: Renamed function 'set_text_changed' to 'set_value_updated'.
# Chang: 'draw_text' function logic bypassed to use the same function inherited from 'BL_UI_Button' class.
# Chang: 'mouse_down', 'mouse_move' and 'mouse_up' functions to handle text selection.

# --- ### Imports
import bpy
import gpu
import blf
import time

from gpu_extras.batch import batch_for_shader

from . bl_ui_button import BL_UI_Button


class BL_UI_Textbox(BL_UI_Button):

    def __init__(self, x, y, width, height):
        super().__init__(x, y, width, height)

        # Note: '_style' value will always be ignored if the bg_color value is overriden after object initialization.

        self._text = "Textbox"
        self._text_color = None                 # Textbox normal color
        self._text_highlight = None             # Textbox high color

        self._style = 'TEXTBOX'                 # Textbox background color style
        self._bg_color = None                   # Textbox background color
        self._selected_color = None             # Textbox background color (when in edit mode)
        self._outline_color = None              # Textbox outline color
        self._cursor_color = None               # Textbox cursor color (when in edit mode)
        self._marked_color = None               # Textbox marked color (when in edit mode)
        self._roundness = None                  # Textbox corners roundness factor [0..1]
        self._radius = 8.5                      # Textbox corners circular radius
        self._rounded_corners = (1, 1, 1, 1)    # 1=Round/0=Straight, coords:(bottomLeft,topLeft,topRight,bottomRight)
        self._has_shadow = True                 # Indicates whether a shadow must be drawn around the textbox

        self._max_input_chars = 100             # Maximum number of characters to be input by the textbox
        self._is_numeric = False                # Indicates whether the input text must restrict to numeric values

        self._text_margin = 8                   # Textbox text left margin
        self._text_size = None                  # Textbox text line 1 size
        self._text_kerning = None               # Textbox text kerning (True/False)
        self._text_shadow_size = None           # Textbox text shadow size
        self._text_shadow_offset_x = None       # Textbox text shadow offset x (positive goes right)
        self._text_shadow_offset_y = None       # Textbox text shadow offset y (negative goes down)
        self._text_shadow_color = None          # Textbox text shadow color [0..1] = gray tone, from dark to clear
        self._text_shadow_alpha = None          # Textbox text shadow alpha value [0..1]

        self.__ui_scale = 0
        self.__cursor_pos = 'RIGHT'             # Identifies which side {'LEFT','RIGHT'} the cursor is positioned
        self.__marked_pos = [0, 0]
        self.__cached_text = ""
        self.__is_editing = False
        self.__is_dragging = False
        self.__mouse_moved = False
        self.__drag_start_x = 0
        self.__drag_length = 0
        self.__click_start = 0
        self.__click_delay = 0.3
        self.__input_keys = ['ESC', 'RET', 'NUMPAD_ENTER', 'BACK_SPACE', 'HOME', 'END', 'DEL',
                             'LEFT_ARROW', 'RIGHT_ARROW', 'UP_ARROW', 'DOWN_ARROW']

    @property
    def cursor_color(self):
        return self._cursor_color

    @cursor_color.setter
    def cursor_color(self, value):
        self._cursor_color = value

    @property
    def marked_color(self):
        return self._marked_color

    @marked_color.setter
    def marked_color(self, value):
        self._marked_color = value

    @property
    def max_input_chars(self):
        return self._max_input_chars

    @max_input_chars.setter
    def max_input_chars(self, value):
        self._max_input_chars = value

    @property
    def is_numeric(self):
        return self._is_numeric

    @is_numeric.setter
    def is_numeric(self, value):
        self._is_numeric = value

    def set_value_changed(self, value_changed_func):
        self.value_changed_func = value_changed_func

    def value_changed_func(self, widget, context, former_text, updated_text):
        # This must return True when function is not overriden, so that text editing is accepted
        return True

    def set_value_updated(self, value_updated_func):
        self.value_updated_func = value_updated_func

    def value_updated_func(self, widget, context, event, former_text, updated_text):
        # This must return True when function is not overriden, so that text editing is accepted
        return True

    # Overrides base class function
    def button_pressed_func(self, widget):
        return self.__is_editing

    def start_editing(self):
        if not self.__is_editing:
            # Edit state
            self.state = 3
            self.__is_editing = True
            self.__cached_text = self._text
            self.__cursor_pos = 'RIGHT'
            self.__marked_pos = [0, len(self._text)]
            self.__ui_scale = self.over_scale(1)
            self.update_cursor()
            bpy.context.window.cursor_set('TEXT')
            self.set_exclusive_mode(self)

    def stop_editing(self):
        if self.__is_editing:
            if not self.value_changed_func(self, self.context, self.__cached_text, self._text):
                self._text = self.__cached_text
                return False
            if self.clean_up_text():
                # Up state
                self.state = 0
                self.__is_editing = False
                self.set_exclusive_mode(None)
            else:
                # Up state                      # Left this redundancy here just to show that we could have taken
                self.state = 0                  # a different action in the case of failing to clean up the text.
                self.__is_editing = False       # Even when failing we are exiting the edit mode, but in that case
                self.set_exclusive_mode(None)   # the clean_up_text() function will have restored the original text.
        bpy.context.window.cursor_set('DEFAULT')
        return True

    def clean_up_text(self):
        if self._text != self.__cached_text:
            # Logic to clean up numeric strings
            if self._is_numeric:
                clean_text = self._text
                negative = (clean_text.find('-') == 0)
                if negative:
                    clean_text = clean_text[1:]                                   # Temporarily removes the negative symbol
                if len(clean_text) > 0:
                    if clean_text[0] in ['.', ',']:
                        clean_text = "0" + clean_text[0:self._max_input_chars - 1]  # Add a missing leading zero
                while len(clean_text) > 1:
                    if clean_text[0] == "0" and not clean_text[1] in ['.', ',']:
                        clean_text = clean_text[1:]                               # Discard all extra leading zeroes
                    else:
                        break
                decimal = clean_text.find('.') + clean_text.find(',') + 1
                while len(clean_text) > 1 and decimal != -1:
                    if clean_text[-1] in ['0', '.', ',']:
                        clean_text = clean_text[0:len(clean_text) - 1]              # Discard all extra trailing zeroes
                    else:                                                         # or trailing decimal points/commas
                        break
                if len(clean_text) == 0:
                    self._text = "0"                                              # Fill out an empty numeric value
                else:
                    clean_text = ("-" + clean_text) if negative else clean_text   # Adds back the negative symbol
                    try:
                        float(clean_text)
                        self._text = clean_text
                    except Exception as e:
                        self._text = self.__cached_text
                        return False
            else:
                # Here would go any logic to clean up non numeric strings
                pass

        return True

    def find_text_gap(self, direction):
        char_filter = ' .,:;-\\/~!@#$%^&*+=(")?|{[<>]}' + "'"
        if direction == 'LEFT':
            position = 0
            for i in range(self.__marked_pos[0], 1, -1):
                if self._text[i - 1] in char_filter:
                    position = i if self.__marked_pos[0] > i else i - 1
                    break
        else:
            end = len(self._text)
            position = len(self._text)
            for i in range(self.__marked_pos[1], end):
                if self._text[i] in char_filter:
                    position = i if self.__marked_pos[0] < i else i + 1
                    break
        return position

    def get_cursor_pos_px(self):
        theme = bpy.context.preferences.ui_styles[0]
        widget_style = getattr(theme, "widget")

        if self._text_size is None:
            text_size = widget_style.points
            leveraged_text_size = text_size
        else:
            text_size = self._text_size
            leveraged_text_size = self.leverage_text_size(text_size, "widget")
        scaled_size = int(self.over_scale(leveraged_text_size))

        if bpy.app.version >= (3, 0, 0):  # 3.00 issue: 'font_kerning_style' has become extinct
            text_kerning = False
        else:
            text_kerning = (widget_style.font_kerning_style == 'FITTED') if self._text_kerning is None else self._text_kerning
            if text_kerning:
                blf.enable(0, blf.KERNING_DEFAULT)
        if bpy.app.version >= (4, 0, 0):  # 4.00 issue: removed deprecated blf.size() dpi argument
            blf.size(0, scaled_size)
        else:
            blf.size(0, scaled_size, 72)

        if self.__marked_pos[0] == 0:
            start = 0
        else:
            text_to_cursor = self._text[:self.__marked_pos[0]]
            start = blf.dimensions(0, text_to_cursor)[0]

        text_to_cursor = self._text[self.__marked_pos[0]: self.__marked_pos[1]]
        length = blf.dimensions(0, text_to_cursor)[0]

        if text_kerning:
            blf.disable(0, blf.KERNING_DEFAULT)

        return [start, length]

    def get_cursor_pos_char(self):
        theme = bpy.context.preferences.ui_styles[0]
        widget_style = getattr(theme, "widget")

        if self._text_size is None:
            text_size = widget_style.points
            leveraged_text_size = text_size
        else:
            text_size = self._text_size
            leveraged_text_size = self.leverage_text_size(text_size, "widget")
        scaled_size = int(self.over_scale(leveraged_text_size))

        if bpy.app.version >= (3, 0, 0):  # 3.00 issue: 'font_kerning_style' has become extinct
            text_kerning = False
        else:
            text_kerning = (widget_style.font_kerning_style == 'FITTED') if self._text_kerning is None else self._text_kerning
            if text_kerning:
                blf.enable(0, blf.KERNING_DEFAULT)
        if bpy.app.version >= (4, 0, 0):  # 4.00 issue: removed deprecated blf.size() dpi argument
            blf.size(0, scaled_size)
        else:
            blf.size(0, scaled_size, 72)

        mark_target = self.__drag_start_x + self.__drag_length
        text_startx = self.over_scale(self.x_screen + self._text_margin)
        text_length = len(self._text)
        char_pos = 0
        text_line = ""

        while char_pos < text_length:
            text_line += self._text[char_pos]
            text_width = blf.dimensions(0, text_line)[0]
            if (text_startx + text_width) > mark_target:
                break
            char_pos += 1

        if text_kerning:
            blf.disable(0, blf.KERNING_DEFAULT)

        return char_pos

    def update_cursor(self):
        cursor_pos_px = self.get_cursor_pos_px()
        x0_screen = self.over_scale(self.x_screen + self._text_margin)

        x1_screen = x0_screen + cursor_pos_px[0] + (0 if self.__cursor_pos == 'LEFT' else cursor_pos_px[1])
        vertices = ((x1_screen, self.over_scale(self.y_screen - 1)),
                    (x1_screen, self.over_scale(self.y_screen - self.height + 2)))
        self.batch_cursor = batch_for_shader(self.shader_cursor, 'LINES', {"pos": vertices})

        x1_screen = x0_screen + cursor_pos_px[0]
        x2_screen = x1_screen + cursor_pos_px[1]
        vertices = ((x1_screen, self.over_scale(self.y_screen - 1)),
                    (x2_screen, self.over_scale(self.y_screen - 1)),
                    (x2_screen, self.over_scale(self.y_screen - self.height + 2)),
                    (x1_screen, self.over_scale(self.y_screen - self.height + 2)))

        self.batch_marked = batch_for_shader(self.shader_marked, 'TRI_FAN', {"pos": vertices})

    # Overrides base class function
    def update(self, x, y):
        super().update(x, y)
        if bpy.app.version >= (4, 0, 0):  # 4.00 issue: removed deprecated 2D_/3D_ prefix for built-in shader names
            self.shader_cursor = gpu.shader.from_builtin('UNIFORM_COLOR')
            self.shader_marked = gpu.shader.from_builtin('UNIFORM_COLOR')
            self.update_cursor()
        else:
            self.shader_cursor = gpu.shader.from_builtin('2D_UNIFORM_COLOR')
            self.shader_marked = gpu.shader.from_builtin('2D_UNIFORM_COLOR')
            self.update_cursor()

    # Overrides base class function
    def draw(self):

        # The draw_text function has been overriden inside this python module so that
        # text drawing is deferred to later (at bottom of this self.draw() function)
        super().draw()

        if not self._is_visible:
            return

        # Get out of edit mode if user has changed the ui_scaling in the meantime
        if self.__ui_scale != self.over_scale(1):
            self.__ui_scale = self.over_scale(1)
            self.__is_editing = False

        # Draw cursor
        if self.__is_editing:
            # Paint the marked selection
            if self.__marked_pos[0] != self.__marked_pos[1]:
                if self._style in {'NUMBER_SLIDE', 'NUMBER_CLICK'}:
                    if self._selected_color is None:
                        theme = bpy.context.preferences.themes[0]
                        widget_style = getattr(theme.user_interface, self.my_style())
                        color = widget_style.item
                    else:
                        color = self._selected_color
                else:
                    if self._marked_color is None:
                        # From Preferences/Themes/User Interface/"Text"
                        theme = bpy.context.preferences.themes[0]
                        widget_style = getattr(theme.user_interface, "wcol_text")
                        color = widget_style.item
                    else:
                        color = self._marked_color

                self.shader_marked.bind()

                self.shader_marked.uniform_float("color", color)

                self.batch_marked.draw(self.shader_marked)


            # Paint the editing cursor
            if self._cursor_color is None:
                # From Preferences/Themes/User Interface/"Styles"
                theme = bpy.context.preferences.themes[0]
                if bpy.app.version >= (2, 90, 0):
                    widget_style = theme.user_interface
                    color = tuple(widget_style.widget_text_cursor) + (1.0,)
                else:
                    color = (0.2, 0.6, 0.9, 1.0)     # 2.80 issue: widget_text_cursor does not exist, color value was hard coded
            else:
                color = self._cursor_color

            self.shader_cursor.bind()

            self.shader_cursor.uniform_float("color", color)

            gpu.state.line_width_set(self.over_scale(1))

            self.batch_cursor.draw(self.shader_cursor)

        # Paint the text last, over everything else
        super().draw_text()

    # Overrides base class function
    def draw_text(self):
        pass

    # Overrides base class function
    def get_input_keys(self):
        return self.__input_keys

    # Overrides base class function
    def keyboard_press(self, event):
        if not (self._is_enabled and self.__is_editing):
            return False

        former_text = self._text
        former_pos = self.__marked_pos
        marked = not (self.__marked_pos[0] == self.__marked_pos[1])

        if event.ascii != '' and (marked or len(self._text) < self._max_input_chars):
            digits = ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9']
            new_text = self._text[:self.__marked_pos[0]] + self._text[self.__marked_pos[1]:]
            if (not self._is_numeric) or \
               (event.ascii == '-' and not ('-' in new_text or self.__marked_pos[0] > 0)) or \
               (event.ascii == '.' and not ('.' in new_text or ',' in new_text)) or \
               (event.ascii == ',' and not (',' in new_text or '.' in new_text)) or \
               (event.ascii in digits and not (self.__marked_pos[0] == 0 and '-' in new_text)):
                self._text = self._text[:self.__marked_pos[0]] + event.ascii + self._text[self.__marked_pos[1]:]
                self.__marked_pos = [self.__marked_pos[0] + 1, self.__marked_pos[0] + 1]

        elif event.type == 'BACK_SPACE':
            # Missing feature: with event.ctrl cursor should jump to closest word separation
            if marked:
                self._text = self._text[:self.__marked_pos[0]] + self._text[self.__marked_pos[1]:]
                self.__marked_pos = [self.__marked_pos[0], self.__marked_pos[0]]
            else:
                if self.__marked_pos[0] > 0:
                    if event.ctrl:
                        self._text = ""
                        self.__marked_pos = [0, 0]
                    else:
                        self._text = self._text[:(self.__marked_pos[0] - 1)] + self._text[self.__marked_pos[0]:]
                        self.__marked_pos = [self.__marked_pos[0] - 1, self.__marked_pos[0] - 1]

        elif event.type == 'DEL':
            # Missing feature: with event.ctrl cursor should jump to closest word separation
            if marked:
                self._text = self._text[:self.__marked_pos[0]] + self._text[self.__marked_pos[1]:]
                self.__marked_pos = [self.__marked_pos[0], self.__marked_pos[0]]
            else:
                if self.__marked_pos[0] < len(self._text):
                    if event.ctrl:
                        self._text = self._text[:self.__marked_pos[0]]
                    else:
                        self._text = self._text[:self.__marked_pos[0]] + self._text[(self.__marked_pos[0] + 1):]

        elif event.type == 'LEFT_ARROW':
            # Missing feature: with event.ctrl  cursor should jump to closest word separation
            # Missing feature: with event.shift it should extend/contract the marked block
            # Missing feature: event.ctrl should work also together (combined) with event.shift
            if event.shift:
                if event.ctrl:
                    self.__marked_pos = [0, self.__marked_pos[1]]
                    self.__cursor_pos = 'LEFT'
                else:
                    if self.__marked_pos[0] == self.__marked_pos[1]:
                        self.__cursor_pos = 'LEFT'
                    if self.__marked_pos[0] > 0 and self.__cursor_pos == 'LEFT':
                        self.__marked_pos = [self.__marked_pos[0] - 1, self.__marked_pos[1]]
                    if self.__marked_pos[1] > 0 and self.__cursor_pos == 'RIGHT':
                        self.__marked_pos = [self.__marked_pos[0], self.__marked_pos[1] - 1]
            elif marked:
                self.__marked_pos = [self.__marked_pos[0], self.__marked_pos[0]]
            elif event.ctrl:
                position = self.find_text_gap('LEFT')
                self.__marked_pos = [position, position]
            else:
                if self.__marked_pos[0] > 0:
                    if event.ctrl:
                        self.__marked_pos = [0, 0]
                    else:
                        self.__marked_pos = [self.__marked_pos[0] - 1, self.__marked_pos[0] - 1]

        elif event.type == 'RIGHT_ARROW':
            # Missing feature: with event.ctrl  cursor should jump to closest word separation
            # Missing feature: with event.shift it should extend/contract the marked block
            # Missing feature: event.ctrl should work also together (combined) with event.shift
            if event.shift:
                if event.ctrl:
                    self.__marked_pos = [self.__marked_pos[1], len(self._text)]
                    self.__cursor_pos = 'RIGHT'
                else:
                    if self.__marked_pos[0] == self.__marked_pos[1]:
                        self.__cursor_pos = 'RIGHT'
                    if self.__marked_pos[1] < len(self._text) and self.__cursor_pos == 'RIGHT':
                        self.__marked_pos = [self.__marked_pos[0], self.__marked_pos[1] + 1]
                    if self.__marked_pos[0] < len(self._text) and self.__cursor_pos == 'LEFT':
                        self.__marked_pos = [self.__marked_pos[0] + 1, self.__marked_pos[1]]
            elif marked:
                self.__marked_pos = [self.__marked_pos[1], self.__marked_pos[1]]
            elif event.ctrl:
                position = self.find_text_gap('RIGHT')
                self.__marked_pos = [position, position]
            else:
                if self.__marked_pos[1] < len(self._text):
                    if event.ctrl:
                        self.__marked_pos = [len(self._text), len(self._text)]
                    else:
                        self.__marked_pos = [self.__marked_pos[1] + 1, self.__marked_pos[1] + 1]

        elif event.type in {'HOME', 'UP_ARROW'}:
            if event.shift:
                self.__marked_pos = [0, self.__marked_pos[1]]
                self.__cursor_pos = 'LEFT'
            else:
                self.__marked_pos = [0, 0]

        elif event.type in {'END', 'DOWN_ARROW'}:
            if event.shift:
                self.__marked_pos = [self.__marked_pos[1], len(self._text)]
                self.__cursor_pos = 'RIGHT'
            else:
                self.__marked_pos = [len(self._text), len(self._text)]

        elif event.type in {'RET', 'NUMPAD_ENTER'}:
            self.stop_editing()

        elif event.type == 'ESC':
            self._text = self.__cached_text
            self.stop_editing()

        if self._text != former_text and event.type not in {'ESC', 'RET', 'NUMPAD_ENTER'}:
            if not self.value_updated_func(self, self.context, event, former_text, self._text):
                self._text = former_text
                self.__marked_pos = former_pos

        self.update_cursor()
        return True

    # Overrides base class function
    def mouse_down(self, event, x, y):
        if self.is_in_rect(x, y):
            # When textbox is disabled, just ignore the click
            if not self._is_enabled:
                # Consume the mouse event to avoid the camera/target be unselected
                return True
            if self.mouse_down_func(self, event, x, y):
                if self.__is_editing:
                    if (time.time() - self.__click_start) <= self.__click_delay:
                        # This is assumed as a double-click select text action
                        self.__marked_pos[0] = self.find_text_gap('LEFT')
                        self.__marked_pos[1] = self.find_text_gap('RIGHT')
                        self.update_cursor()
                    else:
                        # This is assumed as a start of mouse drag select text action
                        self.__is_dragging = True
                        self.__drag_start_x = x
                        self.__drag_length = 0
                        self.__click_start = time.time()
                        self.__marked_pos[0] = self.get_cursor_pos_char()
                        self.__marked_pos[1] = self.__marked_pos[0]
                        self.__mouse_moved = False
                        self.update_cursor()
                else:
                    self.start_editing()
                return True
            else:
                return False
        else:
            return (not self.stop_editing())

    # Overrides base class function
    def mouse_move(self, event, x, y):
        # When textbox is disabled, just ignore the hover
        if not self._is_enabled:
            return False
        if self.__is_editing and self.__is_dragging:
            # Update the value according to direction of x_drag
            self.__drag_length = x - self.__drag_start_x
            self.__mouse_moved = not (self.__drag_length == 0)
            if x < self.__drag_start_x:
                self.__marked_pos[0] = self.get_cursor_pos_char()
                self.__cursor_pos = 'LEFT'
                self.update_cursor()
            if x > self.__drag_start_x:
                self.__marked_pos[1] = self.get_cursor_pos_char()
                self.__cursor_pos = 'RIGHT'
                self.update_cursor()
            return True
        elif not self.__is_editing:
            if self.is_in_rect(x, y):
                # Hover state
                self.state = 2
            else:
                # Up state
                self.state = 0
        return False

    # Overrides base class function
    def mouse_up(self, event, x, y):
        if self.is_in_rect(x, y):
            # When textbox is disabled, just ignore the click
            if not self._is_enabled:
                # Consume the mouse event to avoid the camera/target be unselected
                return True
            self.__is_dragging = False
            if self.mouse_up_func(self, event, x, y):
                return True
            else:
                return False
        else:
            if self.__is_dragging:
                self.__is_dragging = False
                return True
            else:
                return (not self.stop_editing())

    # Overrides base class function
    def mouse_up_over(self):
        pass