diff --git a/doc/katepart/development.docbook b/doc/katepart/development.docbook --- a/doc/katepart/development.docbook +++ b/doc/katepart/development.docbook @@ -1850,7 +1850,9 @@ view representing the current active editor view. The following is a list of all available View functions. - + + + Cursor view.cursorPosition() @@ -1959,7 +1961,26 @@ Clears the text selection without removing the text. - + + + + +object view.executeCommand(String command, + String args, + Range range); + + +Executes the command line command command +with the optional arguments args and the optional range. +The returned object has a boolean property object.ok +that indicates whether execution of the command was successful. +In case of an error, the string object.status contains an error message. + +Since: &kde-frameworks; 5.50 + + + + @@ -1970,7 +1991,9 @@ document representing the current active document. The following is a list of all available Document functions. - + + + String document.fileName(); @@ -2811,9 +2834,58 @@ Returns true, if the attribute of the character at the cursor position is dsOthers, otherwise false. - + + + + + + + + +The Editor API + +In addition to the document and view API, there is a general editor API that +provides functions for general editor scripting functionality. + + + + + +String editor.clipboardText(); + + +Returns the text that currently is in the global clipboard. + +Since: &kde-frameworks; 5.50 + + + + + +String editor.clipboardHistory(); + + +The editor holds a clipboard history that contains up to 10 clipboard entries. +This function returns all entries that currently are in the clipboard history. + +Since: &kde-frameworks; 5.50 + + + + + +void editor.setClipboardText(String text); + + +Set the contents of the clipboard to text. +The text will be added to the clipboard history. +Since: &kde-frameworks; 5.50 + + + +