doc(TextEdit): improve documentation (#433)

Author: ceccopierangiolieugenio

libs/pyTermTk/TermTk/TTkCore/constant.py

@@ -348,7 +348,7 @@ class WrapMode(int):
     WrapAnywhere = WrapMode.WrapAnywhere
     WrapAtWordBoundaryOrAnywhere = WrapMode.WrapAtWordBoundaryOrAnywhere
 
-    class LineWrapMode(int):
+    class LineWrapMode(IntEnum):
         '''Those constants describes which wrapping status is required in the document
 
         .. autosummary::

libs/pyTermTk/TermTk/TTkCore/string.py

@@ -598,7 +598,7 @@ def findall(self, regexp, ignoreCase=False):
     def getIndexes(self, char):
         return [i for i,c in enumerate(self._text) if c==char]
 
-    def join(self, strings:list[TTkString]) -> TTkString:
+    def join(self, strings:Union[List[TTkString],List[str]]) -> TTkString:
         ''' Join the input strings using the current as separator
 
         :param strings: the list of strings to be joined
@@ -628,13 +628,13 @@ def _isSpecialWidthChar(ch):
                  unicodedata.category(ch) in ('Me','Mn') )
 
     @staticmethod
-    def _getWidthText(txt):
+    def _getWidthText(txt:str):
         return ( len(txt) +
             sum(unicodedata.east_asian_width(ch) == 'W' for ch in txt) -
             sum(unicodedata.category(ch) in ('Me','Mn') for ch in txt) )
 
     @staticmethod
-    def _getLenTextWoZero(txt):
+    def _getLenTextWoZero(txt:str):
         return ( len(txt) -
             sum(unicodedata.category(ch) in ('Me','Mn') for ch in txt) )
 

libs/pyTermTk/TermTk/TTkGui/textcursor.py

@@ -22,14 +22,18 @@
 
 __all__ = ['TTkTextCursor']
 
+from enum import IntEnum
+
+from typing import List
+
 try:
     from typing import Self
 except:
     class Self(): pass
 
 from TermTk.TTkCore.log import TTkLog
 from TermTk.TTkCore.color import TTkColor
-from TermTk.TTkCore.string import TTkString
+from TermTk.TTkCore.string import TTkString, TTkStringType
 from TermTk.TTkGui.textwrap1 import TTkTextWrap
 from TermTk.TTkGui.textdocument import TTkTextDocument
 
@@ -79,15 +83,15 @@ def hasSelection(self) -> bool:
         return not (self.position.line == self.anchor.line and self.position.pos == self.anchor.pos)
 
 class TTkTextCursor():
-    class MoveMode():
+    class MoveMode(IntEnum):
         MoveAnchor = 0x00
         '''Moves the anchor to the same position as the cursor itself.'''
         KeepAnchor = 0x01
         '''Keeps the anchor where it is.'''
     MoveAnchor = MoveMode.MoveAnchor
     KeepAnchor = MoveMode.KeepAnchor
 
-    class SelectionType():
+    class SelectionType(IntEnum):
         Document         = 0x03
         '''Selects the entire document.'''
         BlockUnderCursor = 0x02
@@ -101,7 +105,7 @@ class SelectionType():
     LineUnderCursor  = SelectionType.LineUnderCursor
     WordUnderCursor  = SelectionType.WordUnderCursor
 
-    class MoveOperation():
+    class MoveOperation(IntEnum):
         NoMove            = 0
         '''Keep the cursor where it is'''
         Start             = 1
@@ -267,7 +271,7 @@ def setPosition(self, line:int, pos:int, moveMode:MoveMode=MoveMode.MoveAnchor,
             self._properties[cID].anchor.set(line,pos)
         self._document.cursorPositionChanged.emit(self)
 
-    def getLinesUnderCursor(self) -> TTkString:
+    def getLinesUnderCursor(self) -> List[TTkString]:
         return [ self._document._dataLines[p.position.line] for p in self._properties ]
 
     def _checkCursors(self, notify:bool=False) -> None:
@@ -348,7 +352,7 @@ def moveEnd(cID,p,_):
     def document(self) -> TTkTextDocument:
         return self._document
 
-    def replaceText(self, text:TTkString, moveCursor:bool=False) -> None:
+    def replaceText(self, text:TTkStringType, moveCursor:bool=False) -> None:
         # if there is no selection, just select the next n chars till the end of the line
         # the newline is not replaced
         self._document._acquire()
@@ -365,7 +369,7 @@ def replaceText(self, text:TTkString, moveCursor:bool=False) -> None:
         self._document._release()
         return self.insertText(text, moveCursor)
 
-    def insertText(self, text:TTkString, moveCursor:bool=False) -> None:
+    def insertText(self, text:TTkStringType, moveCursor:bool=False) -> None:
         self._document._acquire()
         _lineFirst = -1
         if self.hasSelection():

libs/pyTermTk/TermTk/TTkGui/textdocument.py

@@ -27,7 +27,7 @@
 
 from TermTk.TTkCore.log import TTkLog
 from TermTk.TTkCore.signal import pyTTkSignal, pyTTkSlot
-from TermTk.TTkCore.string import TTkString
+from TermTk.TTkCore.string import TTkString, TTkStringType
 from TermTk.TTkCore.color import TTkColor
 
 if TYPE_CHECKING:
@@ -141,7 +141,7 @@ def _getSnap(self, lines, d):
         'undoAvailable', 'redoAvailable', 'undoCommandAdded',
         'modificationChanged'
         )
-    def __init__(self, *, text:Union[TTkString,str]=_default_init_text) -> None:
+    def __init__(self, *, text:TTkStringType=_default_init_text) -> None:
         from TermTk.TTkGui.textcursor import TTkTextCursor
         self._docMutex = Lock()
         self.cursorPositionChanged = pyTTkSignal(TTkTextCursor)
@@ -238,7 +238,7 @@ def lineCount(self):
     def characterCount(self):
         return sum([len[x] for x in self._dataLines])+self.lineCount()
 
-    def setText(self, text:Union[str,TTkString]):
+    def setText(self, text:TTkStringType) -> None:
         remLines = len(self._dataLines)
         if not isinstance(text, str) and not isinstance(text,TTkString):
             text=str(text)
@@ -252,7 +252,7 @@ def setText(self, text:Union[str,TTkString]):
         self.contentsChange.emit(0,remLines,len(self._dataLines))
         self._snapChanged = None
 
-    def appendText(self, text):
+    def appendText(self, text) -> None:
         if type(text) == str:
             text = TTkString() + text
         if len(self._dataLines) == 1 and self._dataLines[0] == TTkString(TTkTextDocument._default_init_text):
@@ -313,7 +313,7 @@ def saveSnapshot(self, cursor):
         self.undoAvailable.emit(self.isUndoAvailable())
         self.redoAvailable.emit(self.isRedoAvailable())
 
-    def find(self, exp) -> TTkTextCursor:
+    def find(self, exp:TTkStringType) -> TTkTextCursor:
         for i,line in enumerate(self._dataLines):
             if -1 != (pos := line.find(str(exp))):
                 from .textcursor import TTkTextCursor

libs/pyTermTk/TermTk/TTkWidgets/label.py

@@ -25,7 +25,7 @@
 from TermTk.TTkCore.constant import TTkK
 from TermTk.TTkCore.color import TTkColor
 from TermTk.TTkCore.canvas import TTkCanvas
-from TermTk.TTkCore.string import TTkString
+from TermTk.TTkCore.string import TTkString, TTkStringType
 from TermTk.TTkCore.signal import pyTTkSlot
 from TermTk.TTkWidgets.widget import TTkWidget
 
@@ -78,11 +78,11 @@ def text(self) -> TTkString:
         '''text'''
         return TTkString('\n').join(self._text)
 
-    @pyTTkSlot(str)
-    def setText(self, text:TTkString):
+    @pyTTkSlot(TTkStringType)
+    def setText(self, text:TTkStringType):
         '''setText'''
         if self.text().sameAs(text): return
-        if issubclass(type(text), TTkString):
+        if isinstance(text, TTkString):
             self._text  = text.split('\n')
         else:
             self._text  = TTkString(text).split('\n')

libs/pyTermTk/TermTk/TTkWidgets/lineedit.py

@@ -26,7 +26,7 @@
 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.string import TTkString, TTkStringType
 from TermTk.TTkCore.color import TTkColor
 from TermTk.TTkCore.signal import pyTTkSlot, pyTTkSignal
 from TermTk.TTkCore.TTkTerm.inputkey import TTkKeyEvent
@@ -100,8 +100,8 @@ def __init__(self, *,
         self.setFocusPolicy(TTkK.ClickFocus + TTkK.TabFocus)
         self.enableWidgetCursor()
 
-    @pyTTkSlot(str)
-    def setText(self, text, cursorPos=0x1000):
+    @pyTTkSlot(TTkStringType)
+    def setText(self, text:TTkStringType, cursorPos=0x1000):
         '''setText'''
         if text != self._text:
             self.textChanged.emit(text)