krita.sceditor.widget.EditorView Class Reference

Inheritance diagram for krita.sceditor.widget.EditorView:

Public Member Functions
	__init__ (self, parent=None, text=None, EditorHighlighterClass=PythonHighlighter, indenter=PythonCodeIndenter)
	after_return_pressed (self)
	autocomplete_pressed (self)
	backspace_pressed (self)
	backtab_pressed (self)
	closeEvent (self, event)
	dedent (self)
	goto (self, line_no)
	highline (self, cursor)
	indent (self)
	isModified (self)
	keyPressEvent (self, event)
	length (self)
	move_end_of_doc (self)
	move_end_of_row (self)
	move_start_of_doc (self)
	move_start_of_row (self)
	onCursorPositionChanged (self)
	paintEvent (self, event)
	paren_opened (self, key)
	resizeEvent (self, event)
	setDocument (self, document)
	setModified (self, flag)
	tab_pressed (self)

Public Attributes
	autocomplete
	calltip
	disable_shortcuts
	draw_line
	frame_style
	highlight_brush
	highlight_color
	highlight_line
	highlighter
	indenter
	last_block
	last_col
	last_row
	line
	line_pen
	onCursorPositionChanged
	print_width
	prj

Protected Member Functions
	_create_line (self)

Detailed Description

Definition at line 93 of file widget.py.

Constructor & Destructor Documentation

__init__()

krita.sceditor.widget.EditorView.__init__	(		self,
			parent = None,
			text = None,
			EditorHighlighterClass = PythonHighlighter,
			indenter = PythonCodeIndenter )

Definition at line 95 of file widget.py.

                 indenter=PythonCodeIndenter):
        QPlainTextEdit.__init__(self, parent)
        self.setFrameStyle(QFrame.Shape.NoFrame)
        self.setTabStopWidth(4)
        self.setLineWrapMode(QPlainTextEdit.LineWrapMode.NoWrap)
        font = QFont()
        font.setFamily("lucidasanstypewriter")
        font.setFixedPitch(True)
        font.setPointSize(10)
        self.setFont(font)
        self.highlighter = EditorHighlighterClass(self)
        if text:
            self.setPlainText(text)
        self.frame_style = self.frameStyle()
        self.draw_line = True
        self.print_width = self.fontMetrics().horizontalAdvance("x" * 78)
        self.line_pen = QPen(QColor("lightgrey"))
        self.last_row = self.last_col = -1
        self.last_block = None
        self.highlight_line = True
        self.highlight_color = self.palette().highlight().color().light(175)
        self.highlight_brush = QBrush(QColor(self.highlight_color))
        self.cursorPositionChanged.connect(self.onCursorPositionChanged)
        self.indenter = indenter(RopeEditorWrapper(self))
        # True if you want to catch Emacs keys in actions
        self.disable_shortcuts = False
 
        self.prj = get_no_project()
        self.prj.root = None
        self.calltip = CallTip(self)
        self.autocomplete = AutoComplete(self)
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, xcfLayer.dim, and KisTextBrush.setFont().

Member Function Documentation

_create_line()

krita.sceditor.widget.EditorView._create_line ( self )

protected

Definition at line 197 of file widget.py.

    def _create_line(self):
        x = self.print_width
        self.line = QLine(x, 0, x, self.height())
 

References krita.sceditor.widget.EditorView.print_width.

after_return_pressed()

krita.sceditor.widget.EditorView.after_return_pressed

(

self

)

Definition at line 254 of file widget.py.

    def after_return_pressed(self):
        self.indenter.entering_new_line(self.textCursor().blockNumber())
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, xcfLayer.dim, and krita.sceditor.widget.EditorView.indenter.

autocomplete_pressed()

krita.sceditor.widget.EditorView.autocomplete_pressed

(

self

)

Definition at line 243 of file widget.py.

    def autocomplete_pressed(self):
        try:
            items = code_assist(self.prj,
                                unicode(self.toPlainText()),
                                self.textCursor().position())
        except Exception as e:
            items = []
        if items:
            self.autocomplete.setItems(items)
            self.autocomplete.show()
 

References krita.sceditor.widget.EditorView.autocomplete, KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, xcfLayer.dim, krita.sceditor.widget.EditorView.prj, and krita.sceditor.widget.EditorWidget.toPlainText().

backspace_pressed()

krita.sceditor.widget.EditorView.backspace_pressed

(

self

)

Definition at line 235 of file widget.py.

    def backspace_pressed(self):
        cursor = self.textCursor()
        text = unicode(cursor.block().text())
        col = cursor.columnNumber()
        if col > 0 and text[:col].strip() == "":
            self.indenter.deindent(self.textCursor().blockNumber())
            return True
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, xcfLayer.dim, and krita.sceditor.widget.EditorView.indenter.

backtab_pressed()

krita.sceditor.widget.EditorView.backtab_pressed

(

self

)

Definition at line 231 of file widget.py.

    def backtab_pressed(self):
        self.dedent()
        return True
 

References krita.sceditor.widget.EditorView.dedent(), and scripter.ui_scripter.editor.pythoneditor.CodeEditor.dedent().

closeEvent()

krita.sceditor.widget.EditorView.closeEvent	(		self,
			event )

Definition at line 129 of file widget.py.

    def closeEvent(self, event):
        self.calltip.close()
        self.autocomplete.close()
 

References krita.sceditor.widget.EditorView.autocomplete, and krita.sceditor.widget.EditorView.calltip.

dedent()

krita.sceditor.widget.EditorView.dedent

(

self

)

Definition at line 228 of file widget.py.

    def dedent(self):
        self.indenter.deindent(self.textCursor().blockNumber())
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, xcfLayer.dim, and krita.sceditor.widget.EditorView.indenter.

goto()

krita.sceditor.widget.EditorView.goto	(		self,
			line_no )

Definition at line 142 of file widget.py.

    def goto(self, line_no):
        cursor = self.textCursor()
        block = cursor.block()
        row = cursor.blockNumber()
        while row > line_no:
            block = block.previous()
            row -= 1
        while row < line_no:
            block = block.next()
            row += 1
        cursor = QTextCursor(block)
        self.setTextCursor(cursor)
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, and xcfLayer.dim.

highline()

krita.sceditor.widget.EditorView.highline	(		self,
			cursor )

Definition at line 183 of file widget.py.

    def highline(self, cursor):
        self.viewport().update()
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, and xcfLayer.dim.

indent()

krita.sceditor.widget.EditorView.indent

(

self

)

Definition at line 222 of file widget.py.

    def indent(self):
        self.indenter.correct_indentation(self.textCursor().blockNumber())
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, xcfLayer.dim, and krita.sceditor.widget.EditorView.indenter.

isModified()

krita.sceditor.widget.EditorView.isModified

(

self

)

Definition at line 133 of file widget.py.

    def isModified(self):
        return self.document().isModified()
 

References KoTextShapeDataBase.document(), KoTextShapeDataBasePrivate.document, krita::Document::Private.document, Document.document(), View.document(), KisAslXmlWriter::Private.document, KisAslXmlWriter.document(), KisDecorationsWrapperLayer::Private.document, KisDecorationsWrapperLayer.document(), KisView.document, KisViewManager.document(), ToolReferenceImages.document(), KoShapeAnchor::TextLocation.document(), KisAnimationImporter::Private.document, KisCloneDocumentStroke.document, KisView.document(), KoItemToolTip.document, KisTimeBasedItemModel::Private.document, KisTimeBasedItemModel.document(), krita.sceditor.highlighter.PythonHighlighter.document, KisKraLoader::Private.document, scripter.ui_scripter.syntax.syntax.PythonHighlighter.document, and krita.sceditor.widget.EditorView.isModified().

keyPressEvent()

krita.sceditor.widget.EditorView.keyPressEvent	(		self,
			event )

Definition at line 257 of file widget.py.

    def keyPressEvent(self, event):
        if self.autocomplete.active:
            if self.autocomplete.keyPressEvent(event):
                return
        elif self.calltip.active:
            if self.calltip.keyPressEvent(event):
                return
 
        m = event.modifiers()
        k = event.key()
        t = event.text()
        # Disable some shortcuts
        if self.disable_shortcuts and \
                m & Qt.KeyboardModifier.ControlModifier and k in [Qt.Key.Key_A, Qt.Key.Key_R,
                                                 Qt.Key.Key_C, Qt.Key.Key_K,
                                                 Qt.Key.Key_X, Qt.Key.Key_V,
                                                 Qt.Key.Key_Y, Qt.Key.Key_Z]:
            new_ev = QKeyEvent(event.type(), k, m, t)
            event.ignore()
            QCoreApplication.postEvent(self.parent(), new_ev)
            return
        elif k == Qt.Key.Key_Tab:
            if self.tab_pressed():
                return
        elif k == Qt.Key.Key_Backtab:
            if self.backtab_pressed():
                return
        elif k == Qt.Key.Key_Backspace:
            if self.backspace_pressed():
                return
        elif k == Qt.Key.Key_Period or \
                (k == Qt.Key.Key_Space and event.modifiers() == Qt.KeyboardModifier.ControlModifier):
            QPlainTextEdit.keyPressEvent(self, event)
            self.autocomplete_pressed()
            return
        elif k in [Qt.Key.Key_ParenLeft, Qt.Key.Key_BraceLeft, Qt.Key.Key_BracketLeft]:
            QPlainTextEdit.keyPressEvent(self, event)
            self.paren_opened(k)
            return
        QPlainTextEdit.keyPressEvent(self, event)
        if k == Qt.Key.Key_Return or k == Qt.Key.Key_Enter:
            self.after_return_pressed()
 

References krita.sceditor.widget.EditorView.after_return_pressed(), krita.sceditor.widget.EditorView.autocomplete, krita.sceditor.widget.EditorView.autocomplete_pressed(), krita.sceditor.widget.EditorView.backspace_pressed(), krita.sceditor.widget.EditorView.backtab_pressed(), krita.sceditor.widget.EditorView.calltip, krita.sceditor.widget.EditorView.disable_shortcuts, krita.sceditor.widget.EditorView.keyPressEvent(), krita.sceditor.widget.EditorView.paren_opened(), KoPathPoint.parent(), KoRTree< KoShape * >::Node.parent(), KoRTree< T >::Node.parent(), KoShape.parent(), KUndo2Model.parent(), KoShape::Private.parent, KoToolProxyPrivate.parent, KoFontGlyphModel.parent(), KisForestDetail::RootNodeImpl< Node< T > >< FontFamilyNode >.parent, KisForestDetail::RootNodeImpl< Base >.parent, KisForestDetail::RootNodeImpl< Node< T > >.parent, KisForestDetail::RootNodeImpl< Node< T > >< KoSvgTextContentElement >.parent, KisForestDetail::RootNodeImpl< Node< T > >< T >.parent, KisLayerUtils::RemoveNodeHelper::ReplacementNode.parent, KisMementoItem.parent(), KisNode.parent(), KisPaintDevice::Private.parent, StoryboardChild.parent(), KisProjectionLeaf.parent(), KisNodeDummy.parent(), KisForestDetail::ChildIterator< T, is_const >.parent, KisNode.parent, KisFiltersModel.parent(), KisNodeModel.parent(), KoZoomAction.parent, KoFileDialog.parent, KDEPrivate::ToolBarHandler::Private.parent, KisKXMLGUI::ContainerNode.parent, EnhancedPathParameter.parent(), FontStyleModel.parent(), KisAnimCurvesChannelsModel.parent(), KisUndoModel.parent(), FontAxesModel.parent(), StoryboardModel.parent(), OpenTypeFeatureModel.parent(), mikro.PyQtClass.parent(), ExrLayerInfoBase.parent, KDcrawIface::RExpanderBox.parent, channels2layers.channels2layers.ChannelsToLayers.parent, filtermanager.components.filtermanagertreeitem.FilterManagerTreeItem.parent(), scripter.ui_scripter.actions.closeaction.closeaction.CloseAction.parent(), scripter.ui_scripter.actions.debugaction.debugaction.DebugAction.parent(), scripter.ui_scripter.actions.newaction.newaction.NewAction.parent(), scripter.ui_scripter.actions.openaction.openaction.OpenAction.parent(), scripter.ui_scripter.actions.reloadaction.reloadaction.ReloadAction.parent(), scripter.ui_scripter.actions.runaction.runaction.RunAction.parent(), scripter.ui_scripter.actions.saveaction.saveaction.SaveAction.parent(), scripter.ui_scripter.actions.saveasaction.saveasaction.SaveAsAction.parent(), scripter.ui_scripter.actions.settingsaction.settingsaction.SettingsAction.parent(), filtermanager.components.filtermanagertreemodel.FilterManagerTreeModel.parent(), plugin_importer.plugin_importer_extension.PluginImporterExtension.parent, DefaultToolTextPropertiesInterface.parent, SvgTextCursorPropertyInterface::Private.parent, TagFilterProxyModelQmlWrapper::Private.parent, and krita.sceditor.widget.EditorView.tab_pressed().

length()

krita.sceditor.widget.EditorView.length

(

self

)

Definition at line 139 of file widget.py.

    def length(self):
        return self.document().blockCount()
 

References KoTextShapeDataBase.document(), KoTextShapeDataBasePrivate.document, krita::Document::Private.document, Document.document(), View.document(), KisAslXmlWriter::Private.document, KisAslXmlWriter.document(), KisDecorationsWrapperLayer::Private.document, KisDecorationsWrapperLayer.document(), KisView.document, KisViewManager.document(), ToolReferenceImages.document(), KoShapeAnchor::TextLocation.document(), KisAnimationImporter::Private.document, KisCloneDocumentStroke.document, KisView.document(), KoItemToolTip.document, KisTimeBasedItemModel::Private.document, KisTimeBasedItemModel.document(), krita.sceditor.highlighter.PythonHighlighter.document, KisKraLoader::Private.document, and scripter.ui_scripter.syntax.syntax.PythonHighlighter.document.

move_end_of_doc()

krita.sceditor.widget.EditorView.move_end_of_doc

(

self

)

Definition at line 160 of file widget.py.

    def move_end_of_doc(self):
        cursor = self.textCursor()
        block = cursor.block()
        while block.isValid():
            last_block = block
            block = block.next()
        cursor.setPosition(last_block.position())
        cursor.movePosition(
            QTextCursor.MoveOperation.EndOfBlock, QTextCursor.MoveMode.MoveAnchor)
        self.setTextCursor(cursor)
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, and xcfLayer.dim.

move_end_of_row()

krita.sceditor.widget.EditorView.move_end_of_row

(

self

)

Definition at line 177 of file widget.py.

    def move_end_of_row(self):
        cursor = self.textCursor()
        cursor.movePosition(
            QTextCursor.MoveOperation.EndOfBlock, QTextCursor.MoveMode.MoveAnchor)
        self.setTextCursor(cursor)
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, and xcfLayer.dim.

move_start_of_doc()

krita.sceditor.widget.EditorView.move_start_of_doc

(

self

)

Definition at line 155 of file widget.py.

    def move_start_of_doc(self):
        cursor = self.textCursor()
        cursor.setPosition(0)
        self.setTextCursor(cursor)
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, and xcfLayer.dim.

move_start_of_row()

krita.sceditor.widget.EditorView.move_start_of_row

(

self

)

Definition at line 171 of file widget.py.

    def move_start_of_row(self):
        cursor = self.textCursor()
        cursor.movePosition(
            QTextCursor.MoveOperation.StartOfBlock, QTextCursor.MoveMode.MoveAnchor)
        self.setTextCursor(cursor)
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, and xcfLayer.dim.

onCursorPositionChanged()

krita.sceditor.widget.EditorView.onCursorPositionChanged

(

self

)

Definition at line 186 of file widget.py.

    def onCursorPositionChanged(self):
        cursor = self.textCursor()
        row, col = cursor.blockNumber(), cursor.columnNumber()
        if self.last_row != row:
            self.last_row = row
            if self.highlight_line:
                self.highline(cursor)
        if col != self.last_col:
            self.last_col = col
        self.cursorPositionChanged.emit(row, col)
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, xcfLayer.dim, krita.sceditor.widget.EditorView.highlight_line, krita.sceditor.widget.EditorView.highline(), krita.sceditor.widget.EditorView.last_col, and krita.sceditor.widget.EditorView.last_row.

paintEvent()

krita.sceditor.widget.EditorView.paintEvent	(		self,
			event )

Definition at line 205 of file widget.py.

    def paintEvent(self, event):
        painter = QPainter(self.viewport())
        if self.highlight_line:
            r = self.cursorRect()
            r.setX(0)
            r.setWidth(self.viewport().width())
            painter.fillRect(r, self.highlight_brush)
        if self.draw_line:
            painter.setPen(self.line_pen)
            painter.drawLine(self.line)
        painter.end()
        QPlainTextEdit.paintEvent(self, event)
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, xcfLayer.dim, krita.sceditor.widget.EditorView.draw_line, krita.sceditor.widget.EditorView.highlight_brush, krita.sceditor.widget.EditorView.highlight_line, psd_layer_type_tool.line, krita.sceditor.widget.EditorView.line, KDcrawIface::RLabelExpander.line, colorspace.uicolorspace.UIColorSpace.line, documenttools.uidocumenttools.UIDocumentTools.line, exportlayers.uiexportlayers.UIExportLayers.line, filtermanager.uifiltermanager.UIFilterManager.line, and krita.sceditor.widget.EditorView.line_pen.

paren_opened()

krita.sceditor.widget.EditorView.paren_opened	(		self,
			key )

Definition at line 300 of file widget.py.

    def paren_opened(self, key):
        close_char = {
            Qt.Key.Key_ParenLeft: ")",
            Qt.Key.Key_BraceLeft: " }",
            Qt.Key.Key_BracketLeft: "]"
        }
        cursor = self.textCursor()
        cursor.insertText(close_char[key])
        cursor.setPosition(cursor.position() - 1)
        self.setTextCursor(cursor)
 
 

References KisPipeBrushParasite.dim, KisSpinBoxUnitManager.dim, FlattenSpec.dim, and xcfLayer.dim.

resizeEvent()

krita.sceditor.widget.EditorView.resizeEvent	(		self,
			event )

Definition at line 201 of file widget.py.

    def resizeEvent(self, event):
        self._create_line()
        QPlainTextEdit.resizeEvent(self, event)
 

References krita.sceditor.widget.EditorView._create_line().

setDocument()

krita.sceditor.widget.EditorView.setDocument	(		self,
			document )

Definition at line 218 of file widget.py.

    def setDocument(self, document):
        QPlainTextEdit.setDocument(self, document)
        self.highlighter.setDocument(document)
 

References krita.sceditor.console.PythonConsole.highlighter, krita.sceditor.console.QtQmlConsole.highlighter, krita.sceditor.widget.EditorView.highlighter, krita.sceditor.widget.QtQmlEditorWidget.highlighter, and krita.sceditor.widget.EditorView.setDocument().

setModified()

krita.sceditor.widget.EditorView.setModified	(		self,
			flag )

Definition at line 136 of file widget.py.

    def setModified(self, flag):
        self.document().setModified(flag)
 

References KoTextShapeDataBase.document(), Document.document(), View.document(), KisAslXmlWriter.document(), KisDecorationsWrapperLayer.document(), KisView.document(), KisViewManager.document(), KisTimeBasedItemModel.document(), ToolReferenceImages.document(), KoShapeAnchor::TextLocation.document(), KoTextShapeDataBasePrivate.document, krita::Document::Private.document, KisAslXmlWriter::Private.document, KisAnimationImporter::Private.document, KisCloneDocumentStroke.document, KisDecorationsWrapperLayer::Private.document, KisView.document, KoItemToolTip.document, KisTimeBasedItemModel::Private.document, krita.sceditor.highlighter.PythonHighlighter.document, KisKraLoader::Private.document, scripter.ui_scripter.syntax.syntax.PythonHighlighter.document, and krita.sceditor.widget.EditorView.setModified().

tab_pressed()

krita.sceditor.widget.EditorView.tab_pressed

(

self

)

Definition at line 225 of file widget.py.

    def tab_pressed(self):
        self.indent()
 

References krita.sceditor.widget.EditorView.indent(), scripter.ui_scripter.editor.pythoneditor.CodeEditor.indent(), and krita.sceditor.indenter.TextIndenter.indent().

Member Data Documentation

autocomplete

krita.sceditor.widget.EditorView.autocomplete

Definition at line 127 of file widget.py.

calltip

krita.sceditor.widget.EditorView.calltip

Definition at line 126 of file widget.py.

disable_shortcuts

krita.sceditor.widget.EditorView.disable_shortcuts

Definition at line 122 of file widget.py.

draw_line

krita.sceditor.widget.EditorView.draw_line

Definition at line 111 of file widget.py.

frame_style

krita.sceditor.widget.EditorView.frame_style

Definition at line 110 of file widget.py.

highlight_brush

krita.sceditor.widget.EditorView.highlight_brush

Definition at line 118 of file widget.py.

highlight_color

krita.sceditor.widget.EditorView.highlight_color

Definition at line 117 of file widget.py.

highlight_line

krita.sceditor.widget.EditorView.highlight_line

Definition at line 116 of file widget.py.

highlighter

krita.sceditor.widget.EditorView.highlighter

Definition at line 107 of file widget.py.

indenter

krita.sceditor.widget.EditorView.indenter

Definition at line 120 of file widget.py.

last_block

krita.sceditor.widget.EditorView.last_block

Definition at line 115 of file widget.py.

last_col

krita.sceditor.widget.EditorView.last_col

Definition at line 194 of file widget.py.

last_row

krita.sceditor.widget.EditorView.last_row

Definition at line 114 of file widget.py.

line

krita.sceditor.widget.EditorView.line

Definition at line 199 of file widget.py.

line_pen

krita.sceditor.widget.EditorView.line_pen

Definition at line 113 of file widget.py.

onCursorPositionChanged

krita.sceditor.widget.EditorView.onCursorPositionChanged

Definition at line 119 of file widget.py.

print_width

krita.sceditor.widget.EditorView.print_width

Definition at line 112 of file widget.py.

prj

krita.sceditor.widget.EditorView.prj

Definition at line 124 of file widget.py.

---

The documentation for this class was generated from the following file:

• plugins/extensions/pykrita/plugin/krita/sceditor/widget.py