# 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__ = ['TTkLineEdit']
import re
from TermTk.TTkCore.cfg import TTkCfg
from TermTk.TTkCore.log import TTkLog
from TermTk.TTkCore.constant import TTkK
from TermTk.TTkCore.helper import TTkHelper
from TermTk.TTkCore.string import TTkString
from TermTk.TTkCore.color import TTkColor
from TermTk.TTkCore.signal import pyTTkSlot, pyTTkSignal
from TermTk.TTkGui.clipboard import TTkClipboard
from TermTk.TTkWidgets.widget import TTkWidget
'''
Line Edit: |_________-___________|
Text "abcdefbhijklmnopqrstuvwxyz12345"
<------------> Cursor Position
<--> Offset
'''
[docs]class TTkLineEdit(TTkWidget):
'''TTkLineEdit'''
[docs] class EchoMode(int):
Normal = 0x00 # Display characters as they are entered. This is the default.
NoEcho = 0x01 # Do not display anything. This may be appropriate for passwords where even the length of the password should be kept secret.
Password = 0x02 # Display asterisks instead of the characters actually entered.
PasswordEchoOnEdit = 0x03 # Display characters as they are entered while editing otherwise display asterisks.
classStyle = {
'default': {'color': TTkColor.fg("#dddddd")+TTkColor.bg("#222222"),
'selectedColor': TTkColor.fg("#ffffff")+TTkColor.bg("#008844")},
'disabled': {'color': TTkColor.fg('#888888'),
'selectedColor': TTkColor.fg("#888888")+TTkColor.bg("#444444")},
'focus': {'color': TTkColor.fg("#dddddd")+TTkColor.bg("#000044")},
}
__slots__ = (
'_text', '_cursorPos', '_offset', '_replace', '_inputType', '_echoMode',
'_selectionFrom', '_selectionTo',
'_clipboard',
# Signals
'returnPressed', 'textChanged', 'textEdited' )
def __init__(self, text='', inputType:int=TTkK.Input_Text, echoMode:EchoMode=EchoMode.Normal, **kwargs):
# Signals
self.returnPressed = pyTTkSignal()
self.textChanged = pyTTkSignal(str)
self.textEdited = pyTTkSignal(str)
self._offset = 0
self._cursorPos = 0
self._selectionFrom = 0
self._selectionTo = 0
self._replace=False
self._text = TTkString(text)
self._inputType = inputType
self._echoMode = echoMode
self._clipboard = TTkClipboard()
super().__init__(**kwargs)
self.setInputType(inputType)
self.setMaximumHeight(1)
self.setMinimumSize(1,1)
self.setFocusPolicy(TTkK.ClickFocus + TTkK.TabFocus)
self.enableWidgetCursor()
[docs] @pyTTkSlot(str)
def setText(self, text, cursorPos=0x1000):
'''setText'''
if text != self._text:
self.textChanged.emit(text)
self._text = TTkString(text)
self._cursorPos = max(0,min(cursorPos, len(text)))
self._pushCursor()
[docs] def text(self):
'''text'''
return self._text
def echoMode(self) -> EchoMode:
return self._echoMode
def setEchoMode(self, echoMode:EchoMode):
self._echoMode = echoMode
self.update()
[docs] def resizeEvent(self, w: int, h: int):
self._pushCursor()
return super().resizeEvent(w, h)
def _pushCursor(self):
w = self.width()
self._selectionTo = self._selectionFrom
# Align the text and the offset and the cursor to the current view
self._offset = max(0, min(self._offset, len(self._text)-w))
# Scroll to the right if reached the edge
cursorPos = self._text.substring(to=self._cursorPos).termWidth()
if cursorPos - self._offset > w:
self._offset = cursorPos-w
if cursorPos - self._offset < 0:
self._offset = cursorPos
if self._replace:
self.setWidgetCursor(pos=(cursorPos-self._offset, 0), type=TTkK.Cursor_Blinking_Block)
else:
self.setWidgetCursor(pos=(cursorPos-self._offset, 0), type=TTkK.Cursor_Blinking_Bar)
self.update()
[docs] def mousePressEvent(self, evt):
txtPos = self._text.tabCharPos(evt.x+self._offset)
self._cursorPos = txtPos
self._selectionFrom = txtPos
self._selectionTo = txtPos
self._pushCursor()
return True
[docs] def mouseDragEvent(self, evt) -> bool:
txtPos = self._text.tabCharPos(evt.x+self._offset)
self._selectionFrom = max(0, min(txtPos,self._cursorPos))
self._selectionTo = min(len(self._text),max(txtPos,self._cursorPos))
if self._selectionFrom < self._selectionTo:
TTkHelper.hideCursor()
self.update()
self.copy()
return True
[docs] def mouseDoubleClickEvent(self, evt) -> bool:
before = self._text.substring(to=self._cursorPos)
after = self._text.substring(fr=self._cursorPos)
self._selectionFrom = len(before)
self._selectionTo = len(before)
selectRE = r'[^ \t\r\n()[\]\.\,\+\-\*\/]*'
if m := before.search(selectRE+'$'):
self._selectionFrom -= len(m.group(0))
if m := after.search('^'+selectRE):
self._selectionTo += len(m.group(0))
# TTkLog.debug("x"*self._selectionFrom)
# TTkLog.debug("x"*self._selectionTo)
# TTkLog.debug(self._text)
if self._selectionFrom < self._selectionTo:
TTkHelper.hideCursor()
self.update()
self.copy()
return True
[docs] def mouseTapEvent(self, evt) -> bool:
self._selectionFrom = 0
self._selectionTo = len(self._text)
if self._selectionFrom < self._selectionTo:
TTkHelper.hideCursor()
self.update()
self.copy()
return True
@staticmethod
def _isFloat(num):
try:
float(str(num))
return True
except:
return False
@pyTTkSlot()
def copy(self):
if self._selectionFrom >= self._selectionTo: return
txt = self._text.substring(fr=self._selectionFrom,to=self._selectionTo)
self._clipboard.setText(txt)
@pyTTkSlot()
def cut(self):
self.copy()
self._text = self._text.substring(to=self._selectionFrom) + self._text.substring(fr=self._selectionTo)
self._cursorPos = self._selectionFrom
self.update()
@pyTTkSlot()
def paste(self):
txt = self._clipboard.text()
self.pasteEvent(txt)
def pasteEvent(self, txt:str):
txt = TTkString().join(txt.split('\n'))
text = self._text
if self._selectionFrom < self._selectionTo:
pre = text.substring(to=self._selectionFrom)
post = text.substring(fr=self._selectionTo)
self._cursorPos = self._selectionFrom
else:
pre = text.substring(to=self._cursorPos)
if self._replace:
post = text.substring(fr=self._cursorPos+1)
else:
post = text.substring(fr=self._cursorPos)
text = pre + txt + post
if ( self._inputType & TTkK.Input_Number and
not self._isFloat(text) ):
return True
self.setText(text, self._cursorPos+txt.termWidth())
self._pushCursor()
self.textEdited.emit(self._text)
return True
[docs] def keyEvent(self, evt):
baseText = self._text
if evt.type == TTkK.SpecialKey:
# Don't Handle the special focus switch key
if evt.key in (
TTkK.Key_Tab, TTkK.Key_Up, TTkK.Key_Down):
return False
# CTRL Pressed
if evt.mod==TTkK.ControlModifier:
if evt.key == TTkK.Key_C:
self.copy()
elif evt.key == TTkK.Key_V:
self.paste()
elif evt.key == TTkK.Key_X:
self.cut()
else:
return False
return True
if evt.key == TTkK.Key_Left:
if self._selectionFrom < self._selectionTo:
self._cursorPos = self._selectionTo
self._cursorPos = self._text.prevPos(self._cursorPos)
elif evt.key == TTkK.Key_Right:
if self._selectionFrom < self._selectionTo:
self._cursorPos = self._selectionTo-1
self._cursorPos = self._text.nextPos(self._cursorPos)
elif evt.key == TTkK.Key_End:
self._cursorPos = len(self._text)
elif evt.key == TTkK.Key_Home:
self._cursorPos = 0
elif evt.key == TTkK.Key_Insert:
self._replace = not self._replace
elif evt.key == TTkK.Key_Delete:
if self._selectionFrom < self._selectionTo:
self._text = self._text.substring(to=self._selectionFrom) + self._text.substring(fr=self._selectionTo)
self._cursorPos = self._selectionFrom
else:
self._text = self._text.substring(to=self._cursorPos) + self._text.substring(fr=self._text.nextPos(self._cursorPos))
elif evt.key == TTkK.Key_Backspace:
if self._selectionFrom < self._selectionTo:
self._text = self._text.substring(to=self._selectionFrom) + self._text.substring(fr=self._selectionTo)
self._cursorPos = self._selectionFrom
elif self._cursorPos > 0:
prev = self._text.prevPos(self._cursorPos)
self._text = self._text.substring(to=prev) + self._text.substring(fr=self._cursorPos)
self._cursorPos = prev
if ( self._inputType & TTkK.Input_Number and
not self._isFloat(self._text) ):
self.setText('0', 1)
self._pushCursor()
if evt.key == TTkK.Key_Enter:
self.returnPressed.emit()
else:
text = self._text
if self._selectionFrom < self._selectionTo:
pre = text.substring(to=self._selectionFrom)
post = text.substring(fr=self._selectionTo)
self._cursorPos = self._selectionFrom
else:
pre = text.substring(to=self._cursorPos)
if self._replace:
post = text.substring(fr=self._cursorPos+1)
else:
post = text.substring(fr=self._cursorPos)
text = pre + evt.key + post
if ( self._inputType & TTkK.Input_Number and
( evt.key in (' ') or not self._isFloat(text) )):
return True
self.setText(text, self._cursorPos+1)
self._pushCursor()
# Emit event only if the text changed
if baseText != self._text:
self.textEdited.emit(self._text)
return True
def focusInEvent(self):
self._pushCursor()
def focusOutEvent(self):
self._selectionFrom = 0
self._selectionTo = 0
TTkHelper.hideCursor()
self.update()
[docs] def paintEvent(self, canvas):
style = self.currentStyle()
color = style['color']
selectColor = style['selectedColor']
w = self.width()
text = TTkString('', color)
if self._echoMode != TTkLineEdit.EchoMode.NoEcho:
if ( self._echoMode == TTkLineEdit.EchoMode.Password or
( self._echoMode == TTkLineEdit.EchoMode.PasswordEchoOnEdit and
not self.hasFocus() )):
text += ("*"*(len(self._text)))
else:
text += self._text
if self._selectionFrom < self._selectionTo:
text = text.setColor(color=selectColor, posFrom=self._selectionFrom, posTo=self._selectionTo)
text = text.substring(self._offset)
canvas.drawText(pos=(0,0), text=text, color=color, width=w)