Difference between revisions of "Development/Tutorials/Saving and loading (fi)"

 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|Development/Tutorials/Saving_and_loading}}
+
 
  
 
{{TutorialBrowser|
 
{{TutorialBrowser|
Line 5: Line 5:
 
series=Beginner Tutorial|
 
series=Beginner Tutorial|
  
name=Tallettaminen ja Avaaminen|
+
name=Tallentaminen ja avaaminen|
  
pre=[[Development/Tutorials/Using_KActions (fi)|Perehdytys 3 - KActions ja XMLGUI]]|
+
pre=[[Development/Tutorials/Using_KActions (fi)|Opas 3 - KActions ja XMLGUI]]|
  
 
next=[[Development/Tutorials/KCmdLineArgs|Tutorial 5 - Using KCmdLineArgs]]|  
 
next=[[Development/Tutorials/KCmdLineArgs|Tutorial 5 - Using KCmdLineArgs]]|  
Line 16: Line 16:
 
==Lyhyesti==
 
==Lyhyesti==
  
Nyt kun meillä on perus tekstieditori, on aika tehdä siitä jollain tavalla hyödyllinen. Jokaisen tekstieditorilla pitäisi pystyä vähintäänkin tallettamaan tehdyt työt levylle sekä avata tekstitiedostoja käsittelyä varten.
+
Nyt kun meillä on yksinkertainen tekstieditori, on aika tehdä siitä jollain tavalla hyödyllinen. Jokaisella tekstieditorilla pitäisi pystyä ainakin tallentamaan tehdyt työt levylle sekä avaamaan tekstitiedostoja käsittelyä varten.
  
KDE tarjoaa joukon luokkia tiedostojen kanssa työskentelyä varten jotka helpottavat ohjelmistokehittäjän elämää. KIO-kirjasto mahdollistaa helpon tiedostojen käsittelyn verkkoprotokollien yli sekä se tarjoaa vakioidun tiedosto valikon tiedostojen avaamista ja tallettamista varten.
+
KDE tarjoaa tiedostojen kanssa työskentelyä varten joukon luokkia, jotka helpottavat ohjelmistokehittäjän elämää. KIO-kirjasto mahdollistaa helpon tiedostojen käsittelyn verkkoprotokollien kautta sekä tarjoaa vakioidun tiedostovalikon tiedostojen avaamista ja tallentamista varten.
  
 
[[image:introtokdetutorial4.png|frame|center]]
 
[[image:introtokdetutorial4.png|frame|center]]
Line 25: Line 25:
  
 
===main.cpp===
 
===main.cpp===
<code cppqt n>
+
<syntaxhighlight lang="cpp-qt" line>
 
#include <KApplication>
 
#include <KApplication>
 
#include <KAboutData>
 
#include <KAboutData>
Line 46: Line 46:
 
   return app.exec();
 
   return app.exec();
 
}
 
}
</code>
+
</syntaxhighlight>
 
<tt>main.cpp</tt>-tiedostoa ei ole muutettu mitenkään paitsi kaikki ''tutorial 3'':t on vaihdettu ''tutorial 4'':ksi.
 
<tt>main.cpp</tt>-tiedostoa ei ole muutettu mitenkään paitsi kaikki ''tutorial 3'':t on vaihdettu ''tutorial 4'':ksi.
  
 
===mainwindow.h===
 
===mainwindow.h===
<code cppqt n>
+
<syntaxhighlight lang="cpp-qt" line>
 
#ifndef MAINWINDOW_H
 
#ifndef MAINWINDOW_H
 
#define MAINWINDOW_H
 
#define MAINWINDOW_H
Line 78: Line 78:
  
 
#endif
 
#endif
</code>
+
</syntaxhighlight>
Tiedostojen avaus ja tallennus mahdollisuuden aikaansaamiseksi meidän tarvitsee lisätä funktiot jotka tekevät tarvittavat asiat.  Koska näitä funktoita tullaan kutsumaan Qt:n [http://doc.trolltech.com/latest/signalsandslots.html signal/slot]-yhdistämismekanismin kautta, meidän tarvitsee määritellä nämä funktiot <tt>slot</tt>:ksi. Tämä on toteutettu rivillä 19. Koska käytämme <tt>slot</tt>:a tässä otsikkotiedostossa, meidän tarvitsee lisätä myös [http://doc.trolltech.com/latest/qobject.html#Q_OBJECT <tt>Q_OBJECT</tt>] makro.
+
Tiedostojen avaus- ja tallennusmahdollisuuden aikaansaamiseksi meidän tarvitsee lisätä funktiot, jotka tekevät tarvittavat asiat.  Koska näitä funktoita tullaan kutsumaan Qt:n [http://doc.trolltech.com/latest/signalsandslots.html signal/slot]-yhdistämismekanismin kautta, meidän on määriteltävä nämä funktiot <tt>slot</tt>:ksi. Tämä on toteutettu rivillä 19. Koska käytämme <tt>slot</tt>:a tässä otsikkotiedostossa, on myös [http://doc.trolltech.com/latest/qobject.html#Q_OBJECT <tt>Q_OBJECT</tt>] -makro lisättävä.
  
Haluamme myös pitää muistissa avaamamme tiedoston nimen, joten meidän tarvitsee esitellä myös <tt>{{qt|QString}} fileName</tt>.
+
Haluamme myös pitää muistissa avaamamme tiedoston nimen, joten myösmyös <tt>{{qt|QString}} fileName</tt> on esiteltävä.
  
 
===mainwindow.cpp===
 
===mainwindow.cpp===
<code cppqt n>
+
<syntaxhighlight lang="cpp-qt" line>
 
#include "mainwindow.h"
 
#include "mainwindow.h"
  
Line 196: Line 196:
 
   }
 
   }
 
}
 
}
</code>
+
</syntaxhighlight>
  
 
===tutorial4ui.rc===
 
===tutorial4ui.rc===
<code xml n>
+
<syntaxhighlight lang="xml" line>
 
<?xml version="1.0" encoding="UTF-8"?>
 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE kpartgui SYSTEM "kpartgui.dtd">
+
<gui name="tutorial4"
<gui name="tutorial4" version="1">
+
    version="1"
  <ToolBar name="mainToolBar" >
+
    xmlns="http://www.kde.org/standards/kxmlgui/1.0"
    <text>Main Toolbar</text>
+
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    <Action name="clear" />
+
    xsi:schemaLocation="http://www.kde.org/standards/kxmlgui/1.0
  </ToolBar>
+
                        http://www.kde.org/standards/kxmlgui/1.0/kxmlgui.xsd" >
 +
 
 
   <MenuBar>
 
   <MenuBar>
 
     <Menu name="file" >
 
     <Menu name="file" >
Line 212: Line 213:
 
     </Menu>
 
     </Menu>
 
   </MenuBar>
 
   </MenuBar>
 +
 +
  <ToolBar name="mainToolBar" >
 +
    <text>Main Toolbar</text>
 +
    <Action name="clear" />
 +
  </ToolBar>
 +
 
</gui>
 
</gui>
</code>
+
</syntaxhighlight>
Tämä on muuten identtinen <tt>tutorial3ui.rc</tt> kanssa, paitsi <tt>nimi</tt> on muutettu 'tutorial4':ksi. Koska kaikki uudet toiminnot ovat <tt>KStandardAction</tt>:ta jotka KDE osaa automaattisesti käsitellä, tähän tiedostoon ei tarvitse lisätä mitään.
+
Tämä on muuten identtinen <tt>tutorial3ui.rc</tt> kanssa, paitsi <tt>nimi</tt> on muutettu 'tutorial4':ksi. Koska kaikki uudet toiminnot ovat <tt>KStandardAction</tt> -toimintoja, joita KDE osaa automaattisesti käsitellä, tähän tiedostoon ei tarvitse lisätä mitään.
  
 
==Selvitys==
 
==Selvitys==
  
Selvitetään nyt hieman koodia joka tekee avaamisen sekä ja tallettamisen. Kaikki tarvittava on sijoitettu <tt>mainwindow.cpp</tt>-tiedostoon.
+
Selvitetään nyt hieman koodia, joka tekee avaamisen sekä ja tallentamisen. Kaikki tarvittava on sijoitettu <tt>mainwindow.cpp</tt>-tiedostoon.
  
 
Ensimmäisenä, rivillä 16, meidän pitää lisätä
 
Ensimmäisenä, rivillä 16, meidän pitää lisätä
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
fileName(QString())
 
fileName(QString())
</code>
+
</syntaxhighlight>
<tt>MainWindow</tt>:n muodostajaan. Tällä varmistetaan että tiedoston nimi on tyhjä aloitettaessa.
+
<tt>MainWindow</tt>:n muodostajaan. Tällä varmistetaan, että tiedoston nimi on tyhjä aloitettaessa.
  
 
===Toimintojen lisääminen===
 
===Toimintojen lisääminen===
  
Ensinnäkin meidän pitää lisätä liittymä ohjelman ulkopuolelle, jotta käyttäjät voivat kertoa ohjelmalle avataanko vai talletetaanko tiedosto. Samaan tapaan kuin Perehdytyksessä 3, <tt>lopeta</tt>-toiminnon kanssa, käytämme tähänkin tarkoitukseen <tt>KStandardActions</tt>:a riveillä 37-47. Kaikki uudet toiminnot on kytketty sopiviin sloteihin jotka esittelimme otsikkotiedostossa riveillä 20-24.  
+
Ensinnäkin meidän pitää lisätä liittymä ohjelman ulkopuolelle, jotta käyttäjät voivat kertoa ohjelmalle, avataanko vai talletetaanko tiedosto. Käytämme tähänkin tarkoitukseen <tt>KStandardActions</tt>:a riveillä 37-47 samaan tapaan kuin oppaassa 3 toteuttaessamme <tt>lopeta</tt>-toimintoa. Kaikki uudet toiminnot on kytketty sopiviin sloteihin, jotka esittelimme otsaketiedostossa riveillä 20-24.  
  
 
===Uusi asiakirja===
 
===Uusi asiakirja===
  
 
Ensimmäisenä funktio jonka loimme on <tt>newFile()</tt>-funktio.
 
Ensimmäisenä funktio jonka loimme on <tt>newFile()</tt>-funktio.
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
void MainWindow::newFile()
 
void MainWindow::newFile()
 
{
 
{
Line 239: Line 246:
 
   textArea->clear();
 
   textArea->clear();
 
}
 
}
</code>
+
</syntaxhighlight>
<tt>fileName.clear()</tt> asettaa <tt>fileName</tt> (QString) merkkijonon tyhjäksi kuvaamaan että tätä tiedostoa ei ole olemassa talletettuna minnekkään.  
+
<tt>fileName.clear()</tt> asettaa <tt>fileName</tt> (QString) merkkijonon tyhjäksi kuvaamaan, että tätä tiedostoa ei ole olemassa tallennettuna minnekkään.  
<tt>textArea->clear()</tt> tyhjentää tekstialueen käyttäen samaa <tt>KAction</tt>:n <tt>clear</tt>-funktiota johon kytkimme Tyhjennä-toimionnon Perehdytyksessä 3.
+
<tt>textArea->clear()</tt> tyhjentää tekstialueen käyttäen samaa <tt>KAction</tt>:n <tt>clear</tt>-funktiota johon kytkimme tyhjennä-toiminnon oppaassa 3.
  
===Tiedoston tallettaminen===
+
===Tiedoston tallentaminen===
  
 
====saveFileAs(QString)====
 
====saveFileAs(QString)====
  
Siirrymme nyt ensimmäiseen tiedostoja käsittelevään koodiin. Seuraavaksi syvennymme funktioon jonka tehtävänä on tallentaa tekstialueen sisältö paramterinä annetulla tiedostonimellä. KDE tarjoaa turvalliseen tiedoston tallettamiseen Qt:n {{qt|QFile}}:a johdetun {{class|KSaveFile}}-luokan.
+
Siirrymme nyt ensimmäiseen tiedostoja käsittelevään koodiin. Seuraavaksi syvennymme funktioon, jonka tehtävänä on tallentaa tekstialueen sisältö parametrina annetulla tiedostonimellä. KDE tarjoaa turvalliseen tiedoston tallentamiseen Qt:n {{qt|QFile}}:a johdetun {{class|KSaveFile}}-luokan.
  
 
Funktion prototyyppi on:
 
Funktion prototyyppi on:
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
void MainWindow::saveFileAs(const QString &outputFileName)
 
void MainWindow::saveFileAs(const QString &outputFileName)
</code>
+
</syntaxhighlight>
  
 
Seuraavaksi luomme <tt>KSaveFile</tt>-objektin ja avaamme sen
 
Seuraavaksi luomme <tt>KSaveFile</tt>-objektin ja avaamme sen
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
KSaveFile file(outputFileName);
 
KSaveFile file(outputFileName);
 
file.open();
 
file.open();
</code>
+
</syntaxhighlight>
  
Nyt kun meillä on tiedosto johon kirjoittaa, meidän pitää muotoilla teksti alueen sisältö sellaiseen muotoon joka on mahdollista kirjoittaa tiedostoon. Tätä tarkoitusta varten luomme {{qt|QByteArray}}:n johon syötämme tekstialueen sisällön tekstinä, ilman muotoiluja, seuraavasti:  
+
Nyt meillä on tiedosto, johon voimme kirjoittaa. Seuraavaksi pitää tekstialueen sisältö muotoilla muotoon, joka on mahdollista kirjoittaa tiedostoon. Tätä tarkoitusta varten luomme {{qt|QByteArray}}:n, johon syötämme tekstialueen sisällön paljaana tekstinä (ilman muotoiluja) seuraavasti:  
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
QByteArray outputByteArray;
 
QByteArray outputByteArray;
 
outputByteArray.append(textArea->toPlainText());
 
outputByteArray.append(textArea->toPlainText());
</code>
+
</syntaxhighlight>
Nyt meillä on <tt>KSaveFile::write()</tt>:n kanssa käytettävä <tt>QByteArray</tt> calmiina. Normaalin <tt>QFile</tt>:n käyttäminen olisi myös mahdollista, ja se tallettaisi muutokset välittömästi, mutta jos tällöin tapahtuisi jokin virhe tallentamisen aikana, tulisi tiedostosta viallinen. Tästä syystä <tt>KSaveFile</tt> luo ensin väliaikaisen tiedoston, ja vasta kun kutsutaan <tt>KSaveFile::finalize()</tt>-funktiota, luodaan varsinainen tiedosto.
+
Nyt meillä on <tt>KSaveFile::write()</tt>:n kanssa käytettävä <tt>QByteArray</tt> valmiina. Normaalin <tt>QFile</tt>:n käyttäminen olisi myös mahdollista, ja se tallentaisi muutokset välittömästi. Jos tällöin kuitenkin tapahtuisi jokin virhe tallentamisen aikana, tulisi tiedostosta viallinen. Tästä syystä <tt>KSaveFile</tt> luo ensin väliaikaisen tiedoston, ja varsinainen tiedosto luodaan vasta kun kutsutaan <tt>KSaveFile::finalize()</tt>-funktiota.
<code cppqt>
+
 
 +
<syntaxhighlight lang="cpp-qt">
 
file.write(outputByteArray);
 
file.write(outputByteArray);
 
file.finalize();
 
file.finalize();
 
file.close();
 
file.close();
</code>
+
</syntaxhighlight>
Ja lopuksi asetetaan <tt>MainWindows</tt>:n <tt>fileName</tt> osoittamaan tiedostoon jonka juuri tallensimme:
+
Ja lopuksi asetetaan <tt>MainWindows</tt>:n <tt>fileName</tt> osoittamaan tiedostoon, jonka juuri tallensimme:
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
fileName = outputFileName;
 
fileName = outputFileName;
</code>
+
</syntaxhighlight>
  
 
====saveFileAs()====
 
====saveFileAs()====
  
Tähän funktioon on yhdistetty <tt>saveAs</tt>(Tallenna nimellä) toiminto. Tämä funktio kutsuu <tt>saveFileAs(QString)</tt>-funktiota jolle lähetetään parametrinä  
+
Tähän funktioon on yhdistetty <tt>saveAs</tt>(Tallenna nimellä) toiminto. Tämä funktio kutsuu <tt>saveFileAs(QString)</tt>-funktiota, jolle lähetetään parametrinä  
 
<tt>{{class|KFileDialog}}::[http://api.kde.org/4.0-api/kdelibs-apidocs/kio/html/classKFileDialog.html#8891356c249c5911e1ab15cc2739a89b getSaveFileName()]</tt>:n palauttama tiedoston nimi.
 
<tt>{{class|KFileDialog}}::[http://api.kde.org/4.0-api/kdelibs-apidocs/kio/html/classKFileDialog.html#8891356c249c5911e1ab15cc2739a89b getSaveFileName()]</tt>:n palauttama tiedoston nimi.
  
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
void MainWindow::saveFileAs()
 
void MainWindow::saveFileAs()
 
{
 
{
 
   saveFileAs(KFileDialog::getSaveFileName());
 
   saveFileAs(KFileDialog::getSaveFileName());
 
}
 
}
</code>
+
</syntaxhighlight>
  
Tässä kohdassa käytämme ensimmäisen kerran KIO-kirjastoa. {{class|KFileDialog}}-luokka tarjoaa meille joukon funktioita joita kaikki KDE ohjelmat käyttävät yleisten tiedostovalikoiden näyttämiseen. <tt>KFileDialog::getSaveFileName()</tt>-funktion kutsuminen tuo esille tiedostovalikon jossa käyttäjä voi valita tai vaihtaa tiedoston nimeä tai tallennussijaintia. Funktio palauttaa täydellisen tiedoston nimen, jonka me välitimme <tt>saveFileAs(QString)</tt>-funktiolle.
+
Tässä kohdassa käytämme ensimmäisen kerran KIO-kirjastoa. {{class|KFileDialog}}-luokka tarjoaa meille joukon funktioita, joita kaikki KDE ohjelmat käyttävät yleisten tiedostovalikoiden näyttämiseen. <tt>KFileDialog::getSaveFileName()</tt>-funktion kutsuminen tuo esille tiedostovalikon,jossa käyttäjä voi valita tai vaihtaa tiedoston nimeä tai tallennussijaintia. Funktio palauttaa täydellisen tiedoston nimen, jonka me välitimme <tt>saveFileAs(QString)</tt>-funktiolle.
  
 
====saveFile()====
 
====saveFile()====
  
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
void MainWindow::saveFile()
 
void MainWindow::saveFile()
 
{
 
{
Line 304: Line 312:
 
   }
 
   }
 
}
 
}
</code>
+
</syntaxhighlight>
  
Tässä funktiossa ei ole mitään erityistä tai uutta. Tässä vain päätellään, näytetäänkö tallennusvalikko vai ei. Jos <tt>fileName</tt> ei ole tyhjä, tallennetaan tiedosto mitään kysymättä nimellä joka on sijoitettuna <tt>fileName</tt>:n kutsumalla saveFileAs(QString)-funktiota, muuten kutsutaan yllä olevaa saveFileAs()-funktiota.
+
Tässä funktiossa ei ole mitään erityistä tai uutta. Tässä vain päätellään, näytetäänkö tallennusvalikko vai ei. Jos <tt>fileName</tt> ei ole tyhjä, tallennetaan tiedosto mitään kysymättä nimellä, joka on sijoitettuna <tt>fileName</tt>:n kutsumalla saveFileAs(QString)-funktiota, muuten kutsutaan yllä olevaa saveFileAs()-funktiota.
  
 
===Tiedoston avaaminen===
 
===Tiedoston avaaminen===
  
Lopulta olemme valmiit tarkastelemaan tiedoston avaamista levyltä. Kaikki koodi tätä tarkoitusta varten on sijoitettu <tt>MainWindow::openFile()</tt>-funktioon.
+
Lopulta olemme valmiita tarkastelemaan tiedoston avaamista levyltä. Kaikki koodi tätä tarkoitusta varten on sijoitettu <tt>MainWindow::openFile()</tt>-funktioon.
  
Ensin meidän pitää kysyä käyttäjältä, mikä tiedosto halutaan avattavan. Tätä tarkoitusta varten me käytämme toista <tt>KFileDialog</tt>-funktiota, <tt>getOpenFileName()</tt>:
+
Ensin meidän pitää kysyä käyttäjältä, mikä tiedosto halutaan avata. Tätä tarkoitusta varten käytetään toista <tt>KFileDialog</tt>-funktiota, <tt>getOpenFileName()</tt>:
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
QString fileNameFromDialog = KFileDialog::getOpenFileName();
 
QString fileNameFromDialog = KFileDialog::getOpenFileName();
</code>
+
</syntaxhighlight>
  
Seuraavaksi käytämme KIO-kirjastoa tiedoston avaamiseen. KIO-kirjasto antaa meille mahdollisuuden avata tiedosto QFilen avulla, paikalliselta levyltä tai etäkoneelta, vaikkapa FTP:n yli. Tiedoston avaamiseksi käytämme {{class|NetAccess}}:n <tt>download()</tt>-funktiota:
+
Seuraavaksi käytämme KIO-kirjastoa tiedoston avaamiseen. KIO-kirjaston avulla voimme avata tiedoston QFilen avulla, paikalliselta levyltä tai etäkoneelta, vaikkapa FTP:n yli. Tiedoston avaamiseksi käytämme {{class|NetAccess}}:n <tt>download()</tt>-funktiota:
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
KIO::NetAccess::download(fileNameFromDialog, tmpFile, this)
 
KIO::NetAccess::download(fileNameFromDialog, tmpFile, this)
</code>
+
</syntaxhighlight>
Ensimmäinen argumentti on avattavan tiedoston nimi. Toinen on QString, joka tiedoston hakemisen jälkeen, sisältää väliaikaisen tiedoston sijainnin. Tämän <tt>tmpFile</tt>:n kanssa jatkamme tästä eteenpäin.
+
Ensimmäinen argumentti on avattavan tiedoston nimi. Toinen on QString, joka tiedoston hakemisen jälkeen sisältää väliaikaisen tiedoston sijainnin. Tämän <tt>tmpFile</tt>:n kanssa jatkamme tästä eteenpäin.
  
 
Funktio palauttaa boolen arvon <tt>tosi</tt> tai <tt>epätosi</tt>, riippuen onnistuiko tiedoston siirto. Jos tiedoston haku epäonnistui, näytetään virheilmoitus:
 
Funktio palauttaa boolen arvon <tt>tosi</tt> tai <tt>epätosi</tt>, riippuen onnistuiko tiedoston siirto. Jos tiedoston haku epäonnistui, näytetään virheilmoitus:
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
KMessageBox::error(this, KIO::NetAccess::lastErrorString());
 
KMessageBox::error(this, KIO::NetAccess::lastErrorString());
</code>
+
</syntaxhighlight>
  
 
Muussa tapauksessa jatketaan tiedoston avaamista.
 
Muussa tapauksessa jatketaan tiedoston avaamista.
  
Luomme uuden QFile:n välittämällä sen muodostajaan <tt>NetAccess::download()</tt>:n luoman väliaikaistiedoston jonka jälkeen avataan se kirjoitussuojattuna:
+
Luomme uuden QFile:n välittämällä sen muodostajaan <tt>NetAccess::download()</tt>:n luoman väliaikaistiedoston, minkä jälkeen avataan se kirjoitussuojattuna:
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
QFile file(tmpFile);
 
QFile file(tmpFile);
 
file.open(QIODevice::ReadOnly);
 
file.open(QIODevice::ReadOnly);
</code>
+
</syntaxhighlight>
  
Tuodaksemme avaamamme tiedoston sisällön ruudulle näkyviin, tarvitsee meidän käyttää {{class|QTextStream}}-luokkaa. {{class|QTextStream}}:n muodostajalle välitämme äsken avaamamme tiedoston (QFile file) ja kutsumme QFile:n <tt>readAll()</tt>-funktiota saadaksemme tekstin tiedostosta. Seuraavaksi välitämme tämän kaiken meidän tekstialueen <tt>setPlainText()</tt>-funktiolle:
+
Tuodaksemme avaamamme tiedoston sisällön ruudulle näkyviin, tarvitsee meidän käyttää {{class|QTextStream}}-luokkaa. {{class|QTextStream}}:n muodostajalle välitämme äsken avaamamme tiedoston (QFile file) ja kutsumme QFile:n <tt>readAll()</tt>-funktiota saadaksemme tekstin tiedostosta. Seuraavaksi välitämme tämän kaiken tekstialueen <tt>setPlainText()</tt>-funktiolle:
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
textArea->setPlainText(QTextStream(&file).readAll());
 
textArea->setPlainText(QTextStream(&file).readAll());
</code>
+
</syntaxhighlight>
  
Talletetaan avatun tiedoston nimi(polkuineen):
+
Tallennetaan avatun tiedoston nimi(polkuineen):
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
fileName = fileNameFromDialog;
 
fileName = fileNameFromDialog;
</code>
+
</syntaxhighlight>
  
 
Ja lopuksi poistetaan <tt>NetAccess::download()</tt>:n luoma väliaikaistiedosto:
 
Ja lopuksi poistetaan <tt>NetAccess::download()</tt>:n luoma väliaikaistiedosto:
<code cppqt>
+
<syntaxhighlight lang="cpp-qt">
 
KIO::NetAccess::removeTempFile(tmpFile);
 
KIO::NetAccess::removeTempFile(tmpFile);
</code>
+
</syntaxhighlight>
  
==Make, Install And Run==
+
==Käännä, Asenna ja Suorita==
  
 
===CMakeLists.txt===
 
===CMakeLists.txt===
<code ini n>
+
<syntaxhighlight lang="ini" line>
 
project(tutorial4)
 
project(tutorial4)
 
   
 
   
Line 373: Line 381:
 
install(FILES tutorial4ui.rc  
 
install(FILES tutorial4ui.rc  
 
         DESTINATION ${DATA_INSTALL_DIR}/tutorial4)
 
         DESTINATION ${DATA_INSTALL_DIR}/tutorial4)
</code>
+
</syntaxhighlight>
Since we are now using the KIO library, we must tell CMake to link against it. We do this by passing <tt>${KDE4_KIO_LIBS}</tt> to the <tt>target_link_libraries()</tt> function.
+
Koska otimme nyt KIO-kirjaston käyttöön, täytyy CMakelle kertoa, että linkittäjän tarvitsee ottaa myös tämä mukaan. Tätä varten lisäämme <tt>target_link_libraries()</tt>-funktioon tiedon <tt>${KDE4_KIO_LIBS}</tt>.
  
With this file, the tutorial can built and run in the same way as tutorial 3. For more information, see tutorial 3.
+
=== Komennot ===
 +
Itse käännös, asennus ja suoritus tehdään samoin kuin oppaassa 3.
  
 
  mkdir build && cd build
 
  mkdir build && cd build
Line 383: Line 392:
 
  $HOME/bin/tutorial4
 
  $HOME/bin/tutorial4
  
==Moving On==
+
==Seuraavaksi==
Now you can move on to the [[Development/Tutorials/KCmdLineArgs|KCmdLineArgs]] tutorial.
+
Seuraavana perehdytys: [[Development/Tutorials/KCmdLineArgs|Komentoriviparametrit.]] (keskeneräinen, englanniksi)
  
 
[[Category:C++]]
 
[[Category:C++]]

Latest revision as of 09:45, 15 July 2012


Tallentaminen ja avaaminen
Tutorial Series   Beginner Tutorial
Previous   Opas 3 - KActions ja XMLGUI
What's Next   Tutorial 5 - Using KCmdLineArgs
Further Reading   KIO::NetAccess QFile

Lyhyesti

Nyt kun meillä on yksinkertainen tekstieditori, on aika tehdä siitä jollain tavalla hyödyllinen. Jokaisella tekstieditorilla pitäisi pystyä ainakin tallentamaan tehdyt työt levylle sekä avaamaan tekstitiedostoja käsittelyä varten.

KDE tarjoaa tiedostojen kanssa työskentelyä varten joukon luokkia, jotka helpottavat ohjelmistokehittäjän elämää. KIO-kirjasto mahdollistaa helpon tiedostojen käsittelyn verkkoprotokollien kautta sekä tarjoaa vakioidun tiedostovalikon tiedostojen avaamista ja tallentamista varten.

Introtokdetutorial4.png

Koodi

main.cpp

 1 #include <KApplication>
 2 #include <KAboutData>
 3 #include <KCmdLineArgs>
 4  
 5 #include "mainwindow.h"
 6  
 7 int main (int argc, char *argv[])
 8 {
 9   KAboutData aboutData( "tutorial4", "tutorial4",
10       ki18n("Tutorial 4"), "1.0",
11       ki18n("A simple text area which can load and save."),
12       KAboutData::License_GPL,
13       ki18n("Copyright (c) 2007 Developer") );
14   KCmdLineArgs::init( argc, argv, &aboutData );
15   KApplication app;
16  
17   MainWindow* window = new MainWindow();
18   window->show();
19   return app.exec();
20 }

main.cpp-tiedostoa ei ole muutettu mitenkään paitsi kaikki tutorial 3:t on vaihdettu tutorial 4:ksi.

mainwindow.h

 1 #ifndef MAINWINDOW_H
 2 #define MAINWINDOW_H
 3 
 4 #include <KXmlGuiWindow>
 5 #include <KTextEdit>
 6 
 7 class MainWindow : public KXmlGuiWindow
 8 {
 9   Q_OBJECT // *uusi*
10   
11   public:
12     MainWindow(QWidget *parent=0);
13   
14   private:
15     KTextEdit* textArea;
16     void setupActions();
17     QString fileName; // tiedoston nimi *uusi*
18 
19   private slots: // *uusi*
20     void newFile(); // uusi tiedosto *uusi*
21     void openFile(); // avaa tiedosto *uusi*  
22     void saveFile(); // tallenna tiedosto *uusi*
23     void saveFileAs(); // tallenna tiedosto nimellä *uusi*
24     void saveFileAs(const QString &outputFileName); // *uusi*
25 };
26 
27 #endif

Tiedostojen avaus- ja tallennusmahdollisuuden aikaansaamiseksi meidän tarvitsee lisätä funktiot, jotka tekevät tarvittavat asiat. Koska näitä funktoita tullaan kutsumaan Qt:n signal/slot-yhdistämismekanismin kautta, meidän on määriteltävä nämä funktiot slot:ksi. Tämä on toteutettu rivillä 19. Koska käytämme slot:a tässä otsikkotiedostossa, on myös Q_OBJECT -makro lisättävä.

Haluamme myös pitää muistissa avaamamme tiedoston nimen, joten myösmyös QString fileName on esiteltävä.

mainwindow.cpp

  1 #include "mainwindow.h"
  2 
  3 #include <KApplication>
  4 #include <KAction>
  5 #include <KLocale>
  6 #include <KActionCollection>
  7 #include <KStandardAction>
  8 #include <KFileDialog> // *uusi*
  9 #include <KMessageBox> //*uusi*
 10 #include <KIO/NetAccess> //*uusi*
 11 #include <KSaveFile> //*uusi*
 12 #include <QTextStream> //*uusi*
 13  
 14 MainWindow::MainWindow(QWidget *parent)
 15     : KXmlGuiWindow(parent),
 16       fileName(QString()) //*uusi*
 17 {
 18   textArea = new KTextEdit;
 19   setCentralWidget(textArea);
 20  
 21   setupActions();
 22 }
 23  
 24 void MainWindow::setupActions()
 25 {
 26   KAction* clearAction = new KAction(this);
 27   clearAction->setText(i18n("Clear"));
 28   clearAction->setIcon(KIcon("document-new"));
 29   clearAction->setShortcut(Qt::CTRL + Qt::Key_W);
 30   actionCollection()->addAction("clear", clearAction);
 31   connect(clearAction, SIGNAL(triggered(bool)),
 32           textArea, SLOT(clear()));
 33  
 34   KStandardAction::quit(kapp, SLOT(quit()),
 35                         actionCollection());
 36  
 37   KStandardAction::open(this, SLOT(openFile()),
 38                         actionCollection()); //*uusi*
 39  
 40   KStandardAction::save(this, SLOT(saveFile()),
 41                         actionCollection()); //*uusi*
 42  
 43   KStandardAction::saveAs(this, SLOT(saveFileAs()),
 44                         actionCollection()); //*uusi*
 45  
 46   KStandardAction::openNew(this, SLOT(newFile()),
 47                         actionCollection()); //*uusi*
 48  
 49   setupGUI();
 50 }
 51 
 52 // * uutta tästä eteenpäin *
 53 
 54 void MainWindow::newFile()
 55 {
 56   fileName.clear();
 57   textArea->clear();
 58 }
 59 
 60 void MainWindow::saveFileAs(const QString &outputFileName)
 61 {
 62   KSaveFile file(outputFileName);
 63   file.open();
 64   
 65   QByteArray outputByteArray;
 66   outputByteArray.append(textArea->toPlainText());
 67   file.write(outputByteArray);
 68   file.finalize();
 69   file.close();
 70   
 71   fileName = outputFileName;
 72 }
 73 
 74 void MainWindow::saveFileAs()
 75 {
 76   saveFileAs(KFileDialog::getSaveFileName());
 77 }
 78 
 79 void MainWindow::saveFile()
 80 {
 81   if(!fileName.isEmpty())
 82   {
 83     saveFileAs(fileName);
 84   }
 85   else
 86   {
 87     saveFileAs();
 88   }
 89 }
 90 
 91 void MainWindow::openFile()
 92 {
 93   QString fileNameFromDialog = KFileDialog::getOpenFileName();
 94 
 95   QString tmpFile;
 96   if(KIO::NetAccess::download(fileNameFromDialog, tmpFile, 
 97          this))
 98   {
 99     QFile file(tmpFile);
100     file.open(QIODevice::ReadOnly);
101     textArea->setPlainText(QTextStream(&file).readAll());
102     fileName = fileNameFromDialog;
103 
104     KIO::NetAccess::removeTempFile(tmpFile);
105   }
106   else
107   {
108     KMessageBox::error(this, 
109         KIO::NetAccess::lastErrorString());
110   }
111 }

tutorial4ui.rc

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <gui name="tutorial4"
 3      version="1"
 4      xmlns="http://www.kde.org/standards/kxmlgui/1.0"
 5      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 6      xsi:schemaLocation="http://www.kde.org/standards/kxmlgui/1.0
 7                          http://www.kde.org/standards/kxmlgui/1.0/kxmlgui.xsd" >
 8 
 9   <MenuBar>
10     <Menu name="file" >
11       <Action name="clear" />
12     </Menu>
13   </MenuBar>
14 
15   <ToolBar name="mainToolBar" >
16     <text>Main Toolbar</text>
17     <Action name="clear" />
18   </ToolBar>
19 
20 </gui>

Tämä on muuten identtinen tutorial3ui.rc kanssa, paitsi nimi on muutettu 'tutorial4':ksi. Koska kaikki uudet toiminnot ovat KStandardAction -toimintoja, joita KDE osaa automaattisesti käsitellä, tähän tiedostoon ei tarvitse lisätä mitään.

Selvitys

Selvitetään nyt hieman koodia, joka tekee avaamisen sekä ja tallentamisen. Kaikki tarvittava on sijoitettu mainwindow.cpp-tiedostoon.

Ensimmäisenä, rivillä 16, meidän pitää lisätä

fileName(QString())

MainWindow:n muodostajaan. Tällä varmistetaan, että tiedoston nimi on tyhjä aloitettaessa.

Toimintojen lisääminen

Ensinnäkin meidän pitää lisätä liittymä ohjelman ulkopuolelle, jotta käyttäjät voivat kertoa ohjelmalle, avataanko vai talletetaanko tiedosto. Käytämme tähänkin tarkoitukseen KStandardActions:a riveillä 37-47 samaan tapaan kuin oppaassa 3 toteuttaessamme lopeta-toimintoa. Kaikki uudet toiminnot on kytketty sopiviin sloteihin, jotka esittelimme otsaketiedostossa riveillä 20-24.

Uusi asiakirja

Ensimmäisenä funktio jonka loimme on newFile()-funktio.

void MainWindow::newFile()
{
  fileName.clear();
  textArea->clear();
}

fileName.clear() asettaa fileName (QString) merkkijonon tyhjäksi kuvaamaan, että tätä tiedostoa ei ole olemassa tallennettuna minnekkään. textArea->clear() tyhjentää tekstialueen käyttäen samaa KAction:n clear-funktiota johon kytkimme tyhjennä-toiminnon oppaassa 3.

Tiedoston tallentaminen

saveFileAs(QString)

Siirrymme nyt ensimmäiseen tiedostoja käsittelevään koodiin. Seuraavaksi syvennymme funktioon, jonka tehtävänä on tallentaa tekstialueen sisältö parametrina annetulla tiedostonimellä. KDE tarjoaa turvalliseen tiedoston tallentamiseen Qt:n QFile:a johdetun KSaveFile-luokan.

Funktion prototyyppi on:

void MainWindow::saveFileAs(const QString &outputFileName)

Seuraavaksi luomme KSaveFile-objektin ja avaamme sen

KSaveFile file(outputFileName);
file.open();

Nyt meillä on tiedosto, johon voimme kirjoittaa. Seuraavaksi pitää tekstialueen sisältö muotoilla muotoon, joka on mahdollista kirjoittaa tiedostoon. Tätä tarkoitusta varten luomme QByteArray:n, johon syötämme tekstialueen sisällön paljaana tekstinä (ilman muotoiluja) seuraavasti:

QByteArray outputByteArray;
outputByteArray.append(textArea->toPlainText());

Nyt meillä on KSaveFile::write():n kanssa käytettävä QByteArray valmiina. Normaalin QFile:n käyttäminen olisi myös mahdollista, ja se tallentaisi muutokset välittömästi. Jos tällöin kuitenkin tapahtuisi jokin virhe tallentamisen aikana, tulisi tiedostosta viallinen. Tästä syystä KSaveFile luo ensin väliaikaisen tiedoston, ja varsinainen tiedosto luodaan vasta kun kutsutaan KSaveFile::finalize()-funktiota.

file.write(outputByteArray);
file.finalize();
file.close();

Ja lopuksi asetetaan MainWindows:n fileName osoittamaan tiedostoon, jonka juuri tallensimme:

fileName = outputFileName;

saveFileAs()

Tähän funktioon on yhdistetty saveAs(Tallenna nimellä) toiminto. Tämä funktio kutsuu saveFileAs(QString)-funktiota, jolle lähetetään parametrinä KFileDialog::getSaveFileName():n palauttama tiedoston nimi.

void MainWindow::saveFileAs()
{
  saveFileAs(KFileDialog::getSaveFileName());
}

Tässä kohdassa käytämme ensimmäisen kerran KIO-kirjastoa. KFileDialog-luokka tarjoaa meille joukon funktioita, joita kaikki KDE ohjelmat käyttävät yleisten tiedostovalikoiden näyttämiseen. KFileDialog::getSaveFileName()-funktion kutsuminen tuo esille tiedostovalikon,jossa käyttäjä voi valita tai vaihtaa tiedoston nimeä tai tallennussijaintia. Funktio palauttaa täydellisen tiedoston nimen, jonka me välitimme saveFileAs(QString)-funktiolle.

saveFile()

void MainWindow::saveFile()
{
  if(!fileName.isEmpty())
  {
    saveFileAs(fileName);
  }
  else
  {
    saveFileAs();
  }
}

Tässä funktiossa ei ole mitään erityistä tai uutta. Tässä vain päätellään, näytetäänkö tallennusvalikko vai ei. Jos fileName ei ole tyhjä, tallennetaan tiedosto mitään kysymättä nimellä, joka on sijoitettuna fileName:n kutsumalla saveFileAs(QString)-funktiota, muuten kutsutaan yllä olevaa saveFileAs()-funktiota.

Tiedoston avaaminen

Lopulta olemme valmiita tarkastelemaan tiedoston avaamista levyltä. Kaikki koodi tätä tarkoitusta varten on sijoitettu MainWindow::openFile()-funktioon.

Ensin meidän pitää kysyä käyttäjältä, mikä tiedosto halutaan avata. Tätä tarkoitusta varten käytetään toista KFileDialog-funktiota, getOpenFileName():

QString fileNameFromDialog = KFileDialog::getOpenFileName();

Seuraavaksi käytämme KIO-kirjastoa tiedoston avaamiseen. KIO-kirjaston avulla voimme avata tiedoston QFilen avulla, paikalliselta levyltä tai etäkoneelta, vaikkapa FTP:n yli. Tiedoston avaamiseksi käytämme NetAccess:n download()-funktiota:

KIO::NetAccess::download(fileNameFromDialog, tmpFile, this)

Ensimmäinen argumentti on avattavan tiedoston nimi. Toinen on QString, joka tiedoston hakemisen jälkeen sisältää väliaikaisen tiedoston sijainnin. Tämän tmpFile:n kanssa jatkamme tästä eteenpäin.

Funktio palauttaa boolen arvon tosi tai epätosi, riippuen onnistuiko tiedoston siirto. Jos tiedoston haku epäonnistui, näytetään virheilmoitus:

KMessageBox::error(this, KIO::NetAccess::lastErrorString());

Muussa tapauksessa jatketaan tiedoston avaamista.

Luomme uuden QFile:n välittämällä sen muodostajaan NetAccess::download():n luoman väliaikaistiedoston, minkä jälkeen avataan se kirjoitussuojattuna:

QFile file(tmpFile);
file.open(QIODevice::ReadOnly);

Tuodaksemme avaamamme tiedoston sisällön ruudulle näkyviin, tarvitsee meidän käyttää QTextStream-luokkaa. QTextStream:n muodostajalle välitämme äsken avaamamme tiedoston (QFile file) ja kutsumme QFile:n readAll()-funktiota saadaksemme tekstin tiedostosta. Seuraavaksi välitämme tämän kaiken tekstialueen setPlainText()-funktiolle:

textArea->setPlainText(QTextStream(&file).readAll());

Tallennetaan avatun tiedoston nimi(polkuineen):

fileName = fileNameFromDialog;

Ja lopuksi poistetaan NetAccess::download():n luoma väliaikaistiedosto:

KIO::NetAccess::removeTempFile(tmpFile);

Käännä, Asenna ja Suorita

CMakeLists.txt

 1 project(tutorial4)
 2  
 3 find_package(KDE4 REQUIRED)
 4 include_directories(${KDE4_INCLUDES})
 5  
 6 set(tutorial4_SRCS 
 7   main.cpp
 8   mainwindow.cpp
 9 )
10  
11 kde4_add_executable(tutorial4 ${tutorial4_SRCS})
12  
13 target_link_libraries(tutorial4 ${KDE4_KDEUI_LIBS} 
14                                 ${KDE4_KIO_LIBS})
15  
16 install(TARGETS tutorial4 DESTINATION ${BIN_INSTALL_DIR})
17 install(FILES tutorial4ui.rc 
18         DESTINATION ${DATA_INSTALL_DIR}/tutorial4)

Koska otimme nyt KIO-kirjaston käyttöön, täytyy CMakelle kertoa, että linkittäjän tarvitsee ottaa myös tämä mukaan. Tätä varten lisäämme target_link_libraries()-funktioon tiedon ${KDE4_KIO_LIBS}.

Komennot

Itse käännös, asennus ja suoritus tehdään samoin kuin oppaassa 3.

mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=$HOME
make install
$HOME/bin/tutorial4

Seuraavaksi

Seuraavana perehdytys: Komentoriviparametrit. (keskeneräinen, englanniksi)


This page was last edited on 15 July 2012, at 09:45. Content is available under Creative Commons License SA 4.0 unless otherwise noted.