<chapter id="dev">
<chapterinfo>
<authorgroup>
<author
>&TC.Hollingsworth; &TC.Hollingsworth.mail;</author>
<othercredit role="translator"
><firstname
>Marek</firstname
><surname
>Laane</surname
><affiliation
><address
><email
>bald@smail.ee</email
></address
></affiliation
><contrib
>Tõlge eesti keelde</contrib
></othercredit
> 
</authorgroup>
</chapterinfo>
<title
>&kappname; laiendamine</title>

<sect1 id="dev-intro">
<title
>Sissejuhatus</title>

<para
>Nagu kõik rohkete võimalustega tekstiredaktorid pakub &kate; hulgaliselt võimalusi oma funktsionaalsust laiendada. Võib <link linkend="dev-scripting"
>kirjutada lihtsaid skripte funktsionalsuse laiendamiseks JavaScripti abil</link
>, suurendada redaktorikomponendi funktsionaalsust <link linkend="dev-part"
>redaktorikomponendi pluginatega</link
> või lausa täiendada redaktori enda funktsionaalsust <link linkend="dev-app"
>&kate; rakenduse C++-keeles kirjutatud pluginatega</link
> või <link linkend="dev-pate"
>Pythonis kirjutatud &pate; pluginatega</link
>. Aga lõpuks, kui oled &kate; laiendamise alal midagi ära teinud, kutsume sind <ulink url="http://kate-editor.org/join-us/"
>meiega liituma</ulink
> ja jagama oma täiendusi ka ülejäänud maailmaga!</para>

</sect1>

<sect1 id="dev-scripting">
<title
>Skriptid JavaScriptiga</title>

<para
>Alates &kappname; versioonist 3.4, mis tuleb koos &kde; 4.4-ga, saab &kappname; redaktorikomponenti hõlpsalt laiendada skriptidega. Skriptikeeleks on ECMAScript (rohkem tuntud kui JavaScript). &kappname; toetab kaht laadi skripte: taande- ja käsureaskriptid. </para>

<sect2 id="dev-scripting-indentation">
<title
>Taandeskriptid</title>

<para
>Taandeskriptid või ka treppimisskriptid annavad lähtekoodile selle kirjutamise ajal automaatselt vajaliku taande. Näiteks Enter-klahvi vajutades taandetase tihtipeale suureneb. </para>

<para
>Järgnevates sektsioonides kirjeldame samm-sammult lihtsa taandeskripti loomist. Kõigepealt loo uus <filename
>*.js</filename
>-fail, näiteks  <filename
>javascript.js</filename
> oma kohalikus kodukataloogi kataloogis <filename
>$KDEHOME/share/apps/katepart/script/indentation</filename
>. </para>

<sect3 id="dev-scripting-indentation-header">
<title
>Taandeskripti päis</title>
<para
>Faili <filename
>javascript.js</filename
> on põimitud kommentaarina ning näeb välja selline: <programlisting>
/* kate-script
 * name: JavaScript
 * author: Example Name &lt;example.name@some.address.org&gt;
 * license: BSD
 * revision: 1
 * kate-version: 3.4
 * required-syntax-style: javascript
 * type: indentation
 * required-syntax-style: javascript
 * indent-languages: javascript
 * priority: 0
 * i18n-catalog: mycatalog
 *
 * Rida ilma koolonita ':' peatab päise parsimise. See tähendab, et sa võid siia
 * lisada muud teksti, näiteks üksikasjaliku litsentsi.
 */
</programlisting
> Allpool selgitatakse põhjalikult iga kirjet: <itemizedlist>
<listitem
><para
><literal
>kate-script</literal
> [kohustuslik]: see tekstistring peab esinema <filename
>*.js</filename
>-faili esimesel real, vastasel juhul jätab &kappname; skripti lihtsalt vahele. </para
></listitem>
<listitem
><para
><literal
>name</literal
> [kohustuslik]: see on taandeskripti nimi, nagu seda näeb menüüs <menuchoice
><guimenu
>Tööriistad</guimenu
><guimenuitem
>Treppimine</guimenuitem
></menuchoice
> ja seadistustedialoogis. </para
></listitem>
<listitem
><para
><literal
>author</literal
> [pole kohustuslik]: autori nimi ja kontaktteave. </para
></listitem>
<listitem
><para
><literal
>license</literal
> [pole kohustuslik]: litsents lühidalt, näiteks BSD või LGPLv3. </para
></listitem>
<listitem
><para
><literal
>revision</literal
> [kohustuslik]: skripti versioon. Seda arvu tuleb alati suurendada, kui skripti muudetakse. </para
></listitem>
<listitem
><para
><literal
>kate-version</literal
> [kohustuslik]: &kappname; minimaalne nõutav versioon. </para
></listitem>
<listitem
><para
><literal
>required-syntax-style</literal
> [pole kohustuslik]: komadega eraldatud nõutavate süntaksi esiletõstmise stiilide loend. See on oluline taandeskriptide puhul, mis toetuvad teatavale dokumendis leiduvale esiletõstmise teabele. Kui nõutav süntaksistiil on määratud, saab taandeskripti kasutada ainult siis, kui aktiivne on sobiv esiletõstmise skeem. See takistab <quote
>sobimatut käitumist</quote
>, mis võib tekkida, kui taandeskripti kasutatakse eeldatud esiletõstmise skeemita. Näiteks Ruby taandeskript kasutab sellist võimalust failides <filename
>ruby.js</filename
> ja <filename
>ruby.xml</filename
>. </para
></listitem>
<listitem
><para
><literal
>indent-languages</literal
> [pole kohustuslik]: komadega eraldatud süntaksistiilide loend, mille puhul taandeskript suudab korrektselt treppimist rakendada, näiteks c++, java. </para
></listitem>
<listitem
><para
><literal
>priority</literal
> [pole kohustuslik]: kui teatava esiletõstmisega faili puhul sobib mitu taandeskripti, siis prioriteet määrab, millist neist kasutatakse vaikimisi. </para
></listitem>
<listitem
><para
><literal
>i18n-catalog</literal
> [pole kohustuslik]: täiendav tõlkesõnumite kataloog (<literal
>po</literal
>-fail), mis laaditakse kolmanda poole taandemääratluste tõlgete saamiseks.</para
></listitem>
</itemizedlist>
</para>

<para
>&kappname; loeb kõik paarid <quote
><replaceable
>võti</replaceable
>:<replaceable
>väärtus</replaceable
></quote
>, kuni ei leia enam koolonit. See tähendab, et päis võib sisaldada suvalist teksti, näiteks litsentsi, nagu oli näha näites. </para>

</sect3>

<sect3 id="dev-scripting-indentation-body">
<title
>Taandeskripti lähtekood</title>
<para
>Kui päis on defineeritud, siis siin osas saab aimu, kuidas töötab taandeskript ise. Põhimõtteliselt näeb see välja nii: <programlisting>
// nõutavad katepart js teegid, nt. range.js, kui kasutad Range'i
require ("range.js");
  
triggerCharacters = "{}/:;";
function indent(line, indentWidth, ch)
{
    // called for each newline (ch == '\n') and all characters specified in
    // the global variable triggerCharacters. When calling <menuchoice
><guimenu
>Tools</guimenu
><guimenuitem
>Align</guimenuitem
></menuchoice>
    // the variable ch is empty, i.e. ch == ''.
    //
    // see also: Scripting API
    return -2;
}
</programlisting
> Funktsioonil <function
>indent()</function
> on kolm parameetrit: <itemizedlist
> <listitem
><para
><literal
>line</literal
>: rida, mida asutakse treppima</para
></listitem
> <listitem
><para
><literal
>indentWidth</literal
>: treppimise ehk taande laius tühimärkide arvuna</para
></listitem
> <listitem
><para
><literal
>ch</literal
>: kas reavahetuse sümbol (<literal
>ch == '\n'</literal
>), käivitamissümbol, mille määrab kindlaks <literal
>triggerCharacters</literal
> või ka tühi, kui kasutaja kustub välja toimingu <menuchoice
><guimenu
>Tööriistad</guimenu
><guimenuitem
>Joondamine</guimenuitem
></menuchoice
>.</para
></listitem
> </itemizedlist
> Funktsiooni <function
>indent()</function
> tagastatav väärtus määrab, kuidas rida trepitakse. Kui tagastatud väärtus on lihtsalt täisarv, tõlgendatakse seda järgnevalt: <itemizedlist
> <listitem
><para
>tagastatud väärtus <literal
>-2</literal
>: ei tehta midagi</para
></listitem
> <listitem
><para
>tagastatud väärtus <literal
>-1</literal
>: säilitatakse taandus (otsitakse eelmist mittetühja rida)</para
></listitem
> <listitem
><para
>tagastatud väärtus <literal
> 0</literal
>: arv &gt;= 0 määrab taandesügavuse tühimärkide arvuna</para
></listitem
> </itemizedlist
> Teise võimalusena tagastatakse kahest elemendist koosnev massiiv: <itemizedlist
> <listitem
><para
><literal
>return [ indent, align ];</literal
></para
></listitem
> </itemizedlist
> Sel juhul on esimene element taandesügavus nagu ülal ja samade eriväärtustega. Teine element on aga absoluutväärtus, mis tähistab <quote
>joonduse</quote
> veergu. Kui see väärtus on suurem kui taande väärtus, tähistab nende erinevus tühimärkide arvu, mis tuleb lisada esimese parameetriga määratud taande järele. Muul juhul teist arvu eiratakse. Tabeldusmärkide ja tühimärkide kasutamist treppimisel nimetatakse sageli <quote
>segarežiimiks</quote
>. </para>

<para
>Vaatame järgmist näidet. Eeldame, et treppimiseks kasutatakse tabeldusmärke ning nende laiuseks on määratud 4. &lt;tab&gt; tähistab tabeldusmärki ja '.' tühimärki: <programlisting>
1: &lt;tab&gt;&lt;tab&gt;foobar("hello",
2: &lt;tab&gt;&lt;tab&gt;......."world");
</programlisting
> Teise taandega rea puhul tagastab funktsioon <function
>indent()</function
> [8, 15]. Seepärast lisatakse kaks tabeldusmärki veeru 8 treppimiseks ning 7 tühimärki teise parameetri joondamiseks esimese alla, et see oleks joondatud ka siis, kui faili vaadatakse mõne muu tabeldusmärgi laiusega. </para>

<para
>&kde; vaikimisi paigalduse puhul pakub &kappname; mitut taandeskripti. Vastava JavaScripti lähtekoodi leiab kataloogist <filename
>$KDEDIR/share/apps/katepart/script/indentation</filename
>. </para>

<para
>Taandeskripti arendamiseks tuleb skriptid taaslaadida, et näha, kas muudatused, mida nad teevad, on korrektsed. Terve rakenduse taaskäivitamise asemel lülitu lihtsalt käsureale ja anna käsk <command
>reload-scripts</command
>. </para>

<para
>Kui lood mõne kasuliku skripti, võiksid kaaluda selle annetamist ka &kappname; hüvanguks. Selleks võib ühendust võtta <ulink url="mailto:kwrite-devel@kde.org"
>postiloendis</ulink
>. </para>

</sect3>
</sect2>

<sect2 id="dev-scripting-command-line">
<title
>Käsureaskriptid</title>

<para
>Et kõigi vajadusi on ühekorraga raske rahuldada, toetab &kappname; pisikesi abitööriistu teksti kiireks töötlemiseks <link linkend="advanced-editing-tools-commandline"
>sisseehitatud käsurea abil</link
>. Näiteks käsk <command
>sort</command
> on teostatud skriptina. Järgnevas osas selgitatakse, kuidas luua <filename
>*.js</filename
>-faile &kappname; laiendamiseks mis tahes abiskriptidega. </para>

<para
>Käsureaskriptid paiknevad samas kataloogis taandeskriptidega. Niisiis, esimese sammuna loo uus <filename
>*.js</filename
>-fail nimega <filename
>myutils.js</filename
> kohalikus kodukataloogis <filename
>$KDEHOME/share/apps/katepart/script/commands</filename
>. </para>

<sect3 id="dev-scripting-command-line-header">
<title
>Käsureaskripti päis</title>
<para
>Kõigi käsureaskriptide päis on põimitud kommentaarina ning näeb välja selline: <programlisting>
/* kate-script
 * author: Example Name &lt;example.name@some.address.org&gt;
 * license: BSD
 * revision: 1
 * kate-version: 3.4
 * functions: sort, format-paragraph
 * i18n-catalog: mycatalog
 *
 * Rida ilma koolonita ':' peatab päise parsimise. See tähendab, et sa võid siia
 * lisada muud teksti, näiteks üksikasjaliku litsentsi.
 */
</programlisting
> Allpool selgitatakse põhjalikult iga kirjet: <itemizedlist>
<listitem
><para
><literal
>kate-script</literal
> [kohustuslik]: see tekstistring peab esinema <filename
>*.js</filename
>-faili esimesel real, vastasel juhul jätab &kappname; skripti lihtsalt vahele.</para
></listitem>
<listitem
><para
><literal
>author</literal
> [pole kohustuslik]: autori nimi ja kontaktteave.</para
></listitem>
<listitem
><para
><literal
>license</literal
> [pole kohustuslik]: litsents lühidalt, näiteks BSD või LGPLv3.</para
></listitem>
<listitem
><para
><literal
>revision</literal
> [kohustuslik]: skripti versioon. Seda arvu tuleb alati suurendada, kui skripti muudetakse.</para
></listitem>
<listitem
><para
><literal
>kate-version</literal
> [kohustuslik]: &kappname; minimaalne nõutav versioon.</para
></listitem>
<listitem
><para
><literal
>functions</literal
> [kohustuslik]: komadega eraldatud skripti käskude loend.</para
></listitem>
<listitem
><para
><literal
>i18n-catalog</literal
> [pole kohustuslik]: täiendav tõlkesõnumite kataloog (<literal
>po</literal
>-fail), mis laaditakse kolmanda poole skriptide tõlgete saamiseks.</para
></listitem>
</itemizedlist>
</para>

<para
>&kappname; loeb kõik paarid <quote
><replaceable
>võti</replaceable
>:<replaceable
>väärtus</replaceable
></quote
>, kuni ei leia enam koolonit. See tähendab, et päis võib sisaldada suvalist teksti, näiteks litsentsi, nagu ka eespool olnud näiteks. Võtme functions väärtus on komadega eraldatud käsureakäskude loend. See tähendab, et üks skript võib sisaldada suvalisel hulgal käsureakäske. Kõik funktsioonid on saadaval &kappname; <link linkend="advanced-editing-tools-commandline"
>sisseehitatud käsurea vahendusel</link
>. </para>
</sect3>

<sect3 id="dev-scripting-command-line-body">
<title
>Skripti lähtekood</title>

<para
>Kõik päises osutatud funktsioonid tuleb skriptis teostada. Nii peab näiteks ülaltoodud näites esitatud skript teostama kaks funktsiooni: <command
>sort</command
> ja <command
>format-paragraph</command
>. Kõigil funktsioonidel on järgmine süntaks: <programlisting
>// nõutavad katepart js teegid, nt. range.js, kui kasutad Range'i
require ("range.js");

function &lt;nimi&gt;(arg1, arg2, ...)
{
    // ... implementation, see also: Scripting API
}
</programlisting>
</para>

<para
>Argumendid edastatakse käsureal funktsioonile kujul <parameter
>arg1</parameter
>, <parameter
>arg2</parameter
> jne. Kõigi käskude kohta dokumentatsiooni pakkumiseks teosta lihtsalt funktsioon  '<function
>help</function
>': <programlisting>
function help(cmd)
{
    if (cmd == "sort") {
        return i18n("Sort the selected text.");
    } else if (cmd == "...") {
        // ...
    }
}
</programlisting
> Käsureal <command
>help sort</command
> käivitamine kutsub välja abifunktsiooni argumendiga <parameter
>cmd</parameter
>, mille väärtuseks on määratud antud käsk, s.t <parameter
>cmd == "sort"</parameter
>. &kappname; tagastab seejärel teksti kasutajale nähtava dokumentatsioonina. Kontrolli kindlasti, et ikka <link linkend="dev-scripting-api-i18n"
>tõlgid stringid</link
>. </para>

<sect4 id="dev-scripting-command-line-shortcuts">
<title
>Kiirklahvid</title>
<para
>Kiirklahvide omistamiseks peab skript pakkuma järgmisel moel funktsiooni <literal
>action</literal
>: <programlisting>
function action(cmd)
{
    var a = new Object();
    if (cmd == "sort") {
        a.text = i18n("Sort Selected Text");
        a.icon = "";
        a.category = "";
        a.interactive = false;
        a.shortcut = "";
    } else if (cmd == "moveLinesDown") {
        // same for next action
    }
    return a;
}
</programlisting
> Funktsiooni parameeter <literal
>cmd</literal
> määrab käsu, mille jaoks kiirklahv on mõeldud. Tagastatavas JavaScripti objektis tuleb määrata ära mitu välja: <itemizedlist>
<listitem
><para
><literal
>a.text</literal
> [kohustuslik]: tekst, mida näeb menüüs <menuchoice
><guimenu
>Tööriistad</guimenu
> <guisubmenu
>Skriptid</guisubmenu
></menuchoice
>. Kontrolli, et kasutaksid tõlgete jaoks <literal
>i18n</literal
>.</para
></listitem>
<listitem
><para
><literal
>a.icon</literal
> [pole kohustuslik]: ikoon, mida näeb menüüs teksti kõrval. Siin võib kasutada kõiki &kde; ikooninimesid.</para
></listitem>
<listitem
><para
><literal
>a.category</literal
> [pole kohustuslik]: kategooria määramisel näeb skripti alammenüüs. Kontrolli, et kasutaksid tõlgete jaoks <literal
>i18n</literal
>.</para
></listitem>
<listitem
><para
><literal
>a.interactive</literal
>: kui skript vajab kasutajapoolset sisendit, tuleb selle väärtuseks määrata <literal
>true</literal
>.</para
></listitem>
<listitem
><para
><literal
>a.shortcut</literal
> [pole kohustuslik]: siin määratud kiirklahv on vaikimisi kiirklahv. Näide: Ctrl+Alt+t. Täpsemalt kõneldakse sellest <ulink url="http://qt-project.org/doc/qt-4.8/qt.html#Key-enum"
>Qt dokumentatsioonis</ulink
>.</para
></listitem>
</itemizedlist>
</para>


<para
>Käsureaskripti arendamiseks tuleb skriptid taaslaadida, et näha, kas muudatused, mida nad teevad, on korrektsed. Terve rakenduse taaskäivitamise asemel lülitu lihtsalt käsureale ja anna käsk <command
>reload-scripts</command
>. </para>

<para
>Kui lood mõne kasuliku skripti, võiksid kaaluda selle annetamist ka &kappname; hüvanguks. Selleks võib ühendust võtta <ulink url="mailto:kwrite-devel@kde.org"
>postiloendis</ulink
>. </para>

</sect4>
</sect3>
</sect2>

<sect2 id="dev-scripting-api">
<title
>Skriptimise API</title>

<para
>Siinne skriptimise API on saadaval kõigis skriptides, s.t nii taande- kui ka käsureaskriptides. Klasse <classname
>Cursor</classname
> ja <classname
>Range</classname
> pakuvad teegifailid kataloogis <filename
>$KDEDIR/share/apps/katepart/libraries</filename
>. Kui soovid neid oma skriptis kasutada, mis on nõutav mõningate klasside <classname
>Document</classname
> või <classname
>View</classname
> funktsioonide kasutamiseks, kaasa palun vajalik teek järgmiselt: <programlisting
>// nõutavad katepart js teegid, nt. range.js , kui kasutad Range'i
require ("range.js");
</programlisting>
</para>

<para
>Standardse skriptimise API laiendamiseks oma funktsioonide ja prototüüpidega loo lihtsalt uus fail &kde; kohalikus seadistuste kataloogis <filename
>$KDEHOME/share/apps/katepart/libraries</filename
> ja kaasa see oma skripti järgmiselt: <programlisting
>require ("myscriptnamehere.js");
</programlisting>

</para>

<para
>Olemasolevate prototüüpide, näiteks <classname
>Cursor</classname
> või <classname
>Range</classname
>, laiendamiseks <emphasis
>ei ole</emphasis
> soovitatav muuta globaalseid <filename
>*.js</filename
>-faile. Selle asemel muuda prototüüpi <classname
>Cursor</classname
> JavaScriptis pärast seda, kui <filename
>cursor.js</filename
> on <literal
>require</literal
> abil skripti kaasatud. </para>

<sect3 id="dev-scripting-api-prototypes">
<title
>Kursorid ja vahemikud</title>

<para
>Kuna &kappname; on tekstiredaktor, siis on kogu skriptimise API aluseks, nii palju kui võimalik, kursorid ja vahemikud. Kursor kujutab endast lihtsat <literal
>(rida,veerg)</literal
> määratlust, mis näitab ära teksti asukoha dokumendis. Vahemik aga paneb paika tekstivahemiku kursori algasukohast selle lõppasukohani. API seletatakse üksikasjalikult lahti järgmistes lõikudes. </para>

<sect4 id="dev-scripting-api-cursors">
<title
>Kursori prototüüp</title>

<variablelist
><varlistentry>
<term
><synopsis
>Cursor();
</synopsis
></term>
<listitem
><para
>Konstruktor. Tagastab kursori asukohas <literal
>(0, 0)</literal
>.</para>
<para
>Näide: <function
>var cursor = new Cursor();</function
> </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Cursor(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Konstruktor. Tagastab kursori asukohas (rida, veerg). </para>
<para
>Näide: <function
>var cursor = new Cursor(3, 42);</function
> </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Cursor(<parameter
>Cursor <replaceable
>other</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Koopia konstruktor. Tagastab kursori koopia <replaceable
>other</replaceable
>. </para>
<para
>Näide: <function
>var copy = new Cursor(other);</function
> </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Cursor Cursor.clone();
</synopsis
></term>
<listitem
><para
>Tagastab kursori klooni.</para>
<para
>Näide: <function
>var clone = cursor.clone();</function
> </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Cursor.setPosition(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Määrab kursori asukoha <replaceable
>rea</replaceable
> ja <replaceable
>veeruga</replaceable
>.</para>
<para
>Alates: &kde; 4.11 </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool Cursor.isValid();
</synopsis
></term>
<listitem
><para
>Kontrollib, kas kursor on korrektne. Kursor ei ole korrektne, kui rida ja/või veeru väärtuseks on määratud <literal
>-1</literal
>. </para>
<para
>Näide: <function
>var valid = cursor.isValid();</function
> </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Cursor Cursor.invalid();
</synopsis
></term>
<listitem
><para
>Tagastab uue ebakorrektse kursori asukohas <literal
>(-1, -1)</literal
>. </para>
<para
>Näide: <function
>var invalidCursor = cursor.invalid();</function
> </para
></listitem>
</varlistentry>

<varlistentry>
<term
><synopsis
>int Cursor.compareTo(<parameter
>Cursor <replaceable
>other</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Võrdleb antud kursorit kursoriga <replaceable
>other</replaceable
>. Tagastab <itemizedlist>
<listitem
><para
><literal
>-1</literal
>, kui antud kursor paikneb enne kursorit <replaceable
>other</replaceable
>,</para
></listitem>
<listitem
><para
><literal
>0</literal
>, kui mõlemad kursorid on võrdsed,</para
></listitem>
<listitem
><para
><literal
>-+1</literal
>, kui antud kursor paikneb pärast kursorit <replaceable
>other</replaceable
>.</para
></listitem>
</itemizedlist>
</para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool Cursor.equals(<parameter
>Cursor <replaceable
>other</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui antud kursor ja kursor <replaceable
>other</replaceable
> on võrdsed, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String Cursor.toString();
</synopsis
></term>
<listitem
><para
>Tagastab kursori stringina kujul <quote
><literal
>Cursor(rida, veerg)</literal
></quote
>. </para
></listitem>
</varlistentry
></variablelist>

</sect4>


<sect4 id="dev-scripting-api-ranges">
<title
>Vahemiku prototüüp</title>

<variablelist
><varlistentry>
<term
><synopsis
>Range();
</synopsis
></term>
<listitem
><para
>Konstruktor <literal
>new Range()</literal
> väljakutsumine tagastab vahemiku (0, 0) - (0, 0). </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Range(<parameter
>Cursor <replaceable
>algus</replaceable
></parameter
>, <parameter
>Cursor <replaceable
>lõpp</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Konstruktor <literal
>new Range(<replaceable
>algus</replaceable
>, <replaceable
>lõpp</replaceable
>)</literal
> väljakutsumine tagastab vahemiku (<replaceable
>algus</replaceable
>, <replaceable
>lõpp</replaceable
>). </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Range(<parameter
>int <replaceable
>algusRida</replaceable
></parameter
>, <parameter
>int <replaceable
>algusVeerg</replaceable
></parameter
>, <parameter
>int <replaceable
>lõppRida</replaceable
></parameter
>, <parameter
>int <replaceable
>lõppVeerg</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Konstruktor. <literal
>new Range(<replaceable
>algusRida</replaceable
>, <replaceable
>algusVeerg</replaceable
>, <replaceable
>lõppRida</replaceable
>, <replaceable
>lõppVeerg</replaceable
>)</literal
> tagastab vahemiku alates (<replaceable
>algusRida</replaceable
>, <replaceable
>algusVeerg</replaceable
>) kuni (<replaceable
>lõppRida</replaceable
>, <replaceable
>lõppVeerg</replaceable
>). </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Range(<parameter
>Range <replaceable
>other</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Koopia konstruktor. Tagastab vahemiku koopia <replaceable
>other</replaceable
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Range Range.clone();
</synopsis
></term>
<listitem
><para
>Tagastab vahemiku klooni. </para>
<para
>Näide: <function
>var clone = range.clone();</function
> </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool Range.isEmpty();
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui nii algus- kui ka lõppkursor on võrdsed. </para>
<para
>Näide: <function
>var empty = range.isEmpty();</function
> </para>
<para
>Alates: &kde; 4.11 </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool Range.isValid();
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui nii algus- kui ka lõppkursor on korrektsed, vastasel juhul <literal
>false</literal
>. </para>
<para
>Näide: <function
>var valid = range.isValid();</function
> </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Range Range.invalid();
</synopsis
></term>
<listitem
><para
>Tagastab vahemiku alates (-1, -1) kuni (-1, -1). </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool Range.contains(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui antud vahemik sisaldab kursori asukohta, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool Range.contains(<parameter
>Range <replaceable
>other</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui antud vahemik sisaldab vahemikku <replaceable
>other</replaceable
>, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool Range.containsColumn(<parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui <replaceable
>veerg</replaceable
> paikneb vahemikus <literal
>[start.column, end.column)</literal
>, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool Range.containsLine(<parameter
>int <replaceable
>rida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui <replaceable
>rida</replaceable
> paikneb vahemikus <literal
>[start.line, end.line)</literal
>, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool Range.overlaps(<parameter
>Range <replaceable
>other</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui antud vahemikul ja vahemikul <replaceable
>other</replaceable
> on ühine piirkond, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool Range.overlapsLine(<parameter
>int <replaceable
>rida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui <replaceable
>rida</replaceable
> paikneb vahemikus <literal
>[start.line, end.line]</literal
>, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool Range.overlapsColumn(<parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui <replaceable
>veerg</replaceable
> paikneb vahemikus <literal
>[start.column, end.column]</literal
>, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool Range.onSingleLine();
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui vahemik algab ja lõpeb samal real, s.t. kui <replaceable
>Range.start.line == Range.end.line</replaceable
> </para>
<para
>Alates: &kde; 4.9 </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool Range.equals(<parameter
>Range <replaceable
>other</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui antud vahemik ja vahemik <replaceable
>other</replaceable
> on võrdsed, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String Range.toString();
</synopsis
></term>
<listitem
><para
>Tagastab vahemiku stringina kujul <quote
><literal
>Range(Cursor(rida, veerg), Cursor(rida, veerg))</literal
></quote
>. </para
></listitem>
</varlistentry
></variablelist>

</sect4>
</sect3>

<sect3 id="dev-scripting-api-global">
<title
>Globaalsed funktsioonid</title>
<para
>See sektsioon loetleb kõik globaalsed funktsioonid.</para>


<sect4 id="dev-scripting-api-includes">
<title
>Failide lugemine ja kaasamine</title>

<variablelist
><varlistentry>
<term
><synopsis
>String read(<parameter
>String <replaceable
>fail</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>See otsib määratud <replaceable
>faili</replaceable
>, mis on antud suhtelisena kataloogi <literal
>katepart/script/files</literal
> suhtes, ning tagastab selle sisu stringina. </para
></listitem>
</varlistentry
></variablelist>

<variablelist
><varlistentry>
<term
><synopsis
>void require(<parameter
>String <replaceable
>fail</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>See otsib määratud <replaceable
>faili</replaceable
>, mis on antud suhtelisena kataloogi <literal
>katepart/script/files</literal
>, ja hindab seda. <literal
>require</literal
> on sisemiselt kaitstud sama <replaceable
>faili</replaceable
> mitmekordse kaasamise vastu. </para>
<para
>Alates: &kde; 4.10 </para>
</listitem>
</varlistentry
></variablelist>

</sect4>

<sect4 id="dev-scripting-api-debug">
<title
>Silumine</title>

<variablelist
><varlistentry>
<term
><synopsis
>void debug(<parameter
>String <replaceable
>tekst</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Näitab <replaceable
>tekst</replaceable
>i standardväljundis <literal
>stdout</literal
> samas konsoolis, kus rakendus käivitati. </para
></listitem>
</varlistentry
></variablelist>

</sect4>

<sect4 id="dev-scripting-api-i18n">
<title
>Tõlkimine</title>

<para
>Täieliku lokaliseerimise pakkumiseks on olemas mitu funktsiooni, mille abil tõlkida skriptide stringe, nimelt <literal
>i18n</literal
>, <literal
>i18nc</literal
>, <literal
>i18np</literal
> ja <literal
>i18ncp</literal
>. Need funktsioonid toimivad täpselt nii nagu <ulink url="http://techbase.kde.org/Development/Tutorials/Localization/i18n"
> &kde; tõlkimisfunktsioonid</ulink
>. </para>

<para
>Tõlkimisfunktsioonid tõlgivad tõlkimiseks määratud stringid &kde; tõlkesüsteemi kaudu rakenduse kasutatavasse keelde. Ametlikus &kappname; lähtekoodis arendatud skriptide stringid hangitakse ja tõlgitakse automaatselt. See tähendab, et &kappname; arendajana ei ole vaja pead vaevata tõlkesõnumite saatusega. Kuid kolmanda poole skriptide puhul, mida arendatakse väljaspool &kde;-d, tuleb sõnumid ise kätte saada ja tõlkida lasta. Skriptiga tuleb kaasa panna tõlkekataloog, mis sisaldab kõiki tõlgitavaid stringe. Lisaks peab skripti päises konkreetselt ära määrama laaditava kataloogi, milleks on mõeldud <literal
>i18n-catalog</literal
>. </para>

<variablelist
><varlistentry>
<term
><synopsis
>void i18n(<parameter
>String <replaceable
>tekst</replaceable
></parameter
>, <replaceable
>arg1</replaceable
>, ...);
</synopsis
></term>
<listitem
><para
>Tõlgib <replaceable
>tekst</replaceable
>i rakenduse kasutatavasse keelde. Argumendid <replaceable
>arg1</replaceable
>, ... ei ole kohustuslikud ning neid kasutatakse kohatäitjate <literal
>%1</literal
>, <literal
>%2</literal
> jne. asendamiseks.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><synopsis
>void i18nc(<parameter
>String <replaceable
>kontekst</replaceable
></parameter
>, <parameter
>String <replaceable
>tekst</replaceable
></parameter
>, <replaceable
>arg1</replaceable
>, ...);
</synopsis
></term>
<listitem
><para
>Tõlgib <replaceable
>tekst</replaceable
>i rakenduse kasutatavasse keelde. Lisaks näevad tõlkijad stringi <replaceable
>kontekst</replaceable
>, mis aitab neil paremini leida õiget tõlkevastet. Argumendid <replaceable
>arg1</replaceable
>, ... ei ole kohustuslikud ning neid kasutatakse kohatäitjate <literal
>%1</literal
>, <literal
>%2</literal
> jne. asendamiseks.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><synopsis
>void i18np(<parameter
>String <replaceable
>ainsus</replaceable
></parameter
>, <parameter
>String <replaceable
>mitmus</replaceable
></parameter
>, <parameter
>int <replaceable
>arv</replaceable
></parameter
>, <replaceable
>arg1</replaceable
>, ...);
</synopsis
></term>
<listitem
><para
>Tõlgib kas <replaceable
>ainsus</replaceable
>e või <replaceable
>mitmus</replaceable
>e rakenduse kasutatavasse keelde sõltuvalt määratud <replaceable
>arv</replaceable
>ust. Argumendid <replaceable
>arg1</replaceable
>, ... ei ole kohustuslikud ning neid kasutatakse kohatäitjate <literal
>%1</literal
>, <literal
>%2</literal
> jne. asendamiseks.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><synopsis
>void i18ncp(<parameter
>String <replaceable
>kontekst</replaceable
></parameter
>, <parameter
>String <replaceable
>ainsus</replaceable
></parameter
>, <parameter
>String <replaceable
>mitmus</replaceable
></parameter
>, <parameter
>int <replaceable
>arv</replaceable
></parameter
>, <replaceable
>arg1</replaceable
>, ...);
</synopsis
></term>
<listitem
><para
>Tõlgib kas <replaceable
>ainsus</replaceable
>e või <replaceable
>mitmus</replaceable
>e rakenduse kasutatavasse keelde sõltuvalt määratud <replaceable
>arv</replaceable
>ust. Lisaks näevad tõlkijad stringi <replaceable
>kontekst</replaceable
>, mis aitab neil paremini leida õiget tõlkevastet. Argumendid <replaceable
>arg1</replaceable
>, ... ei ole kohustuslikud ning neid kasutatakse kohatäitjate <literal
>%1</literal
>, <literal
>%2</literal
> jne. asendamiseks.</para
></listitem>
</varlistentry
></variablelist>

</sect4>
</sect3>

<sect3 id="dev-scripting-api-view">
<title
>Vaate API</title>
<para
>Skripti käivitamisel on alati olemas globaalne muutuja <quote
><literal
>view</literal
></quote
>, mis tähistab aktiivset redaktorivaadet. Järgnevalt on loetletud saadaolevad vaatefunktsioonid. <variablelist
><varlistentry>
<term
><synopsis
><function
>Cursor view.cursorPosition()</function
>
</synopsis
></term>
<listitem
><para
>Tagastab aktiivse kursori asukoha vaates.</para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>void view.setCursorPosition(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
void view.setCursorPosition(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Määrab aktiivse kursori asukoha kas (rida, veerg) või määratud kursori järgi. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Cursor view.virtualCursorPosition();
</synopsis
></term>
<listitem
><para
>Tagastab virtuaalse kursori asukoha tabeldusmärgis, arvestades tabeldusmärgile taande puhul määratud tühimärkide arvu. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>void view.setVirtualCursorPosition(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
void view.setVirtualCursorPosition(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Määrab aktiivse virtuaalse kursori asukoha kas (rida, veerg) või määratud kursori järgi. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String view.selectedText();
</synopsis
></term>
<listitem
><para
>Tagastab valitud teksti. Kui teksti pole valitud, on tagastatav string tühi. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool view.hasSelection();
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui vaade sisaldab valitud teksti, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Range view.selection();
</synopsis
></term>
<listitem
><para
>Tagastab valitud teksti vahemiku. Tagastatud vahemik on vigane, kui teksti pole valitud. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>void view.setSelection(<parameter
>Range <replaceable
>vahemik</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Määrab valitud teksti valitud vahemikku. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>void view.removeSelectedText();
</synopsis
></term>
<listitem
><para
>Eemaldab valitud teksti. Kui vaates pole valitud teksti, ei tee midagi. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>void view.selectAll();
</synopsis
></term>
<listitem
><para
>Valib kogu dokumendi teksti. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>void view.clearSelection();
</synopsis
></term>
<listitem
><para
>Puhastab tekstivaliku ilma teksti eemaldamata. </para
></listitem>
</varlistentry
></variablelist>
</para>
</sect3>

<sect3 id="dev-scripting-api-document">
<title
>Dokumendi API</title>
<para
>Skripti käivitamisel on alati olemas globaalne muutuja <quote
><literal
>document</literal
></quote
>, mis tähistab aktiivset dokumenti. Järgnevalt on loetletud saadaolevad dokumendifunktsioonid. <variablelist
><varlistentry>
<term
><synopsis
>String document.fileName();
</synopsis
></term>
<listitem
><para
>Tagastab dokumendi failinime või tühja stringi salvestamata tekstipuhvri korral. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.url();
</synopsis
></term>
<listitem
><para
>Tagastab dokumendi täieliku URL-i või tühja stringi salvestamata tekstipuhvri korral. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.mimeType();
</synopsis
></term>
<listitem
><para
>Tagastab dokumendi MIME tüübi või MIME tüübi <literal
>application/octet-stream</literal
>, kui sobivat MIME tüüpi ei leita. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.encoding();
</synopsis
></term>
<listitem
><para
>Tagastab faili salvestamisel kasutatava kodeeringu. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><synopsis
>String document.highlightingMode();
</synopsis
></term>
<listitem
><para
>Tagastab kogu dokumendis kasutatava globaalse esiletõstmise režiimi. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><synopsis
>String document.highlightingModeAt(<parameter
>Cursor <replaceable
>asukoht</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab dokumendi määratud asukohas kasutatava esiletõstmise režiimi. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><synopsis
>Array document.embeddedHighlightingModes();
</synopsis
></term>
<listitem
><para
>Tagastab dokumenti põimitud esiletõstmise režiimide massiivi. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><synopsis
>bool document.isModified();
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui dokument sisaldab salvestamata muudatusi, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.text();
</synopsis
></term>
<listitem
><para
>Tagastab kogu dokumendi sisu üheainsa tekstistringina. Reavahetusi tähistavad reavahetussümbolid <quote
><literal
>\n</literal
></quote
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.text(<parameter
>int <replaceable
>alatesReast</replaceable
></parameter
>, <parameter
>int <replaceable
>alatesVeerust</replaceable
></parameter
>, <parameter
>int <replaceable
>kuniReani</replaceable
></parameter
>, <parameter
>int <replaceable
>kuniVeeruni</replaceable
></parameter
>);
String document.text(<parameter
>Cursor <replaceable
>alates</replaceable
></parameter
>, <parameter
>Cursor <replaceable
>kuni</replaceable
></parameter
>);
String document.text(<parameter
>Range <replaceable
>vahemik</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab teksti määratud vahemikust. Lähtekoodi parema loetavuse huvides on soovitatav kasutada kursorile ja vahemikule tuginevaid versioone. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.line(<parameter
>int <replaceable
>rida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab valitud teksti stringina. String on tühi, kui soovitud rida jääb vahemikust välja. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.wordAt(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
String document.wordAt(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab sõna määratud kursori asukohas. </para
></listitem>
</varlistentry>


<varlistentry>
<term>
<synopsis
>Range document.wordRangeAt(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
Range document.wordRangeAt(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis>
</term>
<listitem
><para
>Tagastab sõnade vahemiku määratud kursori asukohas. Tagastatav vahemik on vigane (vt. Range.isValid()), kui teksti asukoht on pärast rea lõppu. Kui määratud kursori asukohas sõna pole, tagastatakse tühi vahemik. </para>
<para
>Alates: &kde; 4.9 </para>
</listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.charAt(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
String document.charAt(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab sümboli määratud kursori asukohas. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.firstChar(<parameter
>int <replaceable
>rida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab määratud <replaceable
>rea</replaceable
>  </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.lastChar(<parameter
>int <replaceable
>rida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab määratud <replaceable
>rea</replaceable
> esimese märgi, mis ei ole tühimärk. Kui rida on tühi või sisaldab ainult tühimärke, on tagastatud string tühi. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.isSpace(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
bool document.isSpace(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui määratud kursori asukohas paiknev märk on tühimärk, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.matchesAt(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>, <parameter
>String <replaceable
>tekst</replaceable
></parameter
>);
bool document.matchesAt(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>, <parameter
>String <replaceable
>tekst</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui määratud <replaceable
>tekst</replaceable
> sobib tekstiga määratud kursori asukohas, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.startsWith(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>String <replaceable
>tekst</replaceable
></parameter
>, <parameter
>bool <replaceable
>skipWhiteSpaces</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui rida algab <replaceable
>tekstiga</replaceable
>, vastasel juhul <literal
>false</literal
>. Argument <replaceable
>skipWhiteSpaces</replaceable
> määrab, kas alustavaid tühimärke eiratakse või mitte. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.endsWith(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>String <replaceable
>tekst</replaceable
></parameter
>, <parameter
>bool <replaceable
>skipWhiteSpaces</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui rida lõpeb <replaceable
>tekstiga</replaceable
>, vastasel juhul <literal
>false</literal
>. Argument <replaceable
>skipWhiteSpaces</replaceable
> määrab, kas lõpetavaid tühimärke eiratakse või mitte. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.setText(<parameter
>String <replaceable
>tekst</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Määrab kogu dokumendi teksti. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.clear();
</synopsis
></term>
<listitem
><para
>Eemaldab kogu dokumendi teksti. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.truncate(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
bool document.truncate(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Kärbib määratud rea määratud veeruga või kursori asukohaga. Tagastab <literal
>true</literal
> õnnestumise korral või <literal
>false</literal
>, kui määratud rida ei kuulu dokumendi vahemikku. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.insertText(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>, <parameter
>String <replaceable
>tekst</replaceable
></parameter
>);
bool document.insertText(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>, <parameter
>String <replaceable
>tekst</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Lisab <replaceable
>teksti</replaceable
> määratud kursori asukohta. Tagastab <literal
>true</literal
> õnnestumise korral või <literal
>false</literal
>, kui dokument on kirjutuskaitstud. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.removeText(<parameter
>int <replaceable
>alatesReast</replaceable
></parameter
>, <parameter
>int <replaceable
>alatesVeerust</replaceable
></parameter
>, <parameter
>int <replaceable
>kuniReani</replaceable
></parameter
>, <parameter
>int <replaceable
>kuniVeeruni</replaceable
></parameter
>);
bool document.removeText(<parameter
>Cursor <replaceable
>alates</replaceable
></parameter
>, <parameter
>Cursor <replaceable
>kuni</replaceable
></parameter
>);
bool document.removeText(<parameter
>Range <replaceable
>vahemik</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Eemaldab teksti määratud vahemikus. Tagastab <literal
>true</literal
> õnnestumise korral või <literal
>false</literal
>, kui dokument on kirjutuskaitstud. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.insertLine(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>String <replaceable
>tekst</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Lisab teksti määratud reale. Tagastab <literal
>true</literal
> õnnestumise korral või <literal
>false</literal
>, kui dokument on kirjutuskaitstud või rida ei paikne dokumendi vahemikus. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.removeLine(<parameter
>int <replaceable
>rida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Eemaldab määratud tekstirea. Tagastab <literal
>true</literal
> õnnestumise korral või <literal
>false</literal
>, kui dokument on kirjutuskaitstud või rida ei paikne dokumendi vahemikus. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.wrapLine(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
bool document.wrapLine(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Murrab rida määratud kursori asukohas. Tagastab <literal
>true</literal
> õnnestumise korral või <literal
>false</literal
>, kui nt. rida &lt; 0. </para>
<para
>Alates: &kde; 4.9 </para>
</listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>void document.joinLines(<parameter
>int <replaceable
>algusRida</replaceable
></parameter
>, <parameter
>int <replaceable
>lõppRida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Ühendab read alates <replaceable
>algusRida</replaceable
> to <replaceable
>lõppRida</replaceable
>. Kaht järjestikust tekstirida eraldab alati üks tühik. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.lines();
</synopsis
></term>
<listitem
><para
>Tagastab dokumendi ridade arvu. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.length();
</synopsis
></term>
<listitem
><para
>Tagastab dokumendi sümbolite arvu. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.lineLength(<parameter
>int <replaceable
>rida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <replaceable
>rea</replaceable
> pikkuse. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>void document.editBegin();
</synopsis
></term>
<listitem
><para
>Alustab redigeerimisrühma tagasivõtmiste või uuestitegemiste rühmitamiseks. Kontrolli, et <function
>editEnd()</function
> oleks alati sama palju välja kutsutud kui <function
>editBegin()</function
>. <function
>editBegin()</function
> väljakutse kasutab seesmiselt referentsarvestit, s.t selle väljakutse korral on võimalik pesastamine. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>void document.editEnd();
</synopsis
></term>
<listitem
><para
>Lõpetab redigeerimisrühma. Viimane <function
>editEnd()</function
> väljakutse (s.t see, mis vastab esimesele <function
>editBegin()</function
> väljakutsele) lõpetab redigeerimisastme. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.firstColumn(<parameter
>int <replaceable
>rida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab määratud <replaceable
>rea</replaceable
> esimese mittetühimärgiga veeru. Kui real on ainult tühimärgid, tagastatakse <literal
>-1</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.lastColumn(<parameter
>int <replaceable
>rida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab määratud <replaceable
>rea</replaceable
> viimase mittetühimärgiga veeru. Kui real on ainult tühimärgid, tagastatakse <literal
>-1</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.prevNonSpaceColumn(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
int document.prevNonSpaceColumn(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab mittetühimärkidega veeru alates aktiivsest kursori asukohast tagasisuunas otsides. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.nextNonSpaceColumn(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
int document.nextNonSpaceColumn(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab mittetühimärkidega veeru alates aktiivsest kursori asukohast edasisuunas otsides. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.prevNonEmptyLine(<parameter
>int <replaceable
>rida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab järgmise mittetühimärkidega mittetühja rea, otsides tagasisuunas. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.nextNonEmptyLine(<parameter
>int <replaceable
>rida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab järgmise mittetühimärkidega mittetühja rea, otsides edasisuunas. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.isInWord(<parameter
>String <replaceable
>sümbol</replaceable
></parameter
>, <parameter
>int <replaceable
>atribuut</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui määratud <replaceable
>sümbol</replaceable
> määratud <replaceable
>atribuudiga</replaceable
> võib olla sõna osa, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.canBreakAt(<parameter
>String <replaceable
>sümbol</replaceable
></parameter
>, <parameter
>int <replaceable
>atribuut</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui määratud <replaceable
>sümbol</replaceable
> määratud <replaceable
>atribuudiga</replaceable
> sobib reamurdmiseks, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.canComment(<parameter
>int <replaceable
>algusAtribuut</replaceable
></parameter
>, <parameter
>int <replaceable
>lõppAtribuut</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui määratud atribuudiga algav ja lõppev vahemik sobib kommenteerimiseks, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.commentMarker(<parameter
>int <replaceable
>atribuut</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab kommentaaritähise määratud <replaceable
>atribuudiga</replaceable
> üherealise kommentaari puhul. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.commentStart(<parameter
>int <replaceable
>atribuut</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab kommentaaritähise määratud <replaceable
>atribuudiga</replaceable
> mitmerealise kommentaari alguse puhul. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.commentEnd(<parameter
>int <replaceable
>atribuut</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab kommentaaritähise määratud <replaceable
>atribuudiga</replaceable
> mitmerealise kommentaari lõpu puhul. </para
></listitem>
</varlistentry>



<varlistentry>
<term
><synopsis
>int document.attribute(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
int document.attribute(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab atribuudi määratud kursori asukohas. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.isAttribute(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>, <parameter
>int <replaceable
>atribuut</replaceable
></parameter
>);
bool document.isAttribute(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>, <parameter
>int <replaceable
>atribuut</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui kursori asukohas paiknev atribuut on võrdne <replaceable
>atribuudiga</replaceable
>, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.attributeName(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
String document.attributeName(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab atribuudi nime inimloetava tekstina. See võrdub nimega <literal
>itemData</literal
> süntaksi esiletõstmise failides. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.isAttributeName(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>, <parameter
>String <replaceable
>nimi</replaceable
></parameter
>);
bool document.isAttributeName(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>, <parameter
>String <replaceable
>nimi</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui kursori asukohas paikneva atribuudi nimi sobib määratud <replaceable
>nimega</replaceable
>, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.variable(<parameter
>String <replaceable
>võti</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab soovitud dokumendi muutuja <replaceable
>võti</replaceable
> väärtuse. Kui dokumendi muutujat ei ole olemas, tagastatakse tühi string. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>String document.setVariable(<parameter
>String <replaceable
>võti</replaceable
></parameter
>, <parameter
>String <replaceable
>väärtus</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Soovitud dokumendi muutuja <replaceable
>võtme</replaceable
> väärtuse määramine. Tagastab määratud muutuja väärtuse. </para>
<para
>Vaata ka: <link linkend="config-variables"
>Kate dokumendi muutujad</link
> </para>
<para
>Alates: &kde; 4.8 </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.firstVirtualColumn(<parameter
>int <replaceable
>rida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab määratud rea esimese mittetühimärgi virtuaalse veeru või <literal
>-1</literal
>, kui rida on tühi või sisaldab ainult tühimärke. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.lastVirtualColumn(<parameter
>int <replaceable
>rida</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab määratud rea viimase mittetühimärgi virtuaalse veeru või <literal
>-1</literal
>, kui rida on tühi või sisaldab ainult tühimärke. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.toVirtualColumn(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
int document.toVirtualColumn(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
Cursor document.toVirtualCursor(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Teisendab määratud <quote
>reaalse</quote
> kursori asukoha virtuaalseks kursori asukohaks, tagastades täisarvu või objekti Cursor. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.fromVirtualColumn(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>virtuaalneVeerg</replaceable
></parameter
>);
int document.fromVirtualColumn(<parameter
>Cursor <replaceable
>virtuaalneKursor</replaceable
></parameter
>);
Cursor document.fromVirtualCursor(<parameter
>Cursor <replaceable
>virtuaalneKursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Teisendab määratud virtuaalse kursori asukoha <quote
>reaalseks</quote
> kursori asukohaks. tagastades täisarvu või objekti Cursor. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Cursor document.anchor(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>, <parameter
>Char <replaceable
>sümbol</replaceable
></parameter
>);
Cursor document.anchor(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>, <parameter
>Char <replaceable
>sümbol</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Otsib määratud sümbolit tagasisuunas alates määratud kursorist. Kui näiteks '(' edastatakse sümbolina, tagastab see funktsioon avava '(' asukoha. Referentsarvestust, s.t teisi '(...)', eiratakse. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>Cursor document.rfind(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>, <parameter
>String <replaceable
>tekst</replaceable
></parameter
>, <parameter
>int <replaceable
>atribuut</replaceable
> = -1</parameter
>);
Cursor document.rfind(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>, <parameter
>String <replaceable
>tekst</replaceable
></parameter
>, <parameter
>int <replaceable
>atribuut</replaceable
> = -1</parameter
>);
</synopsis
></term>
<listitem
><para
>Otsib tagasisuunas määratud teksti sobiva <replaceable
>atribuudiga</replaceable
>. Argumenti <replaceable
>atribuut</replaceable
> eiratakse, kui selle väärtuseks on määratud <literal
>-1</literal
>. Tagastatud kursor on vigane, kui teksti ei leita. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>int document.defStyleNum(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
int document.defStyleNum(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab määratud kursori asukohas kasutatud vaikimisi stiili. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.isCode(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
bool document.isCode(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui määratud kursori asukohas paiknev atribuut ei ole võrdne kõigi järgnevate stiilidega: <literal
>dsComment</literal
>, <literal
>dsString</literal
>, <literal
>dsRegionMarker</literal
>, <literal
>dsChar</literal
>, <literal
>dsOthers</literal
>. </para
></listitem>
</varlistentry>



<varlistentry>
<term
><synopsis
>bool document.isComment(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
bool document.isComment(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui kursori asukohas paikneva sümboli atribuut on <literal
>dsComment</literal
>, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.isString(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
bool document.isString(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui kursori asukohas paikneva sümboli atribuut on <literal
>dsString</literal
>, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.isRegionMarker(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
bool document.isRegionMarker(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui kursori asukohas paikneva sümboli atribuut on <literal
>dsRegionMarker</literal
>, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.isChar(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
bool document.isChar(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui kursori asukohas paikneva sümboli atribuut on <literal
>dsChar</literal
>, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry>


<varlistentry>
<term
><synopsis
>bool document.isOthers(<parameter
>int <replaceable
>rida</replaceable
></parameter
>, <parameter
>int <replaceable
>veerg</replaceable
></parameter
>);
bool document.isOthers(<parameter
>Cursor <replaceable
>kursor</replaceable
></parameter
>);
</synopsis
></term>
<listitem
><para
>Tagastab <literal
>true</literal
>, kui kursori asukohas paikneva sümboli atribuut on <literal
>dsOthers</literal
>, vastasel juhul <literal
>false</literal
>. </para
></listitem>
</varlistentry
></variablelist>
</para>

</sect3>
</sect2>

</sect1>

<sect1 id="dev-part">
<title
>Redaktorikomponendi laiendused</title>

<para
><link linkend="editor-component-plugins"
>Redaktorikomponendi laiendused</link
> laiendavad KateParti ehk täiustatud tekstiredaktori komponenti, mida kasutavad paljud &kde; rakendused, näiteks &kate;, &kwrite;, Kile ja KDevelop. Redaktorikimponendi plugina loomine võimaldab laiendada redaktori funktsionaalsust kõigis mainitud ja mainimata rakendustes.</para>

<para
>Alustamiseks uuri <ulink url="http://techbase.kde.org/Development/Tutorials/Kate/KTextEditor_Plugins"
>KTextEditori plugina õppematerjali &kde; TechBase'is</ulink
>. Veel põhjalikumaks tutvumiseks uuri ka <ulink url="http://techbase.kde.org/Development/Tutorials/Kate/KTextEditor_Plugins_Advanced"
>põhjalikumat õppematerjali samuti TechBase'is</ulink
>.</para>

<para
>Soovi ja vajaduse korral leiab <ulink url="http://api.kde.org/4.10-api/kdelibs-apidocs/interfaces/ktexteditor/html/"
>täieliku API dokumentatsiooni &kde; API baasis</ulink
>.</para>

</sect1>

<sect1 id="dev-app">
<title
>&kate; (C++) rakenduse pluginad</title>

<para
><link linkend="kate-application-plugins"
>Kate rakenduse pluginad</link
> laiendavad &kate; redaktori enda funktsionaalsust kõikvõimalikul moel, kasutades sama programmeerimiskeelt, milles on kirjutatud ka &kate; - C++.</para>

<para
>Alustamiseks uuri <ulink url="http://kate-editor.org/2004/01/06/writing-a-kate-plugin/"
>&kate; plugina kirjutamise õppematerjali &kate; veebileheküljel</ulink
>. Lisaks on olemas ka <ulink url="http://quickgit.kde.org/?p=kate.git&amp;a=tree&amp;f=addons%2Fkate%2Fhelloworld"
>klassikaline <quote
>Tere, maailm!</quote
> näiteplugin, mis on kaasas juba &kate; lähtekoodiga</ulink
>.</para>

</sect1>

<sect1 id="dev-pate">
<title
>&pate; Pythoni pluginad</title>

<para
><link linkend="pate"
>&pate; pluginad</link
> võimaldavad samuti laiendada &kate; funktsionaalsust kõikvõimalikul moel, kasutades selleks Pythoni programmeerimiskeelt.</para>

<para
>Alustamiseks uuri <ulink url="http://kate-editor.org/2012/07/01/python-plugin-developer-guide-part-1/"
>Pythoni plugina arendaja juhiseid &kate; veebileheküljel</ulink
>.</para>

<para
>Samuti võib tutvuda API põhjaliku ülevaatega <link linkend="pate-config"
>&pate; seadistamise</link
> ekraanil.</para>

</sect1>

</chapter>
