TTkTextEditRuler

class TTkTextEditRuler(startingNumber=0, **kwargs)

Bases: TTkAbstractScrollView

Ruler widget for TTkTextEdit.

Displays line numbers and one or more marker columns provided by MarkRuler instances. The ruler listens to a TTkTextWrap instance to compute its preferred width when lines are wrapped.

TTkContainer’s inherited init params:

Parameters:

• layout (TermTk.TTkLayouts) – the layout of this widget, optional, defaults to TTkLayout

• padding (TTkPadding) – the padding (top, bottom, left, right) of the widget, defaults to (0,0,0,0)

• paddingTop (int) – the Top padding, override Top padding if already defined, optional, default=0 if padding is not defined

• paddingBottom (int) – the Bottom padding, override Bottom padding if already defined, optional, default=0 if padding is not defined

• paddingLeft (int) – the Left padding, override Left padding if already defined, optional, default=0 if padding is not defined

• paddingRight (int) – the Right padding, override Right padding if already defined, optional, default=0 if padding is not defined

• forwardStyle (bool) – [Experimental] any change of style will reflect the children, defaults to False

TTkWidget’s inherited init params:

Parameters:

• name (str, optional) – the name of the widget, defaults to “”

• parent (TTkWidget, optional) – the parent widget, defaults to None

• x (int, optional) – the x position, defaults to 0

• y (int, optional) – the y position, defaults to 0

• pos ((int,int), optional) – the [x,y] position (override the previously defined x, y), defaults to (x,y)

• width (int, optional) – the width of the widget, defaults to 0

• height (int, optional) – the height of the widget, defaults to 0

• size ((int,int), optional) – the size [width, height] of the widget (override the previously defined sizes), defaults to (width,height)

• maxWidth (int, optional) – the maxWidth of the widget, defaults to 0x10000

• maxHeight (int, optional) – the maxHeight of the widget, defaults to 0x10000

• maxSize ((int,int), optional) – the max [width,height] of the widget, optional, defaults to (maxWidth,maxHeight)

• minWidth (int, optional) – the minWidth of the widget, defaults to 0

• minHeight (int, optional) – the minHeight of the widget, defaults to 0

• minSize ((int,int), optional) – the minSize [width,height] of the widget, optional, defaults to (minWidth,minHeight)

• toolTip (TTkString, optional) – This property holds the widget’s tooltip, defaults to ‘’

• style (dict, optional) – this field hold the custom style to be used by this widget

• addStyle (dict, optional) – this field is required to override/merge the new style on top of the current one, useful if only few params need to be changed

• visible (bool, optional) – the visibility, optional, defaults to True

• enabled (bool, optional) – the ability to handle input events, optional, defaults to True

TMouseEvents’s inherited init params:

Initialize self. See help(type(self)) for accurate signature.

TDragEvents’s inherited init params:

Initialize self. See help(type(self)) for accurate signature.

Style

classStyle = {
            'default':     {
                'color': TTkColor.fg("#88aaaa")+TTkColor.bg("#333333"),
                'wrapColor': TTkColor.fg("#888888")+TTkColor.bg("#333333"),
                'separatorColor': TTkColor.fg("#444444")},
            'disabled':    {
                'color': TTkColor.fg('#888888'),
                'wrapColor': TTkColor.fg('#888888'),
                'separatorColor': TTkColor.fg("#888888")},
        }

Signals

closed	This signal is emitted whenever the widget is closed
currentStyleChanged	This signal is emitted whenever the widget stye change
focusChanged	This signal is emitted whenever the focus status change i.e. with the setFocus() or clearFocus() methods.
sizeChanged	This signal is emitted whenever the widget size change
viewChanged	This signal is emitted whenever there is a change in the view content topology (size,pos)
viewMovedTo	This signal is emitted when the view content move to a new position (x,y),
viewSizeChanged	This signal is emitted when the view content size changed

Slots

Slots Inherited from: TTkAbstractScrollView

viewMoveTo(x, y)

Move the view to the specified offset position

Slots Inherited from: TTkContainer

hide()	hide the widget
show()	show the widget

Slots Inherited from: TTkWidget

close()	Close (Destroy/Remove) the widget
hide()	hide the widget
lowerWidget()	Lower the Widget below its relatives
raiseWidget([raiseParent])	Raise the Widget above its relatives
setDisabled([disabled])	This property holds whether the widget is disabled
setEnabled([enabled])	This property holds whether the widget is enabled
setFocus()	Focus the widget
setVisible(visible)	Set the visibility status of this widget
show()	show the widget
update([repaint, updateLayout, updateParent])	Update the widget and emit viewChanged signal if layout is updated

Members

closed: pyTTkSignal

This signal is emitted whenever the widget is closed

Parameters:

widget (TTkWidget) – the widget closed (=self)

currentStyleChanged: pyTTkSignal

This signal is emitted whenever the widget stye change

Parameters:

style (dict) – the new style applied

focusChanged: pyTTkSignal

This signal is emitted whenever the focus status change i.e. with the setFocus() or clearFocus() methods

Parameters:

status (bool) – the curent focus status

sizeChanged: pyTTkSignal

This signal is emitted whenever the widget size change

Parameters:

• width (int) – the new widget width

• height (int) – the new widget height

viewChanged: pyTTkSignal

This signal is emitted whenever there is a change in the view content topology (size,pos)

Note

This signal must be implemented in any implementation of TTkAbstractScrollView to notify that the view content boudaries changed

viewMovedTo: pyTTkSignal

This signal is emitted when the view content move to a new position (x,y),

Parameters:

• x (int) – the new horizontal offset

• y (int) – the new vertical offset

viewSizeChanged: pyTTkSignal

This signal is emitted when the view content size changed

Parameters:

• width (int) – the new width

• height (int) – the new height

Methods

addMarkRuler(markRuler: MarkRuler) → None

setTextWrap(tw: TTkTextWrap) → None

Methods Inherited from: TTkAbstractScrollView

getViewOffsets()	Retrieve the vertical and horizontal offsets of the TTkAbstractScrollViewInterface
resizeEvent(w, h)	Handle resize events
setPadding(top, bottom, left, right)	Set the padding and emit viewChanged signal
update([repaint, updateLayout, updateParent])	Update the widget and emit viewChanged signal if layout is updated
viewDisplayedSize()	Return the displayed size of this view
viewFullAreaSize()	Return the full area size including padding
viewMoveTo(x, y)	Move the view to the specified offset position
wheelEvent(evt)	Handle mouse wheel events for scrolling

Methods Inherited from: TTkContainer

addWidget(widget)
getPadding()	Retrieve the TTkContainer's paddings sizes as shown in Layout Topology
getWidgetByName(name)	Return the widget from its name.
hide()	hide the widget
keyEvent(evt)	This event handler, can be reimplemented in a subclass to receive key events for the widget.
layout()	Get the Layout
maximumHeight()	Retrieve the maximum height
maximumWidth()	Retrieve the maximum width
minimumHeight()	Retrieve the minimum height
minimumWidth()	Retrieve the minimum width
paintChildCanvas()
removeWidget(widget)
rootLayout()	This is a root layout mainly used to place items that are not supposed to be inside the main layout (i.e. the menu elements).
setCurrentStyle(*args, **kwargs)	Set the currently active style
setLayout(layout)	Set the Layout used by this widget to place all the child widgets.
setPadding(top, bottom, left, right)	Set the padding and emit viewChanged signal
show()	show the widget
update([repaint, updateLayout, updateParent])	Update the widget and emit viewChanged signal if layout is updated

Methods Inherited from: TTkWidget

clearFocus()	Remove the Focus state of this widget
close()	Close (Destroy/Remove) the widget
currentStyle()	Retrieve the currently active style
disableWidgetCursor([disable])	Disable or enable the widget cursor
enableWidgetCursor([enable])	Enable or disable the widget cursor
focusInEvent()	Callback triggered when the widget receives focus
focusOutEvent()	Callback triggered when the widget loses focus
focusPolicy()	Retrieve the focus policy of this widget
geometry()	Retrieve the widget geometry
getCanvas()	Retrieve the widget canvas
getPixmap()	Convenience function which return a pixmap representing the current widget status
getWidgetByName(name)	Return the widget from its name.
hasFocus()	This property holds the focus status of this widget
height()	Retrieve the widget height
hide()	hide the widget
isEnabled()	This property holds whether the widget is enabled
isEntered()	Check if the mouse cursor is currently over this widget
isVisible()	Retrieve the visibility status of this widget
isVisibleAndParent()	Check if the widget and all its parents are visible
lowerWidget()	Lower the Widget below its relatives
maxDimension(orientation)	Retrieve the maximum dimension for the given orientation
maximumHeight()	Retrieve the maximum height
maximumSize()	Retrieve the maximum size
maximumWidth()	Retrieve the maximum width
mergeStyle(style)	Merge additional style properties with the existing style
minDimension(orientation)	Retrieve the minimum dimension for the given orientation
minimumHeight()	Retrieve the minimum height
minimumSize()	Retrieve the minimum size
minimumWidth()	Retrieve the minimum width
mouseEvent(evt)	Handle mouse events for this widget and its children
move(x, y)	Move the widget
moveEvent(x, y)	Convenience function, Event Callback triggered after a successful move
name()	Retrieve the name of this widget
paintChildCanvas()
paintEvent(canvas)	Paint Event callback, this need to be overridden in the widget.
parentWidget()	Retrieve the parent widget
pasteEvent(txt)	Callback triggered when a paste event is forwarded to this widget.
pos()	Retrieve the widget position
raiseWidget([raiseParent])	Raise the Widget above its relatives
resize(width, height)	Resize the widget
resizeEvent(w, h)	Handle resize events
setCurrentStyle(*args, **kwargs)	Set the currently active style
setDefaultSize(arg, width, height)	Set default size if not already specified in arguments
setDisabled([disabled])	This property holds whether the widget is disabled
setDropEventProxy(proxy)
setEnabled([enabled])	This property holds whether the widget is enabled
setFocus()	Focus the widget
setFocusPolicy(policy)	This property holds the way the widget accepts keyboard focus
setGeometry(x, y, width, height)	Resize and move the widget
setMaximumHeight(maxh)	Set the maximum height of the widget
setMaximumSize(maxw, maxh)	Set the maximum size of the widget
setMaximumWidth(maxw)	Set the maximum width of the widget
setMinimumHeight(minh)	Set the minimum height of the widget
setMinimumSize(minw, minh)	Set the minimum size of the widget
setMinimumWidth(minw)	Set the minimum width of the widget
setName(name)	Set the name of this Instance
setParent(parent)	Set the parent widget
setStyle([style])	Set the style for the widget
setToolTip(toolTip)	Set the widget tooltip
setVisible(visible)	Set the visibility status of this widget
setWidgetCursor([pos, type])	Set the widget cursor position and type
show()	show the widget
size()	Retrieve the widget size
style()	Retrieve a copy of the widget style dictionary
toolTip()	Retrieve the widget tooltip
update([repaint, updateLayout, updateParent])	Update the widget and emit viewChanged signal if layout is updated
widgetItem()	Retrieve the widget item (layout item wrapper)
width()	Retrieve the widget width
x()	Retrieve the horizontal position
y()	Retrieve the vertical position

Methods Inherited from: TMouseEvents

enterEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse enter events for the widget.
leaveEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse leave events for the widget.
mouseDoubleClickEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse click events for the widget.
mouseDragEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse drag events for the widget.
mouseMoveEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse move events for the widget.
mousePressEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse press events for the widget.
mouseReleaseEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse release events for the widget.
mouseTapEvent(evt)	This event handler, can be reimplemented in a subclass to receive mouse click events for the widget.
wheelEvent(evt)	Handle mouse wheel events for scrolling

Methods Inherited from: TKeyEvents

keyEvent(evt)

This event handler, can be reimplemented in a subclass to receive key events for the widget.

Methods Inherited from: TDragEvents

dragEnterEvent(evt)	This event handler, can be reimplemented in a subclass to receive drag events for the widget.
dragLeaveEvent(evt)	This event handler, can be reimplemented in a subclass to receive drag events for the widget.
dragMoveEvent(evt)	This event handler, can be reimplemented in a subclass to receive drag events for the widget.
dropEvent(evt)	This event handler, can be reimplemented in a subclass to receive drag events for the widget.

TTkTextEditRuler Classes

class MarkRuler(markers: dict[int, TTkString])

Bases: object

Column of per-line markers shown in the text edit ruler.

Each MarkRuler holds a mapping from document line index to a small integer state. The state selects one of the provided TTkString markers to render for that line. States can be cycled with nextState.

class States

Bases: int

getState(line: int) → int

Get the marker state for a document line.

Parameters:

line (int) – document line index

Returns:

state value for the line

Return type:

int

getTTkStr(line: int) → TTkString

Return the TTkString marker for a given document line.

Parameters:

line (int) – document line index

Returns:

TTkString to render for the line

Return type:

TTkString

nextState(state: int) → int

Return the next state value after state.

Parameters:

state (int) – current state value

Returns:

next state value

Return type:

int

setState(line: int, state: int) → None

Set the marker state for a document line.

If the state equals the default state, the explicit entry is removed to keep the internal map sparse.

Parameters:

• line (int) – document line index

• state (int) – state value to set

width() → int

Return column width in terminal cells.

Returns:

width in terminal cells

Return type:

int

TTkTextEditRuler Attributes

classStyle