pyTermTk/TermTk/TTkWidgets/combobox.py

# MIT License
#
# Copyright (c) 2021 Eugenio Parodi <ceccopierangiolieugenio AT googlemail DOT com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

__all__ = ['TTkComboBox']

from TermTk.TTkCore.cfg import TTkCfg
from TermTk.TTkCore.constant import TTkK
from TermTk.TTkCore.log import TTkLog
from TermTk.TTkCore.signal import pyTTkSlot, pyTTkSignal
from TermTk.TTkCore.helper import TTkHelper
from TermTk.TTkCore.string import TTkString
from TermTk.TTkCore.color import TTkColor
from TermTk.TTkCore.canvas import TTkCanvas
from TermTk.TTkCore.TTkTerm.inputkey import TTkKeyEvent
from TermTk.TTkCore.TTkTerm.inputmouse import TTkMouseEvent
from TermTk.TTkLayouts.gridlayout import TTkGridLayout
from TermTk.TTkWidgets.widget import TTkWidget
from TermTk.TTkWidgets.container import TTkContainer
from TermTk.TTkWidgets.list_ import TTkList
from TermTk.TTkWidgets.lineedit import TTkLineEdit
from TermTk.TTkWidgets.resizableframe import TTkResizableFrame


class _TTkComboBoxPopup(TTkResizableFrame):
    classStyle = TTkResizableFrame.classStyle
    classStyle['default'] |= {'searchColor': TTkColor.fg("#FFFF00")}

    __slots__ = ('_list',
                 #exportedMethods
                 'setCurrentRow',
                 #exportedSignals
                 'textClicked')
    def __init__(self, *, items:list[str], **kwargs) -> None:
        super().__init__(**kwargs|{'layout':TTkGridLayout()})
        self._list:TTkList = TTkList(parent=self, showSearch=False)
        self._list.addItems(items)
        self._list.searchModified.connect(self.update)

        self.textClicked   = self._list.textClicked
        self.setCurrentRow = self._list.setCurrentRow

    # def setFocus(self) -> None:
    #     self._list.viewport().setFocus()

    def keyEvent(self, evt:TTkKeyEvent) -> bool:
        return self._list.viewport().keyEvent(evt)

    def paintEvent(self, canvas:TTkCanvas) -> None:
        super().paintEvent(canvas)
        if text := self._list.search():
            w = self.width()-6
            color = self.currentStyle()['searchColor']
            if len(text) > w:
                text = TTkString("≼",TTkColor.BG_BLUE+TTkColor.FG_CYAN)+TTkString(text[-w+1:],color)
            else:
                text = TTkString(text,color)
            canvas.drawText(pos=(1,0), text=f"╼ {text} ╾")
            canvas.drawTTkString(pos=(3,0), text=text)

class TTkComboBox(TTkContainer):
    ''' TTkComboBox:

    Editable = False
    ::

         [ - select -  ^]

    Editable = True
    ::

         [ Text       [^]

    '''

    classStyle = {
                'default':     {'color': TTkColor.fg("#dddd88")+TTkColor.bg("#222222"),
                                'borderColor':TTkColor.RST},
                'disabled':    {'color': TTkColor.fg('#888888'),
                                'borderColor':TTkColor.fg('#888888')},
                'focus':       {'color': TTkColor.fg("#ffff88")+TTkColor.bg("#222222"),
                                'borderColor': TTkColor.fg("#ffff00") + TTkColor.BOLD},
            }

    __slots__ = ('_list', '_id', '_lineEdit', '_editable', '_insertPolicy', '_textAlign', '_popupFrame',
        #signals
        'currentIndexChanged', 'currentTextChanged', 'editTextChanged')
    def __init__(self, *,
                 list:list = None,
                 index:int = -1,
                 insertPolicy:TTkK.InsertPolicy = TTkK.InsertAtBottom,
                 textAlign:TTkK.Alignment = TTkK.CENTER_ALIGN,
                 editable:bool = False,
                 **kwargs) -> None:
        '''
        :param list: the list of the items selectable by this combobox, defaults to "[]"
        :type list: list(str), optional

        :param insertPolicy: the policy used to determine where user-inserted items should appear in the combobox, defaults to :py:class:`TTkConstant.InsertPolicy.InsertAtBottom`
        :type insertPolicy: :py:class:`TTkConstant.InsertPolicy`, optional

        :param textAlign: This enum type is used to define the text alignment, defaults to :py:class:`TTkConstant.Alignment.CENTER_ALIGN`
        :tye textAlign: :py:class:`TTkConstant.Alignment`, optional

        :param editable: This property holds whether the combo box can be edited by the user, defaults to False
        :type editable: bool, optional
        '''

        # Define Signals
        self.currentIndexChanged = pyTTkSignal(int)
        self.currentTextChanged  = pyTTkSignal(str)
        self.editTextChanged     = pyTTkSignal(str)
        super().__init__(**kwargs)
        # self.checked = pyTTkSignal()
        self._lineEdit = TTkLineEdit(parent=self)
        self._list =  list if list else []
        self._insertPolicy = insertPolicy
        self._lineEdit.returnPressed.connect(self._lineEditChanged)
        self._textAlign = textAlign
        self._id = index
        self._popupFrame = None
        self.setEditable(editable)
        self.setMinimumSize(5, 1)
        self.setMaximumHeight(1)

    def _lineEditChanged(self) -> None:
        text = self._lineEdit.text()
        self._id=-1
        if text in self._list:
            self._id = self._list.index(text)
        elif self._insertPolicy ==  TTkK.NoInsert:
            pass
        elif self._insertPolicy ==  TTkK.InsertAtTop:
            self._id=0
            self._list.insert(0,text)
        # elif self._insertPolicy ==  TTkK.InsertAtCurrent:
        #     pass
        elif self._insertPolicy ==  TTkK.InsertAtBottom:
            self._id=len(self._list)
            self._list.append(text)
        # elif self._insertPolicy ==  TTkK.InsertAfterCurrent:
        #     pass
        # elif self._insertPolicy ==  TTkK.InsertBeforeCurrent:
        #     pass
        # elif self._insertPolicy ==  TTkK.InsertAlphabetically:
        #     pass
        else:
            pass
        self.currentIndexChanged.emit(self._id)
        self.currentTextChanged.emit(text)
        self.editTextChanged.emit(text)

    def textAlign(self) -> TTkK.Alignment:
        '''his property holds the displayed text alignment

        :return: :py:class:`TTkConstant.Alignment`
        '''
        return self._textAlign

    def setTextAlign(self, align:TTkK.Alignment) -> None:
        '''This property holds the displayed text alignment

        :param align:
        :type align: :py:class:`TTkConstant.Alignment`
        '''
        if self._textAlign != align:
            self._textAlign = align
            self.update()

    def addItem(self, text:TTkString):
        '''
        Adds an item to the combobox with the given text.

        The item is appended to the list of existing items.

        :param text:
        :type text: :py:class:`TTkString`
        '''
        self._list.append(text)
        self.update()

    def addItems(self, items:list[TTkString]) -> None:
        '''
        Adds a list of items to the combobox with the given text.

        The items are appended to the list of existing items.

        :param items:
        :type items: list[:py:class:`TTkString`]
        '''
        for item in items:
            self.addItem(item)

    pyTTkSlot()
    def clear(self) -> None:
        '''Remove all the items.'''
        self._lineEdit.setText("")
        self._list = []
        self._id = -1
        self.update()

    def lineEdit(self) -> TTkLineEdit:
        '''
        Returns the :py:class:`TTkLineEdit` widget used if the editable flag is enabled

        :return: :py:class:`TTkLineEdit`
        '''
        return self._lineEdit if self._editable else None

    def resizeEvent(self, width: int, height: int) -> None:
        self._lineEdit.setGeometry(1,0,width-4,height)

    def paintEvent(self, canvas: TTkCanvas) -> None:
        style = self.currentStyle()

        color   = style['color']
        borderColor = style['borderColor']

        if self._id == -1:
            text = "- select -"
        else:
            text = self._list[self._id]
        w = self.width()

        canvas.drawTTkString(pos=(1,0), text=TTkString(text), width=w-3, alignment=self._textAlign, color=color)
        canvas.drawText(pos=(0,0), text="[",    color=borderColor)
        if self._editable:
            canvas.drawText(pos=(w-3,0), text="[^]", color=borderColor)
        else:
            canvas.drawText(pos=(w-2,0), text="^]", color=borderColor)

    def currentText(self) -> TTkString:
        '''
        Returns the selected text

        :return: :py:class:`TTkString`
        '''
        if self._editable:
            return self._lineEdit.text()
        elif self._id >= 0:
            return self._list[self._id]
        return ""

    def currentIndex(self) -> int:
        '''
        Return the current seleccted index.

        :return: int
        '''
        return self._id

    @pyTTkSlot(int)
    def setCurrentIndex(self, index:int) -> None:
        '''
        Set the selected index

        :param index:
        :type index: int
        '''
        if index < 0: return
        if index > len(self._list)-1: return
        if self._id == index: return
        self._id = index
        if self._editable:
            self._lineEdit.setText(self._list[self._id])
        else:
            self.currentTextChanged.emit(self._list[self._id])
        self.currentIndexChanged.emit(self._id)
        self.update()

    @pyTTkSlot(str)
    def setCurrentText(self, text:TTkString) -> None:
        '''
        Set the selected Text

        :param text:
        :type text: :py:class:`TTkString`
        '''
        if self._editable:
            self.setEditText(text)
        else:
            if text not in self._list:
                id = 0
            else:
                id = self._list.index(text)
            self.setCurrentIndex(id)

    @pyTTkSlot(str)
    def setEditText(self, text:TTkString) -> None:
        '''
        Set the text in the :py:class:`TTkLineEdit` widget

        :param text:
        :type text: :py:class:`TTkString`
        '''
        if self._editable:
            self._lineEdit.setText(text)

    def insertPolicy(self) -> TTkK.InsertPolicy:
        '''
        Retrieve the insert policy used when a new item is added if the combobox editable flag is true.

        :return: :py:class:`TTkK.InsertPolicy`
        '''
        return self._insertPolicy

    def setInsertPolicy(self, policy:TTkK.InsertPolicy) -> None:
        '''
        Define the insert policy used when a new item is inserted when the widget is editable.

        :param policy:
        :type policy: :py:class:`TTkK.InsertPolicy`
        '''
        self._insertPolicy = policy

    def isEditable(self) -> bool:
        '''
        This field holds the editable status of this widget.

        :return: bool
        '''
        return self._editable

    def setEditable(self, editable:bool) -> None:
        '''
        Set the editable status of this widget.

        :param editable:
        :type editable: bool
        '''
        self._editable = editable
        if editable:
            self._lineEdit.show()
            self.setFocusPolicy(TTkK.ClickFocus)
        else:
            self._lineEdit.hide()
            self.setFocusPolicy(TTkK.ClickFocus + TTkK.TabFocus)

    @pyTTkSlot(str)
    def _callback(self, label:TTkString) -> None:
        if self._editable:
            self._lineEdit.setText(label)
        self.setCurrentIndex(self._list.index(label))
        TTkHelper.removeOverlayAndChild(self._popupFrame)
        self._popupFrame = None
        self.setFocus()
        self.update()

    def _pressEvent(self) -> bool:
        frameHeight = len(self._list) + 2
        frameWidth = self.width()
        if frameHeight > 20: frameHeight = 20
        if frameWidth  < 20: frameWidth = 20

        self._popupFrame = _TTkComboBoxPopup(items=self._list, size=(frameWidth,frameHeight))
        TTkHelper.overlay(self, self._popupFrame, 0, 0)
        if self._id != -1:
            self._popupFrame.setCurrentRow(self._id)
        self._popupFrame.textClicked.connect(self._callback)
        self.update()

        # self._popupFrame = TTkResizableFrame(layout=TTkGridLayout(), size=(frameWidth,frameHeight))
        # TTkHelper.overlay(self, self._popupFrame, 0, 0)
        # listw = TTkList(parent=self._popupFrame)
        # # TTkLog.debug(f"{self._list}")
        # listw.addItems(self._list)
        # if self._id != -1:
        #     listw.setCurrentRow(self._id)
        # listw.textClicked.connect(self._callback)
        # listw.viewport().setFocus()
        # self.update()
        return True

    def wheelEvent(self, evt:TTkMouseEvent) -> bool:
        if evt.evt == TTkK.WHEEL_Up:
            self.setCurrentIndex(self._id-1)
        else:
            self.setCurrentIndex(self._id+1)
        return True

    def mousePressEvent(self, evt:TTkMouseEvent) -> bool:
        self._pressEvent()
        return True

    def keyEvent(self, evt:TTkKeyEvent) -> bool:
        if ( evt.type == TTkK.Character and evt.key==" " ) or \
           ( evt.type == TTkK.SpecialKey and evt.key in [TTkK.Key_Enter,TTkK.Key_Down] ):
            self._pressEvent()
            return True
        return False

    def focusInEvent(self) -> None:
        if self._editable:
            self._lineEdit.setFocus()