diff options
Diffstat (limited to 'tde-i18n-et/docs/tdevelop/kdearch/index.docbook')
| -rw-r--r-- | tde-i18n-et/docs/tdevelop/kdearch/index.docbook | 3680 |
1 files changed, 3680 insertions, 0 deletions
diff --git a/tde-i18n-et/docs/tdevelop/kdearch/index.docbook b/tde-i18n-et/docs/tdevelop/kdearch/index.docbook new file mode 100644 index 00000000000..76957907fb7 --- /dev/null +++ b/tde-i18n-et/docs/tdevelop/kdearch/index.docbook @@ -0,0 +1,3680 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY % addindex "INCLUDE"> + <!ENTITY % Estonian "INCLUDE" +> <!-- change language only here --> +]> + +<book lang="&language;"> + +<bookinfo> +<title +>KDE arhitektuuri ülevaade</title> + +<date +></date> +<releaseinfo +></releaseinfo> + +<authorgroup> +<author +><firstname +>Bernd</firstname +> <surname +>Gehrmann</surname +> <affiliation +><address +><email +>bernd@tdevelop.org</email +></address +></affiliation> +</author> +</authorgroup> + +<copyright> +<year +>2001</year> +<year +>2002</year> +<holder +>Bernd Gehrmann</holder> +</copyright> + +<legalnotice +>&FDLNotice;</legalnotice> + +<abstract> +<para +>Käesolev käsiraamat annab ülevaate KDE arendusplatvormist</para> +</abstract> + +<keywordset> +<keyword +>KDE</keyword> +<keyword +>arhitektuur</keyword> +<keyword +>arendus</keyword> +<keyword +>programmeerimine</keyword> +</keywordset> + +</bookinfo> + +<chapter id="structure"> +<title +>Teegistruktuur</title> + +<simplesect id="structure-byname"> +<title +>Teegid nimepidi</title> + +<variablelist> + +<varlistentry> +<term +><ulink url="kdeapi:tdecore/index.html" +>tdecore</ulink +></term> +<listitem +><para +>Teek tdecore on iga KDE rakenduse põhiraamistik. See pakub ligipääsu seadistamissüsteemile, käsurea võimalustele, ikoonide laadimisele ja nende käsitlemisele, mõningaid spetsiaalseid protsessidevahelise kommunikatsiooni võimalusi, failikäsitlust ning rea muid vahendeid. </para +></listitem> +</varlistentry> + +<varlistentry> +<term +><ulink url="kdeapi:tdeui/index.html" +>tdeui</ulink +></term> +<listitem +><para +>Teek <literal +>tdeui</literal +> pakub hulganisti vidinaid ja standarddialooge, mis Qt-l puuduvad või millel on rohkem võimalusi kui nende Qt analoogidel. Samuti kuulub siia mõningaid vidinaid, mis on Qt vastavate vidinate alamklassid ning kasutaja seisukohalt vaadates KDE töölauaga paremini integreeritud. </para +></listitem> +</varlistentry> + +<varlistentry> +<term +><ulink url="kdeapi:kio/index.html" +>kio</ulink +></term> +<listitem +><para +>Teek <literal +>kio</literal +> sisaldab vahendeid asünkroonseks ja võrguläbipaistvusega sisend-väljundoperatsioonideks ning ligipääsu MIME tüüpide käsitlemisele. Samuti pakub see KDE failidialoogi ja selle abiklasse. </para +></listitem> +</varlistentry> + +<varlistentry> +<term +><ulink url="kdeapi:kjs/index.html" +>kjs</ulink +></term> +<listitem +><para +>Teek <literal +>kjs</literal +> kujutab endast JavaScripti teostust. </para +></listitem> +</varlistentry> + +<varlistentry> +<term +><ulink url="kdeapi:khtml/index.html" +>khtml</ulink +></term> +<listitem +><para +>Teek <literal +>khtml</literal +> sisaldab KHTML komponenti, HTML lehitsemise vidinat, DOM API-t ja parsijat, sealhulgas Java ja JavaScripti liidest. </para +></listitem> +</varlistentry> + +</variablelist> + +</simplesect> + + +<simplesect id="structure-grouped"> +<title +>Klassid grupiti</title> + +<para +>Rakenduste tuumikkest - klassid, mida vajab peaaegu iga rakendus. </para> + +<itemizedlist> + +<listitem +><formalpara> +<title +><ulink url="kdeapi:tdecore/KApplication" +>KApplication</ulink +></title> +<para +>Initsialiseerib ja juhib KDE rakendust. </para> +</formalpara +></listitem> + +<listitem +><formalpara> +<title +><ulink url="kdeapi:tdecore/KUniqueApplication" +>KUniqueApplication</ulink +></title> +<para +>Kontrollib, et korraga töötaks ainult üks rakenduse eksemplar. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KAboutData" +>KAboutData</ulink +></title> +<para +>Sisaldab infokasti infot. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KCmdLineArgs" +>KCmdLineArgs</ulink +></title> +<para +>Käsurea argumentide töötlemine. </para> +</formalpara +></listitem> + +</itemizedlist> + +<para +>Konfiguratsiooniseadistused - ligipääs KDE hierarhilisele konfiguratsiooniandmebaasile, globaalsetele seadistustele ja rakenduse ressurssidele. </para> + +<itemizedlist> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KConfig" +>KConfig</ulink +></title> +<para +>Pakub ligipääsu KDE konfiguratsiooniandmebaasile. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KSimpleConfig" +>KSimpleConfig</ulink +></title> +<para +>Ligipääs lihtsatele, mittehierarhilistele konfiguratsioonifailidele. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KDesktopFile" +>KDesktopFile</ulink +></title> +<para +>Ligipääs <literal +>.desktop</literal +>-failidele. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KGlobalSettings" +>KGlobalSettings</ulink +></title> +<para +>Hõlpus ligipääs rakendusest otseselt mittesõltuvatele seadistustele. </para> +</formalpara +></listitem> + +</itemizedlist> + +<para +>Failide ja URL-ide käsitlemine - URL-ide, ajutiste failide jne. dekodeerimine. </para> + +<itemizedlist> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KURL" +>KURL</ulink +></title> +<para +>Esindab ja parsib URL-e. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KTempFile" +>KTempFile</ulink +></title> +<para +>Loob ajutistele andmetele unikaalsed failid. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KSaveFile" +>KSaveFile</ulink +></title> +<para +>Lubab faile automaatselt salvestada. </para> +</formalpara +></listitem> + +</itemizedlist> + +<para +>Protsessidevaheline kommunikatsioon - DCOP abiklassid ja alamprotsesside väljakutsumine. </para> + +<itemizedlist> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KProcess" +>KProcess</ulink +></title> +<para +>Kutsub välja ja juhib alamprotsesse. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KShellProcess" +>KShellProcess</ulink +></title> +<para +>Kutsub alamprotsesse välja shelli vahendusel. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdesu/PtyProcess" +>PtyProcess</ulink +></title> +<para +>Suhtlemine alamprotsessidega pseudoterminali vahendusel. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KIPC" +>KIPC</ulink +></title> +<para +>Lihtne IPC mehhanism (kasutab X11 kliendi teateid). </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:dcop/DCOPClient" +>DCOPClient</ulink +></title> +<para +>DCOP teated. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KDCOPPropertyProxy" +>KDCOPPropertyProxy</ulink +></title> +<para +>Proxy klass, mis avaldab Qt omadusi DCOP vahendusel. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KDCOPActionProxy" +>KDCOPActionProxy</ulink +></title> +<para +>Proxy klass, mis avaldab DCOP liidese toimingute jaoks. </para> +</formalpara +></listitem> + +</itemizedlist> + +<para +>Utiliitide klassid - mäluhaldus, regulaaravaldised, stringide käsitlemine, juhunumbrid </para> + +<itemizedlist> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KRegExp" +>KRegExp</ulink +></title> +<para +>POSIX regulaaravaldiste sobivus. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KStringHandler" +>KStringHandler</ulink +></title> +<para +>Ekstravagantne liides stringide käsitlemiseks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KZoneAllocator" +>KZoneAllocator</ulink +></title> +<para +>Tõhus mälueraldaja väikeste objektide suurtele gruppidele. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KRandomSequence" +>KRandomSequence</ulink +></title> +<para +>Pseudojuhuarvude generaator. </para> +</formalpara +></listitem> + +</itemizedlist> + +<para +>Klahvikorraldused - klassid, mis aitavad luua kogu töölaual kasutatavaid kiirklahve. </para> + +<itemizedlist> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KAccel" +>KAccel</ulink +></title> +<para +>Valik kiirklahve. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KStdAccel" +>KStdAccel</ulink +></title> +<para +>Hõlpus ligipääs tavalistele kiirklahvidele. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KGlobalAccel" +></ulink +></title> +<para +>Valik süsteemseid kiirklahve. </para> +</formalpara +></listitem> + +</itemizedlist> + +<para +>Pilditöötlus - ikoonide laadimine ja käsitlemine. </para> + +<itemizedlist> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KIconLoader" +>KIconLoader</ulink +></title> +<para +>Laeb ikoonid teemaga ühilduvalt. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KIconTheme" +>KIconTheme</ulink +></title> +<para +>KIconLoaderi abiklassid. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KPixmap" +>KPixmap</ulink +></title> +<para +>Pikselrasterklass laiendatud pseudotoonimisvõimalustega. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KPixmapEffect" +>KPixmapEffect</ulink +></title> +<para +>Pikselrasterefektid, näiteks üleminekud ja mustrid. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KPixmapIO" +>KPixmapIO</ulink +></title> +<para +>Kiire teisendus <classname +>QImage</classname +> -> <classname +>QPixMap</classname +>. </para> +</formalpara +></listitem> + +</itemizedlist> + +<para +>Lohistamine - värvide ja URL-ide lohistamise objektid. </para> + +<itemizedlist> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KURLDrag" +>KURLDrag</ulink +></title> +<para +>Lohistamisobjekt URL-ide jaoks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KColorDrag" +>KColorDrag</ulink +></title> +<para +>Lohistamisobjekt värvide jaoks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KMultipleDrag" +>KMultipleDrag</ulink +></title> +<para +>Lubab konstrueerida lohistamisobjekte mitme muu objekti põhjal. </para> +</formalpara +></listitem> + +</itemizedlist> + +<para +>Automaatne lõpetamine </para> + +<itemizedlist> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KCompletion" +>KCompletion</ulink +></title> +<para +>Üldine stringide automaatne lõpetamine. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:kio/KURLCompletion" +>KURLCompletion</ulink +></title> +<para +>URL-ide automaatne lõpetamine. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:kio/KShellCompletion" +>KShellCompletion</ulink +></title> +<para +>Käivitatavate failide automaatne lõpetamine. </para> +</formalpara +></listitem> + +</itemizedlist> + +<para +>Vidinat - vidinaklassid nimekirjavaadetele, joonlaudadele, värvivalikule jne. </para> + +<itemizedlist> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KListView" +>KListView</ulink +></title> +<para +>Klassi <classname +>QListView</classname +> variant, mis tunnistab KDE süsteemseid seadistusi. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KListView" +>KListBox</ulink +></title> +<para +>Klassi <classname +>QListBox</classname +> variant, mis tunnistab KDE süsteemseid seadistusi. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KListView" +>KIconView</ulink +></title> +<para +>Klassi <classname +>QIconView</classname +> variant, mis tunnistab KDE süsteemseid seadistusi. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KListView" +>KLineEdit</ulink +></title> +<para +>Klassi <classname +>QLineEdit</classname +> variant lõpetamise toetusega. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KComboBox" +>KComboBox</ulink +></title> +<para +>Klassi <classname +>QComboBox</classname +> variant lõpetamise toetusega. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KFontCombo" +>KFontCombo</ulink +></title> +<para +>Liitkast fontide valimiseks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KColorCombo" +>KColorCombo</ulink +></title> +<para +>Liitkast värvide valimiseks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KColorButton" +>KColorButton</ulink +></title> +<para +>Nupp värvide valimiseks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KURLCombo" +>KURLCombo</ulink +></title> +<para +>Liitkast failinimede ja URL-ide valimiseks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:kfile/KURLRequester" +>KURLRequester</ulink +></title> +<para +>Tekstikast failinimede ja URL-ide valimiseks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KRuler" +>KRuler</ulink +></title> +<para +>Joonlauavidin. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink +url="kdeapi:tdeui/KAnimWidget" +>KAnimWidget</ulink +></title> +<para +>Animatsioonid. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KNumInput" +>KNumInput</ulink +></title> +<para +>Vidin numbrite sisestamiseks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KPasswordEdit" +>KPasswordEdit</ulink +></title> +<para +>Vidin parooli sisestamiseks. </para> +</formalpara +></listitem> + +</itemizedlist> + +<para +>Dialoogid - kõigi võimalustega dialoogid faili, värvi ja fondi valimiseks. </para> + +<itemizedlist> + +<listitem +><formalpara +><title +><ulink url="kdeapi:kfile/KFileDialog" +>KFileDialog</ulink +></title> +<para +>Failivalimise dialoog. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KColorDialog" +>KColorDialog</ulink +></title> +<para +>Värvi valimise dialoog. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KFontDialog" +>KFontDialog</ulink +></title> +<para +>Fondi valimise dialoog. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:kfile/KIconDialog" +>KIconDialog</ulink +></title> +<para +>Ikooni valimise dialoog. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KKeyDialog" +>KKeyDialog</ulink +></title> +<para +>Dialoog kiirklahvide redigeerimiseks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KEditToolBar" +>KEditToolBar</ulink +></title> +<para +>Dialoog tööriistaribade redigeerimiseks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KTipDialog" +>KTipDialog</ulink +></title> +<para +>Päeva nõuande dialoog. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KAboutDialog" +>KAboutDialog</ulink +></title> +<para +>Infodialoog. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KLineEditDlg" +>KLineEditDlg</ulink +></title> +<para +>Lihtne dialoog teksti sisestamiseks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:kfile/KURLRequesterDlg" +>KURLRequesterDlg</ulink +></title> +<para +>Lihtne dialoog URL-ide sisestamiseks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KMessageBox" +>KMessageBox</ulink +></title> +<para +>Dialoog vigade ja hoiatuste näitamiseks. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KPasswordDialog" +>KPasswordDialog</ulink +></title> +<para +>Dialoog parooli sisestamiseks. </para> +</formalpara +></listitem> + +</itemizedlist> + +<para +>Toimingud ja XML GUI </para> + +<itemizedlist> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KAction" +>KAction</ulink +></title> +<para +>Toimingu abstraktsioon, mida võib lisada menüü- ja tööriistaribale. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KActionCollection" +>KActionCollection</ulink +></title> +<para +>Valik toiminguid. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdeui/KXMLGUIClient" +>KXMLGUIClient</ulink +></title> +<para +>GUI fragment, mis sisaldab toimingukogu ja DOM puu, mis esindab nende asukohta GUI-s. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:kparts/KPartManager" +>KPartManager</ulink +></title> +<para +>Korraldab XMLGUI klientide aktiveerimist. </para> +</formalpara +></listitem> + +</itemizedlist> + +<para +>Pluginad ja komponendid </para> + +<itemizedlist> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KLibrary" +>KLibrary</ulink +></title> +<para +>Esindab dünaamiliselt laetavat teeki. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KLibrary" +>KLibLoader</ulink +></title> +<para +>Jagatud teegi laadimine. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:tdecore/KLibFactory" +>KLibFactory</ulink +></title> +<para +>Objektipere pluginatena. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:kio/KServiceType" +>KServiceType</ulink +></title> +<para +>Esindab teenuse tüüpi. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:kio/KService" +>KService</ulink +></title> +<para +>Esindab teenust. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:kio/KMimeType" +>KMimeType</ulink +></title> +<para +>Esindab MIME tüüpi. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:kio/KServiceTypeProfile" +>KServiceTypeProfile</ulink +></title> +<para +>Kasutaja seadistused MIME tüübi seostele. </para> +</formalpara +></listitem> + +<listitem +><formalpara +><title +><ulink url="kdeapi:kio/KServiceTypeProfile" +>KTrader</ulink +></title> +<para +>Teenuste päring. </para> +</formalpara +></listitem> + +</itemizedlist> + +</simplesect> + +</chapter> + + + +<chapter id="graphics"> +<title +>Graafika</title> + +<sect1 id="graphics-qpainter"> +<title +>Süvataseme graafika QPainteriga</title> + +<simplesect id="qpainter-rendering"> +<title +>Renderdamine QPainteriga</title> + +<para +>Qt süvataseme pildiloome tugineb neile X11 ja muude aknasüsteemide võimetele, mille jaoks on olemas Qt pordid. Kuid see ka laiendab neid, teostades täiendavaid võimalusi, näiteks teksti ja pikselrastrite afiinsed transformatsioonid. </para> + +<para +>Qt 2D joonistamise keskne graafikaklass on <ulink url="kdeapi:qt/QPainter" +></ulink +>. Selle aluseks on <ulink url="kdeapi:qt/QPaintDevice" +></ulink +>. Teostatud on kolm võimalikku joonistamisseadet. <ulink url="kdeapi:qt/QWidget" +></ulink +> esindab vidinat ekraanil. <ulink url="kdeapi:qt/QPrinter" +></ulink +> esindab printerit ja loob PostScript väljundi. <ulink url="kdeapi:qt/QPicture" +></ulink +> tuvastab joonistamiskäsud ja võib salvestada need kettale ning neid hiljem taasesitada. Joonistamiskäskude võimalik salvestusvorming on W3C standard SVG. </para> + +<para +>Nii on võimalik renderduskoodi, mida kasutad vidina näitamiseks, pruukida ka trükkimiseks, kusjuures toetatud on samasugused võimalused. Praktikas kasutatakse koodi mõistagi veidi erinevas kontekstis. Vidina kujutamine tehakse peaaegu eranditult vidinaklassi meetodiga paintEvent(). </para> + +<programlisting +>void FooWidget::paintEvent() +{ + QPainter p(this); + // Setup painter + // Use painter +} +</programlisting> + +<para +>Printeri korral tuleb kontrollida, et kasutusel oleks QPrinter::newPage(), mis lõpetab lehekülje ja alustab uut. See ei ole mõistetavalt joonistamisvidinate juures kuigi oluline. Trükkimisel oleks mõttekas ka kasutada koordinaatide arvutamiseks <ulink url="kdeapi:qt/QPaintDeviceMetrics" +>seadmemeetrikat</ulink +>. </para> + +</simplesect> + + +<simplesect id="qpainter-transformations"> +<title +>Transformatsioonid</title> + +<para +>Vaikimisi joonistab QPainter kasutatud seadme loomulikus koordinaatide süsteemis. See tähendab, et kui joonistad horisontaalteljel joone pikkusega 10 ühikut, joonistatakse see ekraanil 10-pikslise pikkusega rõhtjoonena. Kuid QPainter võib rakendada enne kujundite ja kõverate tegelikku renderdamist ka afiinseid transformatsioone. Afiinne transformatsioon seob x- ja y-koordinaadid lineaarselt x' ja y'-ga vastavalt maatriksile </para> + +<mediaobject> +<imageobject +><imagedata fileref="affine-general.png"/></imageobject> +</mediaobject> + +<para +>Selle 3x3 maatriksi saab määrata funktsiooniga QPainter::setWorldMatrix() ning selle tüüp on <ulink url="kdeapi:qt/QWMatrix" +>QWMatrix</ulink +>. Tavaliselt on see identsusmaatriks, st. m11 ja m22 on üks ning muud parameetrid null. Põhimõtteliselt on olemas kolm erinevat transformatsioonigruppi: </para> + +<itemizedlist> + +<listitem +><formalpara> +<title +>Lüke</title> +<para +>See liigutab objekti kõik punktid määratud hulga võrra mingis suunas. Lükkemaatriksi saab välja kutsuda QWMatrixi funktsiooniga m.translate(dx, dy). See vastab maatriksile </para> +</formalpara> + +<mediaobject> +<imageobject +><imagedata fileref="affine-translate.png"/></imageobject> +</mediaobject> + +</listitem> + +<listitem +><formalpara> +<title +>Skaleerimine</title> +<para +>See laiendab või ahendab objekti koordinaate, muutes selle ilma moonutusteta suuremaks või väiksemaks. Skaleerimist saab QWMatrixile rakendada m.scale(sx, sy) väljakutsumisega. See vastab maatriksile </para> +</formalpara> + +<mediaobject> +<imageobject +><imagedata fileref="affine-scale.png"/></imageobject> +</mediaobject> + +<para +>Määrates ühe parameetritest negatiivseks, saab koordinaatide süsteemi peegeldada. </para> + +</listitem> + +<listitem +><formalpara> +<title +>Nihe</title> +<para +>Kahe parameetriga koordinaatide süsteemi nihe. Nihke saab rakendada m.shear(sh, sv) väljakutsumisega, sellele vastab maatriks </para> +</formalpara> + +<mediaobject> + <imageobject +><imagedata fileref="affine-shear.png"/></imageobject> +</mediaobject> + +</listitem> + +<listitem +><formalpara> +<title +>Pööramine</title> +<para +>Pöörab objekti. Pööramist saab rakendada m.rotate(nurk) väljakutsumisega. Arvesta, et nurk tuleb anda kraadides, mitte matemaatilise nurgana! Vastav maatriks on </para> +</formalpara> + +<mediaobject> +<imageobject +><imagedata fileref="affine-rotate.png"/></imageobject> +</mediaobject> + +<para +>Pane tähele, et pööramine on ekvivalentne skaleerimise ja nihke kombinatsiooniga. </para> + +</listitem> + +</itemizedlist> + +<para +>Nüüd mõned pildid, mis näitavad elementaarsete transformatsioonide mõju meie maskotile: </para> + +<informaltable frame="none"> +<tgroup cols="3"> +<tbody> +<row> +<entry +><mediaobject> + <imageobject +><imagedata fileref="konqi-normal.png"/></imageobject> +</mediaobject +></entry> +<entry +><mediaobject> + <imageobject +><imagedata fileref="konqi-rotated.png"/></imageobject> +</mediaobject +></entry> +<entry +><mediaobject> + <imageobject +><imagedata fileref="konqi-sheared.png"/></imageobject> +</mediaobject +></entry> +<entry +><mediaobject> + <imageobject +><imagedata fileref="konqi-mirrored.png"/></imageobject> +</mediaobject +></entry> +</row> +<row> +<entry +>a) Normaalne</entry> +<entry +>b) Pööratud 30 kraadi</entry> +<entry +>c) Nihe teguriga 0,4</entry> +<entry +>d) Peegeldatud</entry> +</row> +</tbody> +</tgroup> +</informaltable> + +<para +>Transformatsioone võib kombineerida elementaarmaatrikseid korrutades. Arvesta, et maatriksioperatsioonid ei ole üldiselt kommuteeruvad, mistõttu nende mõju tervikuna sõltub sellest, millises järjekorras neid korrutatakse. </para> + +</simplesect> + + +<simplesect id="qpainter-strokeattributes"> +<title +>Jooneatribuutide määramine</title> + +<para +>Sirgete, kõverate ja polügoonide piirjoonte renderdamist saab modifitseerida spetsiaalset pliiatsit määrates, mida teeb funktsioon QPainter::setPen(). Selle funktsiooni argument on <ulink url="kdeapi:qt/QPen" +>QPen</ulink +> objekt. Selles salvestatud omadused on stiil, värv, ühendusstiil ja otsastiil. </para> + +<para +>Pliiatsistiil on loendi <ulink url="kdeapi:qt/Qt#PenStyle-enum" +>Qt::PenStyle</ulink +> liige ning sellel võivad olla järgmised väärtused: </para> + +<mediaobject> + <imageobject +><imagedata fileref="penstyles.png"/></imageobject> +</mediaobject> + +<para +>Ühendusstiil on loendi <ulink url="kdeapi:qt/Qt#PenJoinStyle-enum" +>Qt::PenJoinStyle</ulink +> liige. See määrab, kuidas joonistatakse ühenduskoht mitme teineteisega seotud sirgjoone vahel. Sellel võivad olla järgmised väärtused: </para> + +<informaltable frame="none"> +<tgroup cols="3"> +<tbody> +<row> +<entry +><mediaobject> + <imageobject +><imagedata fileref="joinmiter.png"/></imageobject> +</mediaobject +></entry> +<entry +><mediaobject> + <imageobject +><imagedata fileref="joinbevel.png"/></imageobject> +</mediaobject +></entry> +<entry +><mediaobject> + <imageobject +><imagedata fileref="joinround.png"/></imageobject> +</mediaobject +></entry> +</row> +<row> +<entry +>a) Nurkühendus</entry> +<entry +>c) Längühendus</entry> +<entry +>b) Ümarühendus</entry> +</row> +</tbody> +</tgroup> +</informaltable> + +<para +>Otsastiil on loendi <ulink url="kdeapi:qt/Qt#PenCapStyle-enum" +>Qt::PenCapStyle</ulink +> liige ja määrab, kuidas joonistatakse sirgjoonte otsad. Sellel võivad olla järgmised väärtused: </para> + +<informaltable frame="none"> +<tgroup cols="3"> +<tbody> +<row> +<entry +><mediaobject> + <imageobject +><imagedata fileref="capflat.png"/></imageobject> +</mediaobject +></entry> +<entry +><mediaobject> + <imageobject +><imagedata fileref="capsquare.png"/></imageobject> +</mediaobject +></entry> +<entry +><mediaobject> + <imageobject +><imagedata fileref="capround.png"/></imageobject> +</mediaobject +></entry> +</row> +<row> +<entry +>a) Lameots</entry> +<entry +>b) Ruutots</entry> +<entry +>c) Ümarots</entry> +</row> +</tbody> +</tgroup> +</informaltable> + +</simplesect> + + +<simplesect id="qpainter-fillattributes"> +<title +>Täiteatribuutide määramine</title> + +<para +>Polügoonide, ringjoonte või ristkülikute täitestiili saab muuta spetsiaalse pintsli määramisega funktsiooniga QPainter:.setBrush(). See funktsioon kasutab argumendina <ulink url="kdeapi:qt/QBrush" +>QBrush</ulink +> objekti. Pintslit saab konstrueerida neljal moel: </para> + +<itemizedlist> +<listitem> +<para +>QBrush::QBrush() - loob pintsli, mis ei täida kujundeid.</para> +</listitem> +<listitem> +<para +>QBrush::QBrush(Pintslistiil) - loob musta pintsli ühega all näidatud vaikemustritest.</para> +</listitem> +<listitem> +<para +>QBrush::QBrush(const QColor &, Pintslistiil) - loob värvilise pintsli ühega all näidatud mustritest.</para> +</listitem> +<listitem> +<para +>QBrush::QBrush(const QColor &, const QPixmap) - loob värvilise pintsli omaloodud mustriga, mis antakse teise parameetrina.</para> +</listitem> +</itemizedlist> + +<para +>Vaikimisi pintslistiil pärineb loendist <ulink url="kdeapi:qt/Qt#BrushStyle-enum" +>Qt::BrushStyle</ulink +>. Toome siin ära pildi kõigi eelnevalt määratud mustritega: </para> + +<mediaobject> + <imageobject +><imagedata fileref="brushstyles.png"/></imageobject> +</mediaobject> + +<para +>Pintsli käitumist saab veel täpsemalt kohandada funktsiooniga QPainter::setBrushOrigin(). </para> + +</simplesect> + + +<simplesect id="qpainter-color"> +<title +>Värv</title> + +<para +>Värvidel on oma osa nii kõverate esitamisel kui kujundite täitmisel. Qt-s esindab värve klass <ulink url="kdeapi:qt/QColor" +>QColor</ulink +>. Qt ei toeta selliseid graafilisi võimalusi, nagu ICC värviprofiilid ja värvikorrektsioon. Värvid konstrueeritakse tavaliselt nende punast, rohelist ja sinist komponenti määratledes, kuna RGB on ka viis, millega esitatakse pikslid monitoril. </para> + +<para +>Võimalik on küll kasutada ka tooni, küllastust ja väärtust. Selline HSV on kasutusel GTK värvidialoogis, näiteks rakenduses Gimp. Siin vastab toon värviketta nurgale, küllastus aga tähistab vahemaad ketta keskpunktist. Väärtuse saab määrata eraldi liuguriga. </para> + +</simplesect> + + +<simplesect id="qpainter-paintsettings"> +<title +>Muud seadistused</title> + +<para +>Tavaliselt asendavad joonistusseadmel joonistades joonistatavad pikslid seal varasemad pikslid. See tähendab, et kui joonistad teatud piirkonna punasega ning hiljem joonistad sama piirkonna sinisega, jääb nähtavaks ainult sinine. Qt graafikamudel ei toeta läbipaistvust, s.t. joonistatud esiplaani kokkusulamist taustaga. Siiski võib üsna hõlpsasti kombineerida tausta ja esiplaani tõeoperaatorite abil. Meetod QPainter::setRasterOp() määrab kasutatavad operaatorid, mis on pärit nimekirjast <ulink url="kdeapi:qt/Qt#RasterOp-enum" +>RasterOp</ulink +>. </para> + +<para +>Vaikeväärtus on CopyROP, mis ignoreerib tausta. Teine levinud valik on XorROP. Kui joonistad selle operaatoriga musta joone värvilisele kujutisele, inverteeritakse kaetud ala. Seda efekti on näiteks kasutatud mitmetes pilditöötlusrakendustes pildiosade valimisel niinimetatud "marssivaid sipelgaid" kujutava valikukasti tekitamisel. </para> + +</simplesect> + + +<simplesect id="qpainter-primitives"> +<title +>Graafikaprimitiivide joonistamine</title> + +<para +>Järgnevalt toome ära QPainteri toetatud elementaarsete graafikaelementide loendi. Enamik neist on olemas mitmes versioonis, mis võivad kasutada erineval hulgal argumente. Näiteks ristkülikuid puudutavad meetodid kasutavad tavaliselt argumendina <ulink url="kdeapi:qt/QRect" +>QRect</ulink +> nelja täisarvu. </para> + +<itemizedlist> +<listitem> +<para +>Ühe punkti joonistamine - drawPoint().</para> +</listitem> +<listitem> +<para +>Sirgjoonte joonistamine - drawLine(), drawLineSegments() ja drawPolyLine().</para> +</listitem> +<listitem> +<para +>Ristkülikute joonistamine ja täitmine - drawRect(), drawRoundRect(), fillRect() ja eraseRect().</para> +</listitem> +<listitem> +<para +>Ringjoonte, ellipsite ja nende osade joonistamine ja täitmine - drawEllipse(), drawArc(), drawPie ja drawChord().</para> +</listitem> +<listitem> +<para +>Tavaliste polügoonide joonistamine ja täitmine - drawPolygon().</para> +</listitem> +<listitem> +<para +>Bezier' kõverate joonistamine - drawQuadBezier() [drawCubicBezier Qt versioonis 3.0].</para> +</listitem> +</itemizedlist> + +</simplesect> + + +<simplesect id="qpainter-pixmaps"> +<title +>Pikselrastrite ja piltide joonistamine</title> + +<para +>Qt pakub piltide esitamiseks kaht väga erinevat klassi. </para> + +<para +><ulink url="kdeapi:qt/QPixmap" +>QPixmap</ulink +> vastab otseselt X11 pikselrasterobjektidele. Pikselrastrid on serveripoolsed objektid, mis moodsate graafikakaartide korral võivad olla isegi vahetult kaardimällu salvestatud. See muudab pikselrastrite edastamise ekraanile <emphasis +>äärmiselt</emphasis +> tõhusaks ja kiireks. Pikselrastrid toimivad ka vidinate vastena ekraanil - QPixmap on klassi QPaintDevice alamklass, nii et sellega on võimalik kasutada ka QPainterit. Moodsad graafikakaardid üldiselt kiirendavad elementaarseid joonistusoperatsioone. Seepärast on üpris tavaline kasutada pikselrastreid topeltpuhverduseks. See tähendab, et vidina vahetu joonistamise asemel joonistad ajutise pikselrasterobjekti ja kasutad selle edastamiseks vidinale funktsiooni <ulink url="kdeapi:qt/QPaintDevice#bitBlt-1" +>bitBlt</ulink +>. Keerulisemate asjade puhul aitab see vältida vilkumist. </para> + +<para +>Seevastu <ulink url="kdeapi:qt/QImage" +>QImage</ulink +> objektid asuvad kliendi poolel. Nende põhiülesanne on pakkuda vahetut juurdepääsu pildi pikslitele. Nii saab neid kasutada pilditöötluseks ning sellisteks asjadeks nagu laadimine või kettale salvestamine (QPixmapi meetod load() kasutab vaheastmena QImage'it). Teisalt on pildi joonistamine vidinale üsna mahukas operatsioon, sest sellega kaasneb edastamine X'i serverisse, mis võib võtta omajagu aega, eriti kui tegemist on suurte piltidega või kaugserveritega. Sõltuvalt värvisügavusest võib teisendus QImage -> QPixmap nõuda ka pseudotoonimist. </para> + +</simplesect> + + +<simplesect id="qpainter-drawingtext"> +<title +>Teksti joonistamine</title> + +<para +>Teksti saab esitada meetodi QPainter::drawText() mõne variandiga. Need joonistavad QStringi kas määratud punktis või määratud ristkülikus, kasutades fonti, mille määrab QPainter::setFont(). Kasutada saab ka parameetrit, mis võtab mõne lipu ORed kombinatsiooni nimekirjadest <ulink url="kdeapi:qt/Qt#AlignmentFlags-enum" +>Qt::AlignmentFlags</ulink +> ja <ulink url="kdeapi:qt/Qt#TextFlags-enum" +>Qt::TextFlags</ulink +> </para> + +<para +>Alates versioonist 3.0 tegeleb Qt täielikult teksti esitamisega ka paremalt vasakule kirjutatavate keelte puhul. </para> + +<para +>Täiustatum viis teksti esitamiseks on klass <ulink url="kdeapi:qt/QSimpleRichText" +>QSimpleRichText</ulink +>. Selle klassi objekte võib konstrueerida tekstiosaga HTML-siltide kogumit kasutades, mis pakub üpris palju võimalusi, isegi tabeleid. Tekstistiili saab kohandada <ulink url="kdeapi/qt/QStyleSheet" +>QStyleSheet</ulink +> abil (sealt leiab ka siltide dokumentatsiooni). Kui rikkaliku teksti vormingu objekt on konstrueeritud, saab seda renderdada vidinale või muule joonistamisseadmele meetodiga QSimpleRichText::draw(). </para> + +</simplesect> + +</sect1> + + +<sect1 id="graphics-qcanvas"> +<title +>Struktureeritud graafika klassi QCanvas abil</title> + +<para +>QPainter pakub võimsa pildiloomemudeli vidinatele ja pikselrastritele joonistamiseks. Kuid vahel võib seda olla üsna tülikas kasutada. Alati, kui vidin saab joonistamissündmuse, tuleb tal ette võtta QPaintEvent::region() või QPaintEvent::rect() analüüsimine, mis tuleb ümber joonistada. Siis tuleb seadistada QPainter ja joonistada kõik objektid, mis kattuvad antud piirkonnaga. Näiteks olgu vektorgraafikarakendus, mis võimaldab lohistada polügoone, ringjooni ja nende gruppe. Iga kord, kui selliseid objekte kas või veidi liigutatakse, käivitab vidina hiiresündmuse käitleja joonistamissündmuse nii kogu sellele alale, kus need objektid varem asusid, kui ka alale, kuhu need liigutati. Vajalike ümberjoonistuste leidmine ning nende efektiivne sooritamine võib olla päris keeruline, samuti võib see sattuda konflikti rakenduse lähtekoodi objektorienteeritud struktuuriga. </para> + +<para +>Alternatiivina sisaldab Qt klassi <ulink url="kdeapi:qt/QCanvas" +>QCanvas</ulink +>, kuhu saab panna graafilised objektid, näiteks polügoonid, teksti, pikselrastrid. Pakkuda saab ka lisaelemente alamklassiga <ulink url="kdeapi:qt/QCanvasItem" +>QCanvasItem</ulink +> või mõne veel spetsialiseerituma alamklassiga. Lõuendit võib ekraanil näidata üks või enam vidinat klassist <ulink url="kdeapi:qt/QCanvas" +>QCanvasView</ulink +>, mis tuleb kasutaja tegevuse käitlemiseks alamklassiks muuta. Qt hoolitseb kõigi vaate objektide ümberjoonistamise ees, olgu selle põhjuseks vidina nähtavaleilmumine, uute objektide loomine või muutmine või mingi muu põhjus. Topeltpuhverduse kasutamine lubab seda teha tõhusal ja vilkumist vältival viisil. </para> + +<para +>Lõuendi elemendid võivad üksteisega kattuda. Sellisel juhul sõltub see, milline on näha, z-astmest, mille määrab QCanvasItem::setZ(). Elemente saab muuta nähtavaks või nähtamatuks. Samuti võib lasta tausta joonistada kõigi teiste elementide "taga". Hiiresündmuste seostamiseks objektidega lõuendil on meetod QCanvas::collisions(), mis tagastab antud punktis kattuvate elementide nimekirja. Toome siin ära ühe lõuendivaate: </para> + +<mediaobject> +<imageobject +><imagedata fileref="canvas.png"/></imageobject> +</mediaobject> + +<para +>Taustal joonistatakse võrku. Lisaks on siin element QCanvasText ning lilla QCanvasPolygon. Liblikas on QCanvasPixmap. Sellel on läbipaistvad alad, mis lubavad näha selle all olevaid elemente. </para> + +<para +>QCanvas kasutamise juhendi näiteks vaimustavate mängude loomiseks leiab internetist <ulink url="http://zez.org/article/articleview/2/1/" +>sellel aadressil</ulink +>. </para> + +</sect1> + + +<sect1 id="graphics-qglwidget"> +<title +>3D graafika OpenGL abil</title> + +<simplesect id="qglwidget-lowlevel"> +<title +>Süvataseme liides</title> + +<para +>Tänapäeval on 3D graafika renderdamise de facto standard <ulink url="http://www.opengl.org" +>OpenGL</ulink +>. Selle spetsifikatsiooni teostusi pakuvad Microsoft Windows, Mac OS X ja XFree86, mis tihti toetavad ka nüüdisaegsete graafikakaartide pakutavaid riistvaralise kiirendamise võimalusi. OpenGL ise tegeleb ainult renderdamisega konkreetses pildimälu piirkonnas <emphasis +>GL konteksti</emphasis +> vahendusel ega suhtle mingil määral keskkonna tööriistakomplektiga. </para> + +<para +>Qt pakub vidinat <ulink url="kdeapi:qt/QGLWidget" +>QGLWidget</ulink +>, mis kapseldab akna sellega seotud GL kontekstiga. Põhimõtteliselt tähendab see selle muutmist alamklassiks ja mõningate meetodite taasteostamist. </para> + +<itemizedlist> + +<listitem +><para +>Selle asemel, et taasteostada paintEvent() ja kasutada QPainter'it vidina sisu joonistamiseks, tühistatakse paintGL() ja kasutatakse stseeni renderdamiseks GL käske. QGLWidget hoolitseb GL konteksti muutmise eest aktiivseks enne seda, kui paintGL() välja kutsutakse, ning hiljem tühjendab selle. </para +></listitem> + +<listitem +><para +>Enne seda, kui kutsutakse esimest korda välja resizeGL() või paintGL(), kutsutakse korraks välja virtuaalmeetod initializeGL(). Seda saab kasutada objektide esitamise nimekirjade konstrueerimiseks ja mis tahes vajaolevaks initsialiseerimiseks. </para +></listitem> + +<listitem +><para +>Selle asemel, et resizeEvent() taasteostada, tühistatakse resizeGL(). Seda saab kasutada vaateava sobivaks määramiseks. </para +></listitem> + +<listitem +><para +>Selle asemel, et kutsuda välja update(), kui stseeni olek on muutunud - kui näiteks animeerid selle taimeriga - , tuleks välja kutsuda updateGL(). See käivitab ümberjoonistamise. </para +></listitem> + +</itemizedlist> + +<para +>Üldiselt toimib QGLWidget nagu üks vidin ikka, s.t. et on võimalik hiiresündmusi töödelda nagu tavaliselt, vidina suurust muuta ja kombineerida seda esitamisel muude vidinatega. </para> + +<mediaobject> +<imageobject +><imagedata fileref="opengl.png"/></imageobject> +</mediaobject> + +<para +>Qt sisaldab mõningaid näiteid QGLWidgeti kasutamise kohta oma <literal +>demo</literal +>s. Õppevahendid leiab <ulink url="http://www.libsdl.org/opengl/intro.html" +>siit</ulink +>, rohkem infot ja OpenGL selgitusi aga <ulink url="http://www.opengl.org" +>OpenGL koduleheküljelt</ulink +>. </para> + +</simplesect> + + +<simplesect id="qglwidget-highlevel"> +<title +>Kõrgtaseme liidesed</title> + +<para +>OpenGL on 3D graafika joonistamise suhteliselt süvataseme liides. Nii nagu annab QCanvas programmeerijate käsutusse kõrgtaseme liidese objektide ja nende omaduste käsitlemiseks, nii on olemas kõrgtaseme liidesed ka 3D graafika puhul. Üks menukamaid on Open Inventor. Algselt töötas selle välja SGI, tänapäeval on aga olemas ka vaba tarkvara teostus <ulink url="http://www.coin3d.org" +>Coin</ulink +>, mida on täiendatud seda Qt-ga siduva tööriistakomplektiga SoQt. </para> + +<para +>Open Inventori aluseks on niinimetatud <emphasis +>stseen</emphasis +>. Stseeni võib hoida kõvakettal salvestatuna spetsiaalsesse vormingusse, mis on lähedane <ulink url="http://www.vrml.org" +>VRML</ulink +>-vorminguga. Stseen koosneb objektidest, mida nimetatakse <emphasis +>sõlmedeks</emphasis +>. Open Inventor pakub omalt poolt arvukalt taaskasutatavaid sõlmi, näiteks kuubid, silindrid ja võrgud, samuti valgusallikad, kaamerad jne. Sõlmi esindavad C++ klassid ning neid võib kombineerida ja alamklassiks muuta. </para> + +<para +>Open Inventori sissejuhatuse leiab <ulink url="http://www.motifzone.com/tmd/articles/OpenInventor/OpenInventor.html" +>siit</ulink +> (üldiselt võib seda artiklit lugedes mõttes SoXt asemele panna SoQt). </para> + +</simplesect> + +</sect1> + +</chapter> + + + +<chapter id="userinterface"> +<title +>Kasutajaliides</title> + +<sect1 id="userinterface-actionpattern"> +<title +>Toimingumuster</title> + +<para +></para> + +</sect1> + + +<sect1 id="userinterface-xmlgui"> +<title +>Menüüde ja tööriistaribade defineerimine XML-is</title> + +<simplesect id="xmlgui-intro"> +<title +>Sissejuhatus</title> + +<para +><link linkend="userinterface-actionpattern" +>Toimingumuster</link +> lubab küll kapseldada kasutaja käivitatud toimingud objekti, mille saab "torgata" kuhugi menüü- või tööriistaribale, kuid see ei lahenda veel menüü enda konstrueerimise probleemi. Tuleb ju kõik hüpikmenüüd luua C++ koodis ja selgelt lisada sinna toimingud teatud järjekorras, pidades silmas standardtoimingute stiilijuhiseid. Nii on üsna raske lubada kasutajal kohandada menüüsid või muuta kiirklahve oma vajadustele kohasemaks ilma lähtekoodi ennast muutmata. </para> + +<para +>Selle probleemi lahendab klasside kogum nimetusega <literal +>XMLGUI</literal +>. Põhimõtteliselt eraldab see toimingud (C++ koodis) nende esinemisest menüü- ja tööriistaribadel (XML koodis). Ilma lähtekoodi muutmata saab menüüsid hõlpsasti kohandada lihtsalt XML-faili muutes. Lisaks aitab see tagada, et standardtoimingud (näiteks <menuchoice +><guimenu +>Fail</guimenu +><guimenuitem +>Ava</guimenuitem +></menuchoice +> või <menuchoice +><guimenu +>Abi</guimenu +><guimenuitem +>Info</guimenuitem +></menuchoice +>) esinevad just seal, kus stiilijuhised ette näevad. XMLGUI on eriti oluline moodulprogrammides, kus menüüriba elemendid võivad pärineda erinevatelt pluginatelt või komponentidelt. </para> + +<para +>KDE tipptaseme akna klassi <ulink url="kdeapi:tdeui/KMainWindow.html" +>KMainWindow</ulink +> eellane on <ulink url="kdeapi:tdeui/KXMLGUIClient.html" +>KXMLGUIClient</ulink +>, mistõttu see toetab automaatselt XMLGUI-d. Kõigi selles loodud toimingute eellane peab olema kliendi <literal +>actionCollection()</literal +>. Siis loob <literal +>createGUI()</literal +> väljakutse terve menüü- ja tööriistaribade komplekti, mida defineerib rakenduse XML-fail (mugavuse mõttes on see sufiksiga <literal +>ui.rc</literal +>). </para> + +</simplesect> + + +<simplesect id="xmlgui-kviewexample"> +<title +>Näide: KView menüü</title> + +<para +>Järgnevas võtame näiteks KDE pildinäitaja <application +>KView</application +>. Sellel on <literal +>ui.rc</literal +> fail nimega <filename +>kviewui.rc</filename +>, mis on paigaldatud koodijupiga <filename +>Makefile.am</filename +> </para> + +<programlisting +>rcdir = $(kde_datadir)/kview +rc_DATA = kviewui.rc +</programlisting> + +<para +>See on katke failist <filename +>kviewui.rc</filename +>. Lihtsuse mõttes näitame ainult menüü <guimenu +>Vaade</guimenu +> definitsiooni. </para> + +<programlisting +><!DOCTYPE kpartgui> +<kpartgui name="kview"> + <MenuBar> + <Menu name="view" > + <Action name="zoom50" /> + <Action name="zoom100" /> + <Action name="zoom200" /> + <Action name="zoomMaxpect" /> + <Separator/> + <Action name="fullscreen" /> + </Menu> + </MenuBar> +</kpartgui> +</programlisting> + +<para +>Vastav osa C++ keeles kõlab: </para> + +<programlisting +>KStdAction::zoomIn ( this, SLOT(slotZoomIn()), actionCollection() ); + KStdAction::zoomOut ( this, SLOT(slotZoomOut()), actionCollection() ); + KStdAction::zoom ( this, SLOT(slotZoom()), actionCollection() ); + new KAction ( i18n("&Half size"), ALT+Key_0, + this, SLOT(slotHalfSize()), + actionCollection(), "zoom50" ); + new KAction ( i18n("&Normal size"), ALT+Key_1, + this, SLOT(slotDoubleSize()), + actionCollection(), "zoom100" ); + new KAction ( i18n("&Double size"), ALT+Key_2, + this, SLOT(slotDoubleSize()), + actionCollection(), "zoom200" ); + new KAction ( i18n("&Fill Screen"), ALT+Key_3, + this, SLOT(slotFillScreen()), + actionCollection(), "zoomMaxpect" ); + new KAction ( i18n("Fullscreen &Mode"), CTRL+SHIFT+Key_F, + this, SLOT(slotFullScreen()), + actionCollection(), "fullscreen" ); +</programlisting> + +<para +>Sellise GUI definitsiooni põhjal loodud menüü <guimenu +>Vaade</guimenu +> näeb välja niisugune: </para> + +<mediaobject> +<imageobject +><imagedata fileref="kview-menu.png"/></imageobject> +</mediaobject> + +<para +>XML-fail algab dokumenditüübi deklaratsiooniga. Kpartgui DTD leiab tdelibs'i lähtekoodis failis <filename +>tdeui/kpartgui.dtd</filename +>. Faili väliseim element sisaldab atribuudina rakenduse eksemplari nime. See võib sisaldada ka versiooninumbrit kujul "version=2". Viimane on kasulik rakenduse uue versiooni korral, kui menüüstruktuuri on muudetud, näiteks lisatud uusi võimalusi. Kui suurendada faili <literal +>ui.rc</literal +> versiooninumbrit, kontrollib KDE, et faili kohandatud versioonid eemaldataks ja kasutataks just uut faili. </para> + +<para +>Järgmine rida <literal +><MenuBar></literal +> sisaldab menüüriba deklaratsiooni. Lisada võib ka suvalise arvu <literal +><ToolBar></literal +> deklaratsioone, kui soovid tööriistaribasid luua. Menüü sisaldab alammenüüd nimega "view". See nimi on juba eelnevalt defineeritud ja nii võibki pildil näha sõna "View" (eestindatud menüüs oleks see "Vaade"). Kui deklareerida oma alammenüü, tuleb nende nimetus vahetult lisada. Nii on rakendusel <application +>KView</application +> alammenüü "Image" (eestindatult "Pilt"), mis tuleb deklareerida nii: </para> + +<programlisting +><Menu name="image" > + <text>&amp;Image</text> + ... +</Menu> +</programlisting> + +<para +>KDE automake-raamistik võimaldab sellised nimetused automaatselt välja noppida ja panna rakenduse <ulink url="tde-i18n-howto.html" +><literal +>.po</literal +></ulink +> faili, mida siis tõlkijad saavad tarvitada rakenduse emakeelde panekul. Pane tähele, et kiirklahvi tähis "&" tuleb kirjutada XML-i reeglitele vastavalt "&amp;". </para> + +<para +>Vaatame uuesti meie näidet. <application +>KView</application +> menüüs <guimenu +>Vaade</guimenu +> on mitu kohandamistoimingut: <literal +>zoom50</literal +>, <literal +>zoom100</literal +>, <literal +>zoom200</literal +>, <literal +>zoomMaxpect</literal +> ja <literal +>fullscreen</literal +>, mis on deklareeritud elemendiga <literal +><Action></literal +>. Pildil nähtavale eraldusjoonele vastab element <literal +><Separator></literal +>. </para> + +<para +>Pane tähele, et mõnel elemendil ei ole XML-failis vastet. Need on niinimetatud <emphasis +>standardtoimingud</emphasis +>, mille loob klass <ulink url="kdeapi:tdeui/KStdAction.html" +>KStdAction</ulink +>. Kui lood mingeid toiminguid oma rakenduses (nagu ülaltoodud C++ näites), lisatakse standardtoimingud automaatselt eelnevalt määratud asukohta, mõnikord kaasnevad nendega ka ikoon ja kiirklahv. Neid asukohti saab tuvastada tdelibs lähtekoodi failis <filename +>tdeui/ui_standards.rc</filename +>. </para> + +</simplesect> + + +<simplesect id="xmlgui-konqexample"> +<title +>Näide: Konquerori tööriistaribad</title> + +<para +>Tööriistaribade puhul vaatame nüüd <application +>Konqueror</application +>i GUI definitsiooni. See katke määratleb asukohariba, mis sisaldab endas URL-ide sisestamise välja. </para> + +<programlisting +><ToolBar name="locationToolBar" fullWidth="true" newline="true" > + <text>Location Toolbar</text> + <Action name="clear_location" /> + <Action name="location_label" /> + <Action name="toolbar_url_combo" /> + <Action name="go_url" /> +</ToolBar> +</programlisting> + +<para +>Märkame kohe, et siin on märksa rohkem atribuute kui menüüribal, sealhulgas: </para> + +<itemizedlist> + +<listitem +><para +><literal +>fullWidth</literal +>: ütleb XMLGUI-le, et tööriistariba laius on võrdne tipptaseme akna laiusega. Kui see on määratud "vääraks" (false), võtab tööriistariba ainult nii palju ruumi, kui talle parajasti vaja läheb ning samasse ritta võivad mahtuda ka muud tööriistaribad. </para +></listitem> + +<listitem +><para +><literal +>newline</literal +>: on seotud eelmise valikuga. Kui see on "tõene" (true), alustab tööriistariba uut rida, vastasel juhul võib see asetseda samas reas eelmise tööriistaribaga. </para +></listitem> + +<listitem +><para +><literal +>noEdit</literal +>: tavaliselt võib kasutaja tööriistaribasid oma käe järgi kohandada, näiteks <application +>Konqueror</application +>i puhul menüükäsuga <menuchoice +><guimenu +>Seadistused</guimenu +><guimenuitem +>Tööriistaribade seadistamine</guimenuitem +></menuchoice +>. Kui see on nüüd "tõene" (true), siis ei saa tööriistariba muuta. See on oluline sellistele tööriistaribadele, mis täidetakse käivitamise ajal, näiteks <application +>Konqueror</application +>i järjehoidjariba. </para +></listitem> + +<listitem +><para +><literal +>iconText</literal +>: käsib XMLGUI-l näidata toimingu teksti ikooni kõrval. Tavaliselt näidatakse teksti ainult kohtspikrina, kui jätta hiirekursor mõneks hetkeks ikooni kohale seisma. Võimalikud väärtused on "icononly" (näidatakse ainult ikooni), "textonly" (näidatakse ainult teksti), "icontextright" (teksti näidatakse ikoonist paremal pool) ja "icontextbottom" (teksti näidatakse ikooni all). </para +></listitem> + + +<listitem +><para +><literal +>hidden</literal +>: kui see on "tõene" (true), ei ole tööriistariba algselt nähtaval ja selle aktiveerimiseks tuleb kasutada mingit menüüelementi. </para +></listitem> + + +<listitem +><para +><literal +>position</literal +>: selle atribuudi vaikeväärtus on "top", mis tähendab,. et tööriistariba asub menüüriba all. Paljude tööriistadega rakenduste korral, näiteks graafikarakendused, võib olla mõttekas määrata selle asemel asukohaks "left" (vasakul), "right" (paremal) või "bottom" (all). </para +></listitem> + +</itemizedlist> + +</simplesect> + + +<simplesect id="xmlgui-dynamical"> +<title +>Dünaamilised menüüd</title> + +<para +>On ilmne, et XML saab sisaldada ainult kasutajaliidese staatilist kirjeldust. Sageli esineb aga menüüsid, mis käivitamisel muutuvad. Näiteks <application +>Konqueror</application +>i menüü <guimenu +>Asukoht</guimenu +> sisaldab rea elemente <guimenuitem +>Ava kasutades XXX</guimenuitem +>, kus XXX asemel seisab rakendus, mis võib antud MIME tüübiga faili avada. Dokumendi muutumisel muutub ka nende menüüelementide nimekiri. XMLGUI suudab selliste juhtumitega toime tulla niinimetatud <emphasis +>toimingunimekirjadega</emphasis +>. XML-failis deklareeritakse toimingunimekiri ühe elemendina, kuid see sisaldab mitu toimingut, mis lisatakse menüüsse käivitamisel. Meie toodud näide teostatakse <application +>Konqueror</application +>i XML-failis järgmise deklaratsiooniga: </para> + +<programlisting +><Menu name="file"> + <text>&amp;Location</text> + ... + <ActionList name="openwith"> + ... +</Menu> +</programlisting> + +<para +>Näidatavate toimingute lisamiseks kasutatakse siin funktsiooni <function +>KXMLGUIClient::plugActionList()</function +>, eemaldamiseks aga funktsiooni <function +>KXMLGuiClient::unplugActionList()</function +>. Uuendamisrutiin näeb välja selline: </para> + +<programlisting +>void MainWindow::updateOpenWithActions() +{ + unplugActionList("openwith"); + openWithActions.clear(); + for ( /* iterate over the relevant services */ ) { + KAction *action = new KAction( ...); + openWithActions.append(action); + } + plugActionList("openwith", openWithActions); +} +</programlisting> + +<para +>Pane tähele, et erinevalt staatilistest toimingutest <emphasis +>ei ole</emphasis +> need loodud eellasest toimingukogu baasil ja sestab tuleb sul endal nende kustutamise eest hoolt kanda. Lihtsaim viis selleks on kasutada - nagu ülaltoodud näites - <literal +>openWithActions.setAutoDelete(true)</literal +>. </para> + +</simplesect> + + +<simplesect id="xmlgui-contextmenus"> +<title +>Kontekstimenüüd</title> + +<para +>Toodud näidetes oli tegemist ainult peaakna menüüriba ja tööriistaribade loomisega. Sellisel juhul on nende loomise protsess kasutaja eest täielikult peidetud väljakutse <function +>createGUI()</function +> taha (kui sul pole just kohandatud konteinereid). Kuid võib esineda juhtumeid, kus soovid konstrueerida muid konteinereid ja täita need XML-failist võetavate GUI definitsioonidega. Üheks näiteks võivad olla kontekstimenüüd. Kontekstimenüü viida saamiseks tuleb seda küsida kliendi "tehaselt" (factory): </para> + +<programlisting +>void MainWindow::popupRequested() +{ + QWidget *w = factory()->container("context_popup", this); + QPopupMenu *popup = static_cast<QPopupMenu *>(w); + popup->exec(QCursor::pos()); +} +</programlisting> + +<para +>Meetod <function +>KXMLGUIFactory::container()</function +> püüab leida XML-failis antud nimega konteinerit. Seega võib definitsioon välja näha näiteks nii: </para> + +<programlisting +>... +<Menu name="context_popup"> + <Action name="file_add"/> + <Action name="file_remove"/> +</Menu> +... +</programlisting> + +</simplesect> + +</sect1> + + +<sect1 id="help"> +<title +>Abivõimaluste pakkumine</title> + +<para +>Rakenduse muutmine hõlpsasti kasutatavaks ja arusaadavaks tähendab ka mitmesuguste kasutajat abistavate võimaluste pakkumist. Sellel on mitu, omavahel osaliselt vastuolulist eesmärki: ühelt poolt peab see andma vastuse kasutaja küsimusele "Kuidas ma seda teha saan?", teiselt poolt aga aitama kasutajal rakendust tundma õppida ja avastada võimalusi, mille olemasolugi ta varem ei teadnud. Seepärast on oluline tähele panna, et mõlema sihi saavutamiseks on äärmiselt mõttekas pakkuda abi korraga mitmel tasandil: </para> + +<itemizedlist> + +<listitem +><para +>Kohtspikrid on pisikesed aknakesed, mis ilmuvad kasutajaliidese elementide juurde, kui jätta hiirekursor mõneks hetkeks elemendil peatuma. Need on eriti tähtsad tööriistaribade puhul, kus ainuüksi ikoon ei pruugi alati piisavalt selgelt vihjata, milleks on mingi nupp mõeldud. </para +></listitem> + +<listitem +><para +>Võimalus "Mis see on?" sisaldab tavaliselt pikemat ja põhjalikumat seletust vidina või menüükirje kohta. Samas on selle kasutamine veidi keerulisem. Näiteks dialoogides saab seda esile kutsuda kahel viisil: vajutades <keycombo +><keycap +>Shift</keycap +><keycap +>F1</keycap +></keycombo +> või klõpsates küsimärgile tiitliribal (kas küsimärk seal ka asub, sõltub küll tugevasti kasutatavast aknahaldurist). Hiirekursor muutub siis küsimärgiga nooleks ning mingile elemendile klõpsates ilmub väike abiaken. Menüüelementide korral saab võimaluse "Mis see on?" tavaliselt aktiveerida klõpsuga tööriistaribal asuvale noole ja küsimärgiga nupule. </para +></listitem> + +<listitem +><para +>Selle võimaluse miinuseks on aga asjaolu, et kasutajal pole võimalik ette teada, kas teda huvitava vidina kohta on selline abi olemas või mitte. Kui nüüd küsimärginupule klõpsata ja elemendi kohta ikkagi mingit abi ei ole, võib see tasapisi tekitada tugevat rahulolematust. </para> + +<para +>Tänu Qt ja KDE võimalustele saab aga "Mis see on?`" abiaken sisaldada <ulink url="kdeapi:qt/QStyleSheet" +>vormindatud teksti</ulink +>, see tähendab, võib pakkuda erinevaid fonte, rasvast ja kaldkirja või isegi pilte ja tabeleid. </para> + +<para +>"Mis see on?" näide: </para> + +<mediaobject> +<imageobject +><imagedata fileref="whatsthis.png"/></imageobject> +</mediaobject> + +</listitem> + +<listitem +><para +>Lõpuks peaks igal rakendusel olema ka oma käsiraamat. Tavaliselt näitab seda <application +>KDE abikeskus</application +>, mille saab avada menüüst <guimenu +>Abi</guimenu +>. See tähendab, et avatakse täiesti omaette rakendus, mis viib kasutaja fookuse rakenduselt eemale. Seetõttu tuleks arvestada, et käsiraamatu järele tekib vajadus ennekõike siis, kui kohtspikrid või "Mis see on?" ei suuda kasutajat abistada. Muidugi on käsiraamatu eelis selles, et see ei piirdu kasutajaliidese üksiku ja isoleeritud aspekti seletamisega, vaid tutvustab rakendust tervikuna. KDE käsiraamatud pannakse kirja <ulink url="http://i18n.kde.org" +>DocBook</ulink +> märkekeeles. </para +></listitem> + +</itemizedlist> + +<para +>Programmeerija vaatevinklist pakub Qt abi pakkumiseks välja hõlpsasti kasutatava API. Kohtspikri lisamiseks vidinale tarvita klassi <ulink url="kdeapi:qt/QToolTip" +>QToolTip</ulink +>. </para> + +<programlisting +>QToolTip::add(w, i18n("This widget does something.")) +</programlisting> + +<para +>Kui menüü- ja tööriistaribad luua <ulink url="actionpattern.html" +>toimingumustreid</ulink +> kasutades, võetakse kohtspikrina kasutatav string konstruktori <ulink url="kdeapi:tdeui/KAction.html" +>KAction</ulink +> esimesest argumendist: </para> + +<programlisting +>action = new KAction(i18n("&Delete"), "editdelete", + SHIFT+Key_Delete, actionCollection(), "del") +</programlisting> + +<para +>Siin on küll ka võimalik anda tekst, mida näidatakse antud menüükirje esiletõstmisel olekuribal: </para> + +<programlisting +>action->setStatusText(i18n("Deletes the marked file")) +</programlisting> + +<para +>"Mis see on?" API on äärmiselt sarnane. Dialoogide korral kasuta sellist koodi: </para> + +<programlisting +>QWhatsThis::add(w, i18n("<qt>This demonstrates <b>Qt</b>'s" + " rich text engine.<ul>" + "<li>Foo</li>" + "<li>Bar</li>" + "</ul></qt>")) +</programlisting> + +<para +>Menüükirjete korral aga </para> + +<programlisting +>action->setWhatsThis(i18n("Deletes the marked file")) +</programlisting> + +<para +><application +>KDE abikeskus</application +>e väljakutsumine on kapseldatud klassi <ulink url="kdeapi:tdecore/KApplication" +>KApplication</ulink +>. Rakenduse käsiraamatu näitamiseks kasuta </para> + +<programlisting +>kapp->invokeHelp() +</programlisting> + +<para +>See avab esimese, sisukorraga lehekülje. Kui soovid lasta näidata ainult kindlat käsiraamatu osa, tuleb funktsioonile <function +>invokeHelp()</function +> anda täiendav argument, mis määrab ankru, kuhu hüpata. </para> + +</sect1> + +</chapter> + + + +<chapter id="components"> +<title +>Komponendid ja teenused</title> + +<sect1 id="components-services"> +<title +>KDE teenused</title> + +<simplesect id="services-whatarekdeservices"> +<title +>Mis on KDE teenused?</title> + +<para +>KDE moodularhitektuuris on mõistel <emphasis +>teenus</emphasis +> keskne koht. See mõiste ei ole jäigalt seotud mingi konkreetse tehnilise teostusega - teenus võib olla plugin jagatud teegi näol või siis programm, mida juhitakse <ulink url="dcop.html" +>DCOP</ulink +> vahendusel. Oma <emphasis +>teenusetüübiga</emphasis +> lubab teenus teostada teatud konkreetse API või võimaluse. C++ tähenduses võib teenusetüüpi pidada abstraktseks klassiks ja teenust ennast selle liidese teostuseks. </para> + +<para +>Sellise eraldamise eelised on ilmsed: teenusetüüpi kasutaval rakendusel pole vajadust teada, kuidas see teostatakse, ta kasutab lihtsalt antud teenusetüübiga seotud API-t. Sel moel võib kasutatavat teenust muuta ilma rakendust kuidagi mõjutamata. Samuti on kasutajal võimalik ise määrata, milliseid teenuseid ta teatud võimaluste jaoks eelistab. </para> + +<para +>Mõned näited: </para> + +<itemizedlist> + +<listitem +><para +><application +>Konqueror</application +>is kasutatav HTML-i renderdusmootor on põimitav komponent, mis teostab teenusetüübid <literal +>KParts/ReadOnlyPart</literal +> ja <literal +>Browser/View</literal +>. </para +></listitem> +<listitem +><para +><application +>KDevelop</application +>is on enamik võimalusi esitatud pluginatena teenusetüübiga <literal +>KDevelop/Part</literal +>. Käivitamisel laetakse kõik selle tüübiga teenused, mis võimaldab IDE-d väga paindlikult laiendada. </para +></listitem> +<listitem +><para +>Ikoonivaates näitab <application +>Konqueror</application +> (kui see on lubatud) piltide, HTML-lehekülgede, PDF- ja tekstifailide pisipilte. Ka seda võimalust on võimalik laiendada. Kui soovid lasta näidata oma teatud MIME tüübiga andmefailide eelvaatluse pilte, tuleb teostada teenus tüübiga <classname +>ThumbCreator</classname +>. </para +></listitem> + +</itemizedlist> + +<para +>On ilmne, et teenust ei iseloomusta ainult teenusetüüp, mida ta teostab, vaid ka mõningad <emphasis +>omadused</emphasis +>. Näiteks ThumbCreator ei teosta mitte ainult C++ klassi tüübiga <classname +>ThumbCreator</classname +>, vaid sisaldab ka MIME tüüpide nimekirja, mille puhul eelvaatlust pakkuda. KDevelopi komponentidel on omaduseks programmeerimiskeel, mida nad toetavad. Kui rakendus soovib kasutada teatud teenusetüüpi, võib ta ühtlasi anda teenuse omaduste piirangute nimekirja. Toodud näite korral küsib KDevelop Java projekti tarbeks pluginaid laadides ainult selliseid pluginaid, mille omaduseks on Java programmeerimiskeel. Sellisteks puhkudeks pakub KDE võimsat ja võimalusterohke päringukeelega CORBA-sarnast börsi (<emphasis +>trader</emphasis +>). </para> + +</simplesect> + + +<simplesect id="services-definingservicetypes"> +<title +>Teenusetüüpide defineerimine</title> + +<para +>Uusi teenusetüüpe lisatakse nende kirjeldust kataloogi <filename +>KDEDIR/share/servicetypes</filename +> paigaldades. KDE automake-raamistikus saab seda teha sellise <filename +>Makefile.am</filename +> koodijupiga: </para> + +<programlisting +>kde_servicetypesdir_DATA = tdeveloppart.desktop +EXTRA_DIST = $(kde_servicetypesdir_DATA) +</programlisting> + +<para +><application +>KDevelop</application +>i komponendi definitsioon <filename +>tdeveloppart.desktop</filename +> näeb välja selline: </para> + +<programlisting +>[Desktop Entry] +Type=ServiceType +X-KDE-ServiceType=KDevelop/Part +Name=KDevelop Part + +[PropertyDef::X-KDevelop-Scope] +Type=QString + +[PropertyDef::X-KDevelop-ProgrammingLanguages] +Type=QStringList + +[PropertyDef::X-KDevelop-Args] +Type=QString +</programlisting> + +<para +>Lisaks tavapärastele kirjetele on toodud näites näha, kuidas deklareerida teenuse omadusi. Igale omaduse definitsioonile vastab konfiguratsioonifailis grupp <literal +>[PropertyDef::name]</literal +>. Selles grupis deklareerib kirje <literal +>Type</literal +> omaduse tüübi. Võimalikud tüübid on kirjas klassis <ulink url="kdeapi:qt/QVariant" +>QVariant</ulink +>. </para> + +</simplesect> + + +<simplesect id="services-defininglibraryservices"> +<title +>Jagatud teegi teenuste defineerimine</title> + +<para +>Teenuste definitsioonid on salvestatud kataloogi <filename +>KDEDIR/share/services</filename +>: </para> + +<programlisting +>kde_servicesdir_DATA = kdevdoxygen.desktop +EXTRA_DIST = $(kde_servicesdir_DATA) +</programlisting> + +<para +>Järgnev näitefail <filename +>kdevdoxygen.desktop</filename +> defineerib plugina <literal +>KDevDoxygen</literal +> tüübiga <literal +>KDevelop/Part</literal +>: </para> + +<programlisting +>[Desktop Entry] +Type=Service +Comment=Doxygen +Name=KDevDoxygen +ServiceTypes=KDevelop/Part +X-KDE-Library=libkdevdoxygen +X-KDevelop-ProgrammingLanguages=C,C++,Java +X-KDevelop-Scope=Project +</programlisting> + +<para +>Lisaks tavalistele deklaratsioonidele pööra tähelepanu kirjele <literal +>X-KDE-Library</literal +>. See sisaldab libtool'i teegi nime (ilma laiendita <literal +>.la</literal +>). Ühtlasi fikseerib see (eesliitega <literal +>init_</literal +>) eksporditava sümboli nime teegis, mis tagastab objektipere. Toodud näites peab teek sisaldama järgmist funktsiooni: </para> + +<programlisting +>extern "C" { + void *init_libkdevdoxygen() + { + return new DoxygenFactory; + } +}; +</programlisting> + +<para +>Pere klassi <classname +>DoxygenFactory</classname +> tüüp sõltub konkreetsest teenusetüübist, mida teenus teostab. Meie KDevelopi plugina näites peab pere olema <classname +>KDevFactory</classname +> (mille eellane on <classname +>KLibFactory</classname +>). Levinum näide on <ulink url="kdeapi:kparts/KParts::Factory" +>KParts::Factory</ulink +>, mis peaks pakkuma <ulink url="kdeapi:kparts/KParts::ReadOnlyPart" +>KParts::ReadOnlyPart</ulink +> või enamikul juhtudel üldisem <ulink url="kdeapi:tdecore/KLibFactory" +>KLibFactory</ulink +>. </para> + +</simplesect> + + +<simplesect id="services-usinglibraryservices"> +<title +>Jagatud teekide teenuste kasutamine</title> + +<para +>Jagatud teegi teenuse kasutamiseks rakenduses tuleb hankida seda esindav <ulink url="kdeapi:kio/KService.html" +>KService</ulink +> objekt. Sellest räägitakse pikemalt <ulink url="mime.html" +>MIME tüüpe tutvustavas osas</ulink +> (samuti ikka veel kirjutamata osas KTraderi kohta). </para> + +<para +><classname +>KService</classname +> objekti olemasolul on väga lihtne laadida teek ja hankida viit selle pere objektile: </para> + +<programlisting +>KService *service = ... +QString libName = QFile::encodeName(service->library()); +KLibFactory *factory = KLibLoader::self()->factory(libName); +if (!factory) { + QString name = service->name(); + QString errorMessage = KLibLoader::self()->lastErrorMessage(); + KMessageBox::error(0, i18n("There was an error loading service %1.\n" + "The diagnostics from libtool is:\n%2") + .arg(name).arg(errorMessage); +} +</programlisting> + +<para +>Siit edasi sõltub kõik taas teenusetüübist. Tavalise plugina korral tuleb luua objektid meetodiga <ulink url="kdeapi:tdecore/KLibFactory.html#ref3" +>KLibFactory::create()</ulink +>. KPartsi korral tuleb kogumiviit suunata konkreetsemale KParts::Factory ja kasutada selle create() meetodit: </para> + +<programlisting +>if (factory->inherits("KParts::Factory")) { + KParts::Factory *partFactory = static_cast<KParts::Factory*>(factory); + QObject *obj = partFactory->createPart(parentWidget, widgetName, + parent, name, "KParts::ReadOnlyPart"); + ... +} else { + cout << "Service does not implement the right factory" << endl; +} +</programlisting> + +</simplesect> + + +<simplesect id="services-definingdcopservices"> +<title +>DCOP-teenuste defineerimine</title> + +<para +>DCOP-teenus on tavaliselt teostatud programmina, mis käivitub vajaduse korral. Sellisel juhul loob ta silmuse ja jälgib DCOP-ühendusi. Programm võib olla interaktiivne, kuid see võib ka täielikult või osaliselt tegutseda taustal deemonina, ilma et kasutaja seda otseselt märkaks. Sellise deemoni näide on <literal +>kio_uiserver</literal +>, mis teostab kasutaja suhtlust, näiteks KIO teegi edenemisdialoogi. Antud kontekstis on tsentraliseeritud deemoni eeliseks näiteks see, et mitme erineva faili tõmbamise edenemist saab näidata ühes aknas isegi juhul, kui tõmbamine käivitati erinevatest rakendustest. </para> + +<para +>DCOP-teenus defineeritakse teisiti kui jagatud teegi teenus. Loomulikult ei määra see teeki, vaid käivitatava faili. Samuti ei määra DCOP-teenused rida ServiceType, sest tavaliselt käivitatakse nad nimepidi. Lisaomadustena on selles kaks rida: </para> + +<para +><literal +>X-DCOP-ServiceType</literal +> määrab viisi, kuidas teenus käivitatakse. Väärtus <literal +>Unique</literal +> sedastab, et teenust saab käivitada vaid ühekordsena. See tähendab, et kui proovid teenust käivitada (nt. <ulink url="kdeapi:tdecore/KApplication.html#startServiceByName" +> KApplication::startServiceByName()</ulink +> vahendusel), uurib KDE, kas see on juba registreeritud DCOP-iga ja kasutab töötavat teenust. Kui see ei ole veel registreeritud, käivitab KDE selle ja ootab registreerimist. Nii saab teenusele kohe saata DCOP-väljakutseid. Sellisel juhul peab teenus olema teostatud kui <ulink url="kdeapi:tdecore/KUniqueApplication.html" +>KUniqueApplication</ulink +>. </para> + +<para +>Väärtus <literal +>Multi</literal +> teatab <literal +>X-DCOP-ServiceType</literal +> korral, et korraga võib töötada mitu teenuse eksemplari, nii et iga katse teenust käivitada loob uue protsessi. Viimaks võib kasutada ka väärtust <literal +>None</literal +>. Sellisel juhul ei oodata teenuse käivitamisel registreerimist DCOP-iga. </para> + +<para +><literal +>X-KDE-StartupNotify</literal +> peaks üldjuhul olema määratud vääraks (false). Kui see nii ei ole, näitab tegumiriba programmi käivitumisel käivitusteadet või, kui kasutaja on nii määranud, muutub kursori kuju. </para> + +<para +>Selline on <literal +>kio_uiserver</literal +> definitsioon: </para> + +<programlisting +>[Desktop Entry] +Type=Service +Name=kio_uiserver +Exec=kio_uiserver +X-DCOP-ServiceType=Unique +X-KDE-StartupNotify=false +</programlisting> + +</simplesect> + + +<simplesect id="services-usingdcopservices"> +<title +>DCOP-teenuste kasutamine</title> + +<para +>DCOP-teenus käivitatakse mõne klassi KApplication meetodiga: </para> + +<programlisting +>DCOPClient *client = kapp->dcopClient(); +client->attach(); +if (!client->isApplicationRegistered("kio_uiserver")) { + QString error; + if (KApplication::startServiceByName("kio_uiserver", QStringList(), &error)) + cout << "Starting kioserver failed with message " << error << endl; +} +... +QByteArray data, replyData; +QCString replyType; +QDataStream arg(data, IO_WriteOnly); +arg << true; +if (!client->call("kio_uiserver", "UIServer", "setListMode(bool)", + data, replyType, replyData)) + cout << "Call to kio_uiserver failed" << endl; +... +</programlisting> + +<para +>Pane tähele, et siin toodud DCOP-väljakutse näide kasutab vahetult argumente. Enamasti on mõttekas tarvitada selle asemel dcopidl2cpp genereeritud väljundit, mis on märksa lihtsam ja veakindlam. </para> + +<para +>Toodud näiteks käivitatakse teenus "nimepidi", s.t. esimene <function +>KApplication::startServiceByName()</function +> argument on nimi, mis on näha töölauafaili real <literal +>Name</literal +>. Teine võimalus on kasutada funktsiooni <function +>KApplication::startServiceByDesktopName()</function +>, mis võtab argumendiks töölauafaili failinime, s.t. antud juhul <literal +>"kio_uiserver.desktop"</literal +>. </para> + +<para +>Kõik väljakutsed kasutavad teise argumendina URL-ide nimekirja, mis antakse teenusele käsureal. Kolmas argument on viit klassile <classname +>QString</classname +>. Kui teenuse käivitamine ebaõnnestub, annab see argument tulemuseks tõlgitud veateate. </para> + +</simplesect> + +</sect1> + + +<sect1 id="components-mime"> +<title +>MIME tüübid</title> + +<simplesect id="mime-whataremimetypes"> +<title +>Mis on MIME tüübid?</title> + +<para +>MIME tüüpe kasutatakse kirjeldamaks failide või andmekogumite sisu tüüpi. Algselt võeti need kasutusele pildi, helifailide jne. saatmiseks e-postitsi (MIME tähendabki "mitmeotstarbelised e-kirja laiendid", inglise keeles "Multipurpose Internet Mail Extensions"). Hiljem hakati neid kasutama ka veebilehitsejas selle määramiseks, kuidas esitada veebiserverist kasutajale saadetavaid andmeid. Näiteks HTML-leheküljel on MIME tüüp "text/html", PostScript-failil aga "application/postscript". KDE kasutab MIME tüüpe päris paljudes kohtades: </para> + +<itemizedlist> + +<listitem +><para +><application +>Konqueror</application +>i ikoonivaates näitavad faile ikoonid. Iga MIME tüübiga on seotud teatud ikoon, mida siin näidataksegi. </para +></listitem> + +<listitem +><para +>Klõpsates <application +>Konqueror</application +>is faili ikoonile või nimele näidatakse faili põimitud näitajas või avatakse antud failitüübiga seotud rakendus. </para +></listitem> + +<listitem +><para +>Mingeid andmeid ühest rakendusest teise (või ka ühe rakenduse sees) lohistades võib sihtkoht aktsepteerida ainult teatud andmetüüpe. Samuti käsitletakse pildiandmeid tekstiandmetest erinevalt. </para +></listitem> + +<listitem +><para +>Lõikepuhvri andmetel on samuti MIME tüüp. Tavapäraselt suudavad X'i programmid käsitleda ainult pilte või teksti, kuid Qt abil ei ole andmetüübid piiratud. </para +></listitem> + +</itemizedlist> + +<para +>Toodud näidetest peaks selguma, et MIME käsitlemine on päris keerukas. Esmalt on vaja luua failinimede seosed MIME tüüpidega. KDE astub veel sammukese edasi ja lubab isegi faili sisu MIME tüübiga siduda, kui näiteks failinimi ei peaks kättesaadav olema. Teiseks tuleb MIME tüübid siduda rakenduste või teekidega, mis suudavad teatud tüüpi faili näidata või redigeerida või sellele pisipildi luua. </para> + +<para +>Andmete või failide MIME tüübi selgitamiseks on mitmeid API-sid. Üldiselt tähendavad nad kõik teatud kompromissi kiiruse ja usaldusväärsuse vahel. Failitüübi võib leida ainult failinime vaadates (s.t. enamikul juhtudel failinime laiendit uurides). Näiteks <filename +>foo.jpg</filename +> on tavaliselt "image/jpeg". Kui laiendit ei ole, pole see meetod mõistagi eriti turvaline ja tuleb vaadata faili sisu. See on loomulikult aeglasem, eriti failide korral, mida tuleb HTTP abil kõigepealt alla laadida. Sisupõhine meetod tugineb failile <filename +>KDEDIR/share/mimelnk/magic</filename +>, mida siinkohal on keerukas pikemalt käsitleda. Kuid üldiselt saab MIME tüübi info süsteemile suhteliselt lihtsalt teatavaks teha <literal +>.desktop</literal +>-faili paigaldades ning seda kasutatakse agaralt ja tõhusalt kõigis KDE teekides. </para> + +</simplesect> + + +<simplesect id="mime-definingmimetypes"> +<title +>MIME tüüpide defineerimine</title> + +<para +>Defineerime oma uuele programmile <application +>foobar</application +> tüübi <literal +>"application/x-foo"</literal +>. Selleks tuleb kirjutada fail <filename +>foo.desktop</filename +> ja paigaldada see kataloogi <filename +>KDEDIR/share/mimelnk/application</filename +> (see on tavapärane asukoht, mis distributsiooniti võib siiski erineda). Selleks tuleb failile <filename +>Makefile.am</filename +> lisada: </para> + +<programlisting +>mimedir = $(kde_mimedir)/application +mime_DATA = foo.desktop +EXTRA_DIST = $(mime_DATA) +</programlisting> + +<para +>Fail <filename +>foo.desktop</filename +> peaks välja nägema selline: </para> + +<programlisting +>[Desktop Entry] +Type=MimeType +MimeType=application/x-foo +Icon=fooicon +Patterns=*.foo; +DefaultApp=foobar +Comment=Foo Data File +Comment[et]=Foo andmefail +</programlisting> + +<para +>Kirje <literal +>"Comment"</literal +> on mõeldud tõlkimiseks. Et <filename +>.desktop</filename +>-fail määrab ka ikooni, tuleb paigaldada ikoon <filename +>fooicon.png</filename +>, mis näitab faili näiteks <application +>Konqueror</application +>is. </para> + +<para +>KDE teekides on selline tüübidefinitsioon seotud <ulink url="kdeapi:kio/KMimeType.html" +>KMimeType</ulink +> eksemplariga. Kasuta seda umbes nii, nagu alljärgnevas näites: </para> + +<programlisting +>KMimeType::Ptr type = KMimeType::mimeType("application/x-foo"); +cout << "Type: " << type->name() < endl; +cout << "Icon: " << type->icon() < endl; +cout << "Comment: " << type->icon() < endl; +QStringList patterns = type->patterns(); +QStringList::ConstIterator it; +for (it = patterns.begin(); it != patterns.end(); ++it) + cout << "Pattern: " << (*it) << endl; +</programlisting> + +</simplesect> + + +<simplesect id="mime-determiningmimetypes"> +<title +>Andmete MIME tüübi määramine</title> + +<para +>Kiire meetod failitüübi määramiseks on <function +>KMimeType::findByURL()</function +>. See otsib URL-i stringi ja enamasti määrab tüübi laiendi põhjal. Teatud protokollide (nt. http, man, info) korral seda aga ei kasutata. Näiteks Perlis kirjutatud veebiserverite CGI skriptidel on sageli laiend <literal +>.pl</literal +>, mis osutab tüübile <literal +>"text/x-perl"</literal +>. Samas on serveri edastatud fail hoopis selle skripti väljund, milleks on enamasti HTML. Sellisel juhul tagastab <function +>KMimeType::findByURL()</function +> MIME tüübi <literal +>"application/octet-stream"</literal +> (kasutatav <function +>KMimeType::defaultMimeType()</function +> vahendusel), mis osutab võimetusele tüüpi tuvastada. </para> + +<programlisting +>KMimeType::Ptr type = KMimeType::findByURL("/home/bernd/foobar.jpg"); +if (type->name() == KMimeType::defaultMimeType()) + cout << "Could not find out type" << endl; +else + cout << "Type: " << type->name() << endl; +</programlisting> + +<para +>(sellel meetodil on veel mõningaid argumente, kuid need on dokumenteerimata, mistõttu võib nad antud juhul kõrvale jätta) </para> + +<para +>Sellisel juhul võib olla mõttekam tuvastada MIME tüüp faili sisu, mitte aga faili nime järgi. See on usaldusväärsem, kuid ka aeglasem meetod, sest selleks tuleb lugeda vähemalt osa failist. Seda teeb klass <ulink url="kdeapi:kio/KMimeMagic.html" +>KMimeMagic</ulink +>, mille veakäsitlus on veidi teistsugune: </para> + +<programlisting +>KMimeMagicResult *result = KMimeMagic::self()->findFileType("/home/bernd/foobar.jpg"); +if (!result || !result->isValid()) + cout << "Could not find out type" << endl; +else + cout << "Type: " << result->mimeType() << endl; +</programlisting> + +<para +>Selle funktsiooni variant võimaldab määrata ka mälutüki tüüpi. Seda kasutab näiteks <application +>Kate</application +> esiletõstmise režiimi tuvastamiseks: </para> + +<programlisting +>QByteArray array; +... +KMimeMagicResult *result = KMimeMagic::self()->findBufferType(array); +if (!result || !result->isValid()) + cout << "Could not find out type" << endl; +else + cout << "Type: " << result->mimeType() << endl; +</programlisting> + +<para +>Mõistagi suudab isegi KMimeMagic määrata failitüüpi ainult kohalike failide sisu põhjal. Võrgufailide jaoks on veel üks võimalus: </para> + +<programlisting +>KURL url("http://developer.kde.org/favicon.ico"); +QString type = KIO::NetAccess::mimetype(url); +if (type == KMimeType::defaultMimeType()) + cout << "Could not find out type" << endl; +else + cout << "Type: " << type << endl; +</programlisting> + +<para +>See käivitab KIO töö, laadides alla osa failist ja uurides seda. Arvesta, et see funktsioon on tõenäoliselt päris aeglane ja blokeerib programmi töö. Tavaliselt on seda mõtet kasutada ainult siis, kui <function +>KMimeType::findByURL()</function +> tagastab <literal +>"application/octet-stream"</literal +>. </para> + +<para +>Kui sa aga ei soovi rakenduse tööd blokeerida, võib ka vahetult käivitada KIO töö ja luua ühenduse selle mõningate signaalidega: </para> + +<programlisting +>void FooClass::findType() +{ + KURL url("http://developer.kde.org/favicon.ico"); + KIO::MimetypeJob *job = KIO::mimetype(url); + connect( job, SIGNAL(result(KIO::Job*)), + this, SLOT(mimeResult(KIO::Job*)) ); +} + +void FooClass::mimeResult(KIO::Job *job) +{ + if (job->error()) + job->showErrorDialog(); + else + cout << "MIME type: " << ((KIO::MimetypeJob *)job)->mimetype() << endl; +} +</programlisting> + +</simplesect> + + +<simplesect id="mime-mappingmimetypes"> +<title +>MIME tüübi seostamine rakenduse või teenusega</title> + +<para +>Rakenduse paigaldamisel paigaldab see oma <literal +>.desktop</literal +>-faili, mis sisaldab loetelu MIME tüüpidest, mida rakendus suudab avada. Ka komponendid, näiteks KParts, teatavad samasugust infot oma <literal +>.desktop</literal +>-failide vahendusel. Nii on enamasti olemas mitu programmi ja komponenti, mis suudavad antud MIME tüüpi käsitleda. Nende nimekirja võib leida klassist <classname +>KServiceTypeProfile</classname +>: </para> + +<programlisting +>KService::OfferList offers = KServiceTypeProfile::offers("text/html", "Application"); +KService::OfferList::ConstIterator it; +for (it = offers.begin(); it != offers.end(); ++it) { + KService::Ptr service = (*it); + cout << "Name: " << service->name() << endl; +} +</programlisting> + +<para +>Selle funktsiooni tagastatav väärtus ongi pakutavate teenuste nimekiri. <classname +>KServiceOffer</classname +> objekt liidab KService::Ptr eelistuse numbriga. <function +>KServiceTypeProfile::offers()</function +> tagastatav nimekiri on järjestatud vastavalt kasutaja eelistustele. Kasutaja saab seda muuta, kutsudes välja <command +>"keditfiletype text/html"</command +> või valides HTML-faili korral <application +>Konqueror</application +>i kontekstimenüüst kirje <guimenuitem +>Redigeeri failitüüpi</guimenuitem +>. </para> + +<para +>Toodud näites nõuti rakenduste nimekirja, mis toetaks tüüpi <literal +>text/html</literal +>. Nimekiri sisaldab muu hulgas HTML-redaktoreid, näiteks <application +>Quanta</application +>. Teise argumendi <literal +>"Application"</literal +> võib anda ka <literal +>"KParts::ReadOnlyPart"</literal +>. Sellisel juhul tagastatakse põimitavate komponentide nimekiri, mis suudavad HTML-i esitada, näiteks KHTML. </para> + +<para +>Enamasti puudub vajadus saada teada kõiki MIME tüübi ja teenuse tüübi kombinatsiooni käsitleda suutvaid teenuseid. Siis sobib kasutada mugavat funktsiooni, mis tagastab ainult kõige eelistatuma teenuse: </para> + +<programlisting +>KService::Ptr offer = KServiceTypeProfile::preferredService("text/html", "Application"); +if (offer) + cout << "Name: " << service->name() << endl; +else + cout << "No appropriate service found" << endl; +</programlisting> + +<para +>Keerulisemate päringute jaoks on mõeldud võimas CORBA taoline <ulink url="kdeapi:kio/KTrader.html" +>maakler</ulink +>. </para> + +<para +>Rakenduse teenuse käivitamiseks mõne URL-iga on kasutatav <ulink url="kdeapi:kio/KRun.html" +>KRun</ulink +>: </para> + +<programlisting +>KURL::List urlList; +urlList << "http://www.ietf.org/rfc/rfc1341.txt?number=1341"; +urlList << "http://www.ietf.org/rfc/rfc2046.txt?number=2046"; +KRun::run(offer.service(), urlList); +</programlisting> + +</simplesect> + + +<simplesect id="mime-misc"> +<title +>Mitmesugust</title> + +<para +>Selles osas toome ära mõned API-d, mis on teatud määral seotud meie eelneva jutuga. </para> + +<para +>Ikooni hankimine URL-ile. See uurib URL-i tüüpi ja tagastab sellega seotud ikooni. </para> + +<programlisting +>KURL url("ftp://ftp.kde.org/pub/incoming/wibble.c"); +QString icon = KMimeType::iconForURL(url); +</programlisting> + +<para +>URL-i käivitamine. See uurib URL-i tüüpi ja käivitab kasutaja antud tüübi korral eelistatud programmi. </para> + +<programlisting +>KURL url("http://dot.kde.org"); +new KRun(url); +</programlisting> + +</simplesect> + +</sect1> + + +<sect1 id="nettransparency"> +<title +>Võrguläbipaistvus</title> + +<simplesect id="nettransparency-intro"> +<title +>Sissejuhatus</title> + +<para +>Veebiajastul on äärmiselt oluline, et rakendused võiksid kasutada ressursse kõikjal internetis: nad peavad suutma tõmmata faile veebiserverist, salvestada faile FTP serverisse või lugeda veebiserverist e-posti. Tihtipeale nimetatakse sellist võimet kasutada faile sõltumata nende asukohast <emphasis +>võrguläbipaistvuseks</emphasis +>. </para> + +<para +>Minevikus üritati seda saavutada mitmel erineval moel. Eakas NFS failisüsteem proovis teostada võrguläbipaistvust POSIX-i API tasandil. See toimib päris hästi kohalike suletud võrkude korral, kuid jääb jänni ressurssidega, mille kasutamine ei pruugi alati õnnestuda ja ühendus millega võib olla aeglane. Seepärast on oluline <emphasis +>asünkroonsus</emphasis +>: kui ootad, et veebilehitseja laeks alla mingi saidi, ei pea see blokeerima kasutajaliidest. Samuti ei peaks veebilehekülje renderdamine algama alles siis, kui kätte on saadud kogu lehekülg, vaid käima regulaarselt vastavalt uute andmete saabumisele. </para> + +<para +>KDE teekides teostab võrguläbipaistvuse KIO API. Selle arhitektuuri keskne mõiste on IO <emphasis +>töö</emphasis +>. Töö võib faile kopeerida, kustutada vms. Töö käivitamisel tegutseb see taustal ega blokeeri rakendust. Kogu töö tagasiside rakendusele, näiteks andmete edastamine või edenemisinfo, käib läbi integreeritud Qt sündmusesilmuse. </para> + +<para +>Töötamiseks taustal on mõeldud konkreetseid ülesandeid täitvad <emphasis +>IO moodulid</emphasis +>. IO moodulid käivitatakse eraldi protsessidena ja nendega suheldakse UNIX-i domeeni pesade vahendusel. Sel moel ei ole vajalik mitmelõimsus ning ebastabiilsed moodulid ei tekita neid kasutava rakenduse krahhi. </para> + +<para +>Failide asukohti väljendavad tavapäraselt URL-id. KDE puhul aga ei laienda URL-id lihtsalt kättesaadavate failide vahemikku väljapoole kohalikku failisüsteemi, vaid toimivad ka vastupidi, lubades näiteks sirvida pakitud tar-faile. See saavutatakse URL-ide pesastamisega. Nii võib näiteks HTTP-serveris asuval tar-arhiivi failil olla URL </para> + +<programlisting +>http://www-com.physik.hu-berlin.de/~bernd/article.tgz#tar:/paper.tex +</programlisting> + +</simplesect> + + +<simplesect id="nettransparency-usingkio"> +<title +>KIO kasutamine</title> + +<para +>Enamasti luuakse tööd KIO nimeruumis funktsioone välja kutsudes. Need funktsioonid kasutavad argumendina üht või kaht URL-i ja võib-olla vastavalt vajadusele veel mõningaid parameetreid. Kui töö on lõpetatud, väljastatakse signaal <literal +>result(KIO::Job*)</literal +>. Signaali väljastamise järel kustutab töö iseenda. Toome siin tüüpilise kasutamise näite: </para> + +<programlisting +>void FooClass::makeDirectory() +{ + SimpleJob *job = KIO::mkdir(KURL("file:/home/bernd/kiodir")); + connect( job, SIGNAL(result(KIO::Job*)), + this, SLOT(mkdirResult(KIO::Job*)) ); +} + +void FooClass::mkdirResult(KIO::Job *job) +{ + if (job->error()) + job->showErrorDialog(); + else + cout << "mkdir went fine" << endl; +} +</programlisting> + +<para +>Sõltuvalt töö tüübist võib olla vajalik ühenduse loomine ka muude signaalidega. </para> + +<para +>Toome siin ülevaate võimalikest funktsioonidest: </para> + +<variablelist> + +<varlistentry +><term +>KIO::mkdir(const KURL &url, int õigused)</term> +<listitem +><para +>Loob kataloogi, lisavõimalusena teatud õigustega. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::rmdir(const KURL &url)</term> +<listitem +><para +>Eemaldab kataloogi. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::chmod(const KURL &url, int õigused)</term> +<listitem +><para +>Muudab faili õigusi. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::rename(const KURL &src, const KURL &dest, bool overwrite)</term> +<listitem +><para +>Nimetab faili ümber. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::symlink(const QString &target, const KURL &dest, bool overwrite, bool showProgressInfo)</term> +<listitem +><para +>Loob nimeviida. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::stat(const KURL &url, bool showProgressInfo)</term> +<listitem +><para +>Leiab teatud info faili kohta, näiteks suurus, muutmise aeg ja õigused. Info teeb pärast töö lõpetamist teatavaks KIO::StatJob::statResult(). </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::get(const KURL &url, bool reload, bool showProgressInfo)</term> +<listitem +><para +>Edastab andmed URL-ilt. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::put(const KURL &url, int õigused, bool overwrite, bool resume, bool showProgressInfo)</term> +<listitem +><para +>Edastab andmed URL-ile. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::http_post(const KURL &url, const QByteArray &data, bool showProgressInfo)</term> +<listitem +><para +>Postitab andmed. Spetsiaalselt HTTP jaoks. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::mimetype(const KURL &url, bool showProgressInfo)</term> +<listitem +><para +>Püüab leida URL-i MIME tüübi. Tüübi teeb pärast töö lõpetamist teatavaks KIO::MimetypeJob::mimetype(). </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::file_copy(const KURL &src, const KURL &dest, int õigused, bool overwrite, bool resume, bool showProgressInfo)</term> +<listitem +><para +>Kopeerib ühe faili. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::file_move(const KURL &src, const KURL &dest, int õigused, bool overwrite, bool resume, bool showProgressInfo)</term> +<listitem +><para +>Nimetab ümber või liigutab ühe faili. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::file_delete(const KURL &url, bool showProgressInfo)</term> +<listitem +><para +>Kustutab ühe faili. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::listDir(const KURL &url, bool showProgressInfo)</term> +<listitem +><para +>Loetleb kataloogi sisu. Igal uue kirje tuvastamisel väljastatakse signaal KIO::ListJob::entries(). </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::listRecursive(const KURL &url, bool showProgressInfo)</term> +<listitem +><para +>Sarnane funktsiooniga listDir(), kuid rekursiivne. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::copy(const KURL &src, const KURL &dest, bool showProgressInfo)</term> +<listitem +><para +>Kopeerib faili või kataloogi. Kataloogid kopeeritakse rekursiivselt. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::move(const KURL &src, const KURL &dest, bool showProgressInfo)</term> +<listitem +><para +>Liigutab või nimetab ümber faili või kataloogi. </para +></listitem> +</varlistentry> + +<varlistentry +><term +>KIO::del(const KURL &src, bool shred, bool showProgressInfo)</term> +<listitem +><para +>Kustutab faili või kataloogi. </para +></listitem> +</varlistentry> + +</variablelist> + +</simplesect> + + +<simplesect id="nettransparency-direntries"> +<title +>Kataloogikirjed</title> + +<para +>Nii töö KIO::stat() kui ka töö KIO::listDir() tagastavad oma tulemused vastavalt tüübina UDSEntry ja UDSEntryList. Viimane on defineeritud kui QValueList<UDSEntry>. UDS tähendab "universaalne kataloogiteenus" (inglise keeles "Universal Directory Service"). Selle taga seisab põhimõte, et kataloogikirje sisaldab ainult seda infot, mida IO moodul suudab pakkuda. Näiteks ei paku http moodul infot kasutamisõiguste või faili omaniku kohta. UDSEntry on UDSAtom-ite loend. Iga aatom pakub teatud konkreetse infoühiku. See koosneb tüübist, mille on salvestanud m_uds, ning sõltuvalt tüübist kas täisarvulisest väärtusest (m_long) või stringilisest väärtusest (m_str). </para> + +<para +>Praegu on defineeritud järgmised tüübid: </para> + +<itemizedlist> + +<listitem +><para +>UDS_SIZE (täisarv) - faili suurus. </para +></listitem> + +<listitem +><para +>UDS_USER (string) - faili omav kasutaja. </para +></listitem> + +<listitem +><para +>UDS_GROUP (string) - faili omav grupp. </para +></listitem> + +<listitem +><para +>UDS_NAME (string) - failinimi. </para +></listitem> + +<listitem +><para +>UDS_ACCESS (täisarv) - faili kasutamise õigused, nagu need on salvestanud näiteks libc funktsioon stat() väljal st_mode. </para +></listitem> + +<listitem +><para +>UDS_FILE_TYPE (täisarv) - faili tüüp, nagu selle on salvestanud näiteks stat() väljal st_mode. Seepärast saab selle väärtuse testimiseks kasutada tavalisi libc makrosid, näiteks S-ISDIR. Arvesta, et IO moodulite pakutud andmed vastavad sellele, mida sisaldab stat(), mitte aga lstat(), nii et näiteks nimeviida korral on failitüüp selle faili tüüp, millele viit osutab, mitte aga viit ise. </para +></listitem> + +<listitem +><para +>UDS_LINK_DEST (string) - nimeviida puhul viidatud faili nimi. </para +></listitem> + +<listitem +><para +>UDS_MODIFICATION_TIME (täisarv) - aeg (nagu tüübis time_t), millal faili viimati muudeti, nagu selle on salvestanud näiteks stat() väljal st_mtime. </para +></listitem> + +<listitem +><para +>UDS_ACCESS_TIME (täisarv) - aeg, millal faili viimati kasutati, nagu selle on salvestanud näiteks stat() väljal st_atime. </para +></listitem> + +<listitem +><para +>UDS_CREATION_TIME (täisarv) - faili loomise aeg, nagu selle on salvestanud näiteks stat() väljal st_ctime. </para +></listitem> + +<listitem +><para +>UDS_URL (string) - faili URL, kui see ei ole lihtsalt kataloogi URL-i ja failinime ühend. </para +></listitem> + +<listitem +><para +>UDS_MIME_TYPE (string) - faili MIME tüüp </para +></listitem> + +<listitem +><para +>UDS_GUESSED_MIME_TYPE (string) - faili MIME tüüp, nagu seda arvab moodul. Erinevus eelmise tüübiga seisneb selles, et siinpakutut ei tohiks võtta usaldusväärsena (sest selle määramine usaldusväärsel meetodil on liiga kulukas). Näiteks klass KRun kontrollib vahetult MIME tüüpi, kui tal ei ole usaldusväärset infot. </para +></listitem> + +</itemizedlist> + +<para +>Kuigi failiinfo salvestamise viis klassis <classname +>UDSEntry</classname +> on paindlik ja praktiline IO mooduli seisukohalt vaadates, on see rakenduse programmeerija vaatevinklist korralik segadik. Näiteks faili MIME tüübi tuvastamiseks tuleb ükshaaval läbi uurida kõik aatomid ja kontrollida, kas <literal +>m_uds</literal +> on ikka <literal +>UDS_MIME_TYPE</literal +>. Õnneks on olemas API, mida on palju lihtsam kasutada: klass <classname +>KFileItem</classname +>. </para> + +</simplesect> + + +<simplesect id="nettransparency-syncuse"> +<title +>Sünkroonne kasutamine</title> + +<para +>Sageli on KIO asünkroonne API liiga keerukas kasutada, seepärast ei ole ka täieliku asünkroonsuse teostamine esmatähtis. Näiteks programmi korral, mus suudab korraga käsitleda ainult üht dokumenti, ei ole nagunii midagi teha, kui programm parajasti dokumenti alla laeb. Sellistel lihtsatel juhtudel on olemas märksa lihtsam API staatiliste funktsioonide kogumi näol KIO::NetAccess-is. Näiteks faili kopeerimiseks kasuta: </para> + +<programlisting +>KURL source, target; +source = ...; +target = ... +KIO::NetAccess::copy(source, target); +</programlisting> + +<para +>See funktsioon tagastab pärast terve kopeerimisprotsessi lõpetamist. Siiski pakub see meetod edenemisdialoogi ja kontrollib, et rakendus töötleb ümberjoonistamissündmusi. </para> + +<para +>Eriti huvitav funktsioonide kombinatsioon o <function +>download()</function +> koos funktsiooniga <function +>removeTempFile()</function +>. Esimene tõmbab määratud URL-iga faili ja salvestab selle unikaalse nimega ajutise failina. Nimi salvestatakse teise argumendina. <emphasis +>Kui</emphasis +> tegemist on kohaliku URL-iga, faili alla ei laeta ja teiseks argumendiks määratakse kohaliku faili nimi. Funktsioon <function +>removeTempFile()</function +> kustutab argumendina antud faili, kui see on varasema allalaadimise tulemus. Kui mitte, siis ei tee see midagi. Nii on sellise kombinatsiooni abil väga hea laadida faile alla sõltumata nende asukohast järgmise koodijupiga: </para> + +<programlisting +>KURL url; +url = ...; +QString tempFile; +if (KIO::NetAccess::download(url, tempFile) { + // load the file with the name tempFile + KIO::NetAccess::removeTempFile(tempFile); +} +</programlisting> + +</simplesect> + + +<simplesect id="nettransparency-metadata"> +<title +>Metaandmed</title> + +<para +>Nagu eespool nägime, on IO tööde liides üpris abstraktne ega võta arvesse infovahetust rakenduse ja IO mooduli vahel, mis on protokollipõhine. Alati selline lähenemine ei sobi. Näiteks võid soovida anda HTTP moodulile teatud parameetrid kontrollimaks puhvri käitumist või saata koos sooviga kimbu küpsiseid. Selleks on sisse toodud metaandmed. Töö loomisel saab seda seadistada metaandmeid lisades. Iga metaandmete ühik sisaldab võtme-väärtuse paari. Näiteks selleks, et HTTP moodul ei laeks veebilehekülge puhvrist, võib kasutada: </para> + +<programlisting +>void FooClass::reloadPage() +{ + KURL url("http://www.tdevelop.org/index.html"); + KIO::TransferJob *job = KIO::get(url, true, false); + job->addMetaData("cache", "reload"); + ... +} +</programlisting> + +<para +>Sama meetodit saab kasutada ka teistpidi, s.t. moodulilt rakendusele suunduva suhtlemise korral. Meetod <function +>Job::queryMetaData()</function +> pärib mooduli edastatud võtme väärtust. HTTP mooduli korral võib näiteks olla võti <literal +>"modified"</literal +>, mis sisaldab (stringi kujul) kuupäeva, millal veebilehekülge viimati muudeti. Toome ka kasutamisnäite: </para> + +<programlisting +>void FooClass::printModifiedDate() +{ + KURL url("http://developer.kde.org/documentation/kde2arch/index.html"); + KIO::TransferJob *job = KIO::get(url, true, false); + connect( job, SIGNAL(result(KIO::Job*)), + this, SLOT(transferResult(KIO::Job*)) ); +} + +void FooClass::transferResult(KIO::Job *job) +{ + QString mimetype; + if (job->error()) + job->showErrorDialog(); + else { + KIO::TransferJob *transferJob = (KIO::TransferJob*) job; + QString modified = transferJob->queryMetaData("modified"); + cout << "Last modified: " << modified << endl; +} +</programlisting> + +</simplesect> + + +<simplesect id="nettransparency-scheduling"> +<title +>Ajastamine</title> + +<para +>KIO API kasutamisel ei ole tavaliselt vajalik pead vaevata IO moodulite käivitamise ja nendega suhtlemise üksikasjade pärast. Kõige tavalisem on käivitada töö teatud parameetritega ja tegelda töö väljastatud signaalidega. </para> + +<para +>Tagaplaanil on aga kõik palju keerukam. Tööd luues seatakse see järjekorda. Kui rakendus läheb tagasi sündmusesilmusesse, eraldab KIO mooduliprotsessid järjekorras olevatele töödele. Esimese töö korral on kõik lihtne: käivitatakse vajaliku protokolli IO moodul. Kuid pärast töö lõpetamist (näiteks allalaadimist HTTP-serverilt) ei tapeta tööd otsekohe, vaid see lükatakse jõude moodulite puhvrisse ja tapetakse pärast seda, kui see on olnud mingi aja mitteaktiivne (praegu on väärtuseks 3 minutit). Kui saabub uus soov samale protokollile ja masinale, võetakse moodul uuesti kasutusele. Selle ilmne eelis on tõik, et nii saab tunduvalt kärpida sama masina puhul sarnaseid töid ette võttes muidu uute protsesside loomisele ja võib-olla ka autentimisele kuluvaid ressursse ja aega. </para> + +<para +>Mõistagi on taaskasutamne võimalik ainult siis, kui olemasolev moodul on oma varasema töö juba lõpetanud. Kui uus soov saabub ajal, mil mooduliprotsess veel käib, tuleb käivitada uus protsess. Ülaltoodud API näiteks ei olnud piiratud uute mooduliprotsesside loomine: kui käivitad järjest 20 erineva faili allalaadimise, käivitab KIO 20 mooduliprotsessi. Sellist moodulite omistamist töödele nimetatakse <emphasis +>vahetuks</emphasis +> omistamiseks. See ei ole aga mitte alati eelistatav viis, sest võib nõuda hulganisti mälu ja koormata tugevasti nii kliendi kui serveri masinat. </para> + +<para +>Seepärast on olemas ka teine võimalus: töid saab <emphasis +>ajastada</emphasis +>. Sellisel juhul luuakse protokolli kohta ainult teatud arv (praegu 3) mooduliprotsesse. Kui lood rohkem töid, seatakse need järjekorda ja täidetakse siis, kui mooduliprotsess jääb jõude. See käib nii: </para> + +<programlisting +>KURL url("http://developer.kde.org/documentation/kde2arch/index.html"); +KIO::TransferJob *job = KIO::get(url, true, false); +KIO::Scheduler::scheduleJob(job); +</programlisting> + +<para +>Kolmas võimalus on <emphasis +>ühendusepõhine</emphasis +>. Näiteks IMAP mooduli korral ei ole erilist mõtet käivitada ühe ja sama serveri puhul mitu protsessi. Nii või teisiti saab korraga toimida ainult üks IMAP ühendus. Sellisel juhul peab rakendus otseselt suhtlema mooduliga, kõrvaldades mooduli teatud ühenduselt ja seejärel omistama kõik tööd, mis käivad üle ühe ühenduse, samale moodulile. Ka selleks sobib suurepäraselt KIO::Scheduler: </para> + +<programlisting +>KURL baseUrl("imap://bernd@albert.physik.hu-berlin.de"); +KIO::Slave *slave = KIO::Scheduler::getConnectedSlave(baseUrl); + +KIO::TransferJob *job1 = KIO::get(KURL(baseUrl, "/INBOX;UID=79374")); +KIO::Scheduler::assignJobToSlave(slave, job1); + +KIO::TransferJob *job2 = KIO::get(KURL(baseUrl, "/INBOX;UID=86793")); +KIO::Scheduler::assignJobToSlave(slave, job2); + +... + +KIO::Scheduler::disconnectSlave(slave); +</programlisting> + +<para +>Moodul on mõtet lahti ühendada alles pärast seda, kui kõik sellele omistatud tööd on kindlasti lõpetatud. </para> + +</simplesect> + + +<simplesect id="nettransparency-definingslaves"> +<title +>IO mooduli defineerimine</title> + +<para +>Siin vaatame nüüd seda, kuidas lisada süsteemile uus IO moodul. Sarnaselt teenustele teeb uue IO mooduli süsteemile teatavaks väikese konfiguratsioonifaili paigaldamine. Järgnev Makefile.am koodijupp paigaldab FTP protokolli: </para> + +<programlisting +>protocoldir = $(kde_servicesdir) +protocol_DATA = ftp.protocol +EXTRA_DIST = $(mime_DATA) +</programlisting> + +<para +>Faili ftp.protocol sisu on selline: </para> + +<programlisting +>[Protocol] +exec=kio_ftp +protocol=ftp +input=none +output=filesystem +listing=Name,Type,Size,Date,Access,Owner,Group,Link, +reading=true +writing=true +makedir=true +deleting=true +Icon=ftp +</programlisting> + +<para +>Kirje <literal +>"protocol"</literal +> määrab, millise protokolli eest antud moodul hoolt kannab. <literal +>"exec"</literal +> on (vastupidi sellele, mida sa vahest naiivselt arvasid) moodulit teostava teegi nimi. Mooduli käivitamisel käivitatakse <command +>"tdeinit"</command +>, mis omakorda laeb antud teegi enda aadressiruumi. Nii võib töötavat moodulit käsitleda praktikas küll omaette protsessina, kuigi tegelikult on see teostatud teegina. Selle eeliseks on asjaolu, et nii saab säästa hulgaliselt mälu ja kahandada käivituslinkurile vajalikku aega. </para> + +<para +>Praegu ei ole kasutusel read "input" ja "output". </para> + +<para +>Ülejäänud <literal +>.protocol</literal +>-faili read määravad ära mooduli omadused. Üldiselt on võimalused, mida moodul peab teostama, palju lihtsamad kui võimalused, mida KIO API rakendustele pakub. Selle põhjuseks on keerukate tööde jagamine mitmeks alamtööks. Näiteks kataloogi sisu näitamiseks rekursiivselt käivitatakse üks töö tippkataloogis. Seejärel käivitatakse iga alamkataloogi sisu leidmiseks uued alamtööd. KIO ajastaja tagab, et korraga ei oleks aktiivsed liiga palju töid. Ka võib KIO näiteks faili kopeerimiseks protokolli korral, mis ei toeta vahetult kopeerimist (näiteks <literal +>ftp:</literal +>), lugeda lähtefaili ja seejärel kirjutada andmed sihtfaili. Selleks peab <literal +>.protocol</literal +>-fail tegema teatavaks, milliseid toiminguid antud moodul toetab. </para> + +<para +>Kuna moodulid laetakse jagatud teegina, kuid kujutavad endast autonoomseid programme, erineb nende koodi raamistik mõnevõrra tavalistest jagatud teegi pluginatest. Mooduli käivitamiseks välja kutsutav funktsioon kannab nime <function +>kdemain()</function +>. See sooritab teatud initsialiseerimine ning läheb seejärel sündmusesilmusesse ja ootab rakenduse soove. Välja näeb see nii: </para> + +<programlisting +>extern "C" { int kdemain(int argc, char **argv); } + +int kdemain(int argc, char **argv) +{ + KLocale::setMainCatalogue("tdelibs"); + KInstance instance("kio_ftp"); + (void) KGlobal::locale(); + + if (argc != 4) { + fprintf(stderr, "Usage: kio_ftp protocol " + "domain-socket1 domain-socket2\n"); + exit(-1); + } + + FtpSlave slave(argv[2], argv[3]); + slave.dispatchLoop(); + return 0; +} +</programlisting> + +</simplesect> + + +<simplesect id="nettransparency-implementingslaves"> +<title +>IO mooduli teostamine</title> + +<para +>Moodulid teostatakse <classname +>KIO::SlaveBase</classname +> alamklassidena (ülaltoodud näites FtpSlave). Nii vastavad <literal +>.protocol</literal +>-failis loetletud toimingud teatud <classname +>KIO::SlaveBase</classname +> teatud virtuaalsetele funktsioonidele, mida mooduli teostus peab taasteostama. Toome siin ära võimalike toimingute ja neile vastavate virtuaalsete funktsioonide loendi: </para> + +<variablelist> + +<varlistentry +><term +>reading - loeb andmed URL-ilt</term> +<listitem +><para +>void get(const KURL &url)</para +></listitem +></varlistentry> + +<varlistentry +><term +>writing - kirjutab andmed URL-ile ja loob faili, kui seda veel ei ole.</term> +<listitem +><para +>void put(const KURL &url, int õigused, bool overwrite, bool resume)</para +></listitem +></varlistentry> + +<varlistentry +><term +>moving - nimetab faili ümber.</term> +<listitem +><para +>void rename(const KURL &src, const KURL &dest, bool overwrite)</para +></listitem +></varlistentry> + +<varlistentry +><term +>deleting - kustutab faili või kataloogi.</term> +<listitem +><para +>void del(const KURL &url, bool isFile)</para +></listitem +></varlistentry> + +<varlistentry +><term +>listing - tagastab kataloogi sisu.</term> +<listitem +><para +>void listDir(const KURL &url)</para +></listitem +></varlistentry> + +<varlistentry +><term +>makedir - loob kataloogi.</term> +<listitem +><para +>void mkdir(const KURL &url, int õigused)</para +></listitem +></varlistentry> + +</variablelist> + +<para +>Lisaks on taasteostatavaid funktsioone, mida ei ole ära toodud <literal +>.protocol</literal +>-failis. Nende tegevuste puhul määrab KIO automaatselt, kas need on toetatud või mitte (s.t vaiketeostus tagastab vea). </para> + +<variablelist> + +<varlistentry +><term +>Edastab failiinfo, umbes nagu C funktsioon stat().</term> +<listitem +><para +>void stat(const KURL &url)</para +></listitem +></varlistentry> + +<varlistentry +><term +>Muudab faili kasutamise õigusi.</term> +<listitem +><para +>void chmod(const KURL &url, int õigused)</para +></listitem +></varlistentry> + +<varlistentry +><term +>Määrab faili MIME tüübi.</term> +<listitem +><para +>void mimetype(const KURL &url)</para +></listitem +></varlistentry> + +<varlistentry +><term +>Kopeerib faili.</term> +<listitem +><para +>copy(const KURL &url, const KURL &dest, int õigused, bool overwrite)</para +></listitem +></varlistentry> + +<varlistentry +><term +>Loob nimeviida.</term> +<listitem +><para +>void symlink(const QString &target, const KURL &dest, bool overwrite)</para +></listitem +></varlistentry> + +</variablelist> + +<para +>Kõik teostused peavad lõppema ühga kahest väljakutsest: kui tegevus oli edukas, peavad nad kutsuma välja <literal +>finished()</literal +>, kui aga tekkis viga, siis tuleb välja kutsuda <literal +>error()</literal +> koos veakoodiga esimese ja stringiga teise argumendina. Võimalike veakoodide loendi annab <type +>KIO::Error</type +>. Teine argument on tavaliselt asjakohane URL. Seda kasutab näiteks <function +>KIO::Job::showErrorDialog()</function +> inimestele mõistetava veateate loomisel. </para> + +<para +>Võrguprotokollidele vastavate moodulite puhul võib huvi pakkuda meetodi <function +>SlaveBase::setHost()</function +> taasteostamine. See kutsutakse välja teatamaks mooduliprotsessile masinat ja porti ning sisselogimiseks vajalikku kasutajanime ja parooli. Üldiselt saab rakenduse saadetud metaandmete päringuks kasutada <function +>SlaveBase::metaData()</function +>. Teatud võtme metaandmete olemasolu kontrollimiseks on mõeldud <function +>SlaveBase::hasMetaData()</function +>. </para> + +</simplesect> + + +<simplesect id="nettransparency-communication"> +<title +>Tagasiside rakendusele</title> + +<para +>Mooduli teostatud toimingute tulemusel saadud andmed tuleb mingil moel tagastada mooduliprotsessi kasutavale rakendusele: </para> + +<itemizedlist> + +<listitem +><para +><function +>get()</function +> saadab andmebloki. Seda teeb <function +>data()</function +>, mis võtab argumendiks <classname +>QByteArray</classname +>. Mõistagi ei pea kõiki andmeid korraga saatma. Näiteks suurt faili saates kutsu <function +>data()</function +> välja väiksemate andmeblokkidega, et rakendus suudaks neid töödelda. Kui edastus on lõpetatud, kutsu välja <function +>finished()</function +>. </para +></listitem> + +<listitem +><para +><function +>listDir()</function +> edastab kataloogikirjete info. Selleks kutsu <function +>listEntries()</function +> välja argumendiga <classname +>KIO::UDSEntryList</classname +>. Nagu <function +>data()</function +> puhul, võib ka seda mitu korda välja kutsuda. Kui oled lõpetanud, kutsu välja <function +>listEntry()</function +>, kusjuures teine argument peab olema tõene (true). Samuti võib välja kutsuda <function +>totalSize()</function +>, mis annab vastuseks kataloogikirjete koguarvu, kui see on teada. </para +></listitem> + +<listitem +><para +><function +>stat()</function +> edastab failiinfot, näiteks suuruse, MIME tüübi jne. Sellist infot sisaldab <classname +>KIO::UDSEntry</classname +>, millest tuleb veel juttu. Selliste andmete saatmiseks rakendustele kasuta <function +>statEntry()</function +>. </para +></listitem> + +<listitem +><para +><function +>mimetype()</function +> kutsub välja <function +>mimeType()</function +>, andes argumendiks stringi. </para +></listitem> + +<listitem +><para +><function +>get()</function +> ja <function +>copy()</function +> pakuvad edenemisinfot. Seda saavutatakse meetoditega <function +>totalSize()</function +>, <function +>processedSize()</function +> ja <function +>speed()</function +>. Kogusuurus ja töödeldud suurus antakse teada baitides, kiirus baitides sekundi kohta. </para +></listitem> + +<listitem +><para +>Funktsiooniga <function +>setMetaData()</function +> saab saata metaandmete võtme-väärtuse paare. </para +></listitem> + +</itemizedlist> + +</simplesect> + + +<simplesect id="nettransparency-interacting"> +<title +>Suhtlemine kasutajaga</title> + +<para +>Mõnikord on moodulil vaja suhelda kasutajaga: infosõnumid, autentimisdialoogid või kinnituse küsimine faili ülekirjutamisel. </para> + +<itemizedlist> + +<listitem +><para +><function +>infoMessage()</function +> - informatsiooniline tagasiside, näiteks HTTP mooduli sõnum "Andmete tõmbamine aadressilt <masin>", mida sageli näidatakse rakenduse olekuribal. Rakenduse poolelt vastab sellele meetodile signaal <function +>KIO::Job::infoMessage()</function +>. </para +></listitem> + +<listitem +><para +><function +>warning()</function +> - näitab hoiatust teatekastis funktsiooniga <function +>KMessageBox::information()</function +>. Kui sama mooduliprotsessi eelmise warning() väljakutse teatekast veel avatud, ei juhtu midagi. </para +></listitem> + +<listitem +><para +><function +>messageBox()</function +> - rikkalikum, kui eelmine meetod. Võimaldab avada teatekasti teksti, pealdise ja mõne nupuga. Vaata täpsemalt loendit <type +>SlaveBase::MessageBoxType</type +>. </para +></listitem> + +<listitem +><para +><function +>openPassDlg()</function +> - avab dialoogi kasutajanime ja parooli sisestamiseks. </para +></listitem> + +</itemizedlist> + +</simplesect> + +</sect1> + +</chapter> + + + +<appendix id="misc"> +<title +>Litsents</title> + +&underFDL; +&underGPL; + +</appendix> + +</book> |