Das Handbuch zu Kate - KDE Documentation

Das Handbuch zu Kate
6.4.3.4 Die Programmschnittstelle zum Dokument
Für jedes ausgeführte Skript gibt es eine globale Variable „document”, die das aktuelle Dokument
verweist. Im Folgenden finden Sie eine Liste aller verfügbaren Funktionen für ein Dokument.
String document.fileName();
Gibt den Dateinamen des Dokuments zurück oder eine leere Zeichenkette für nicht gespeicherte
Textpuffer.
String document.url();
Gibt die vollständige URL des Dokuments zurück oder eine leere Zeichenkette für nicht
gespeicherte Textpuffer.
String document.mimeType();
Gibt den Mimetyp des Dokuments zurück oder application/octet-stream, wenn kein
passender Mimetyp gefunden wurde.
String document.encoding();
Gibt die aktuell verwendete Kodierung zum Speichern der Datei zurück.
String document.highlightingMode();
Gibt den globalen Hervorhebungsmodus für das gesamte Dokument zurück.
String document.highlightingModeAt(Cursor pos);
Gibt den Hervorhebungsmodus an der angegebenen Cursor-Position im Dokument zurück.
Array document.embeddedHighlightingModes();
Gibt ein Feld von Hervorhebungsmodi zurück, die in diesem Dokument eingebettet sind..
bool document.isModified();
Gibt true zurück, wenn das Dokument ungespeicherte Änderungen enthält, sonst false.
String document.text();
Gibt den gesamten Inhalt des Dokuments in einer einzigen Zeichenkette zurück. Zeilenumbrüche
werden mit dem zugehörigen Zeichen „\n” markiert.
String document.text(int vonZeile, int vonSpalte, int bisZeile, in
t bisSpalte); String document.text(Cursor von, Cursor bis); String
document.text(Range range);
Gibt den Text im angegebenen Bereich zurück. Es wird empfohlen, die Cursor- und Bereichsbasierte
Version zu benutzen, dadurch ist der Quelltext besser lesbar.
String document.line(int zeile);
Gibt die angegebene Textzeile als Zeichenkette zurück. Die Zeichenkette ist leer, wenn die
angeforderte Zeile außerhalb des Bereichs liegt.
String document.wordAt(int zeile, int spalte); String document.wordAt(Cu
rsor cursor);
Gibt das Wort an der angegebenen Cursor-Position zurück.
Range document.wordRangeAt(int zeile, int spalte); Range
document.wordRangeAt(Cursor cursor);
Gibt den Bereich des Wortes an der angegebenen Cursor-Position zurück. Der zurückgegebene
Bereich ist ungültig (siehe Range.isValid()), wenn die Textposition nach dem Zeilenende
liegt. Befindet sich an der angegebenen Cursor-Position kein Wort, wird ein leere
Bereich zurückgegeben.
Seit: KDE 4.9
73