Since we want to add the ability to load and save files, we must add the functions which will do the work. Since the functions will be called through Qt's [http://doc.trolltech.com/latest/signalsandslots.html signal/slot] mechanism we must specify that these functions are slots as we do on line 19. Since we are using slots in this header file, we must also add the [http://doc.trolltech.com/latest/qobject.html#Q_OBJECT <tt>Q_OBJECT</tt>] macro.

Since we want to add the ability to load and save files, we must add the functions which will do the work. Since the functions will be called through Qt's [http://doc.trolltech.com/latest/signalsandslots.html signal/slot] mechanism we must specify that these functions are slots as we do on line 19. Since we are using slots in this header file, we must also add the [http://doc.trolltech.com/latest/qobject.html#Q_OBJECT <tt>Q_OBJECT</tt>] macro.

Line 84:

Line 84:

===mainwindow.cpp===

===mainwindow.cpp===

−

<code cppqt n>

+

<syntaxhighlight lang="cpp-qt">

#include "mainwindow.h"

#include "mainwindow.h"

Line 180:

Line 180:

QString tmpFile;

QString tmpFile;

−

if(KIO::NetAccess::download(fileNameFromDialog, tmpFile,

+

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

−

this))

+

{

{

QFile file(tmpFile);

QFile file(tmpFile);

Line 196:

Line 195:

}

}

}

}

−

</code>

+

</syntaxhighlight>

===tutorial4ui.rc===

===tutorial4ui.rc===

−

<code xml n>

+

<syntaxhighlight lang="xml">

<?xml version="1.0" encoding="UTF-8"?>

<?xml version="1.0" encoding="UTF-8"?>

<gui name="tutorial4"

<gui name="tutorial4"

Line 220:

Line 219:

</gui>

</gui>

−

</code>

+

</syntaxhighlight>

This is identical to <tt>tutorial3ui.rc</tt> from tutorial 3 except the <tt>name</tt> has changed to 'tutorial4'. We do not need to add any information about any of the <tt>KStandardAction</tt>s since the placement of those actions is handled automatically by KDE.

This is identical to <tt>tutorial3ui.rc</tt> from tutorial 3 except the <tt>name</tt> has changed to 'tutorial4'. We do not need to add any information about any of the <tt>KStandardAction</tt>s since the placement of those actions is handled automatically by KDE.

Line 227:

Line 226:

Okay, now to implement the code that will do the loading and saving. This will all be happening in <tt>mainwindow.cpp</tt>

Okay, now to implement the code that will do the loading and saving. This will all be happening in <tt>mainwindow.cpp</tt>

−

The first thing we do is add

+

The first thing we do is add <tt>fileName(QString())</tt> to the <tt>MainWindow</tt> constructor list on line 16. This makes sure that <tt>fileName</tt> is empty right from the beginning.

−

<code cppqt>

+

−

fileName(QString())

+

−

</code>

+

−

to the <tt>MainWindow</tt> constructor list on line 16. This makes sure that <tt>fileName</tt> is empty right from the beginning.

+

===Adding the actions===

===Adding the actions===

Line 240:

Line 235:

The first function we create is the <tt>newFile()</tt> function.

The first function we create is the <tt>newFile()</tt> function.

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

void MainWindow::newFile()

void MainWindow::newFile()

{

{

Line 246:

Line 241:

textArea->clear();

textArea->clear();

}

}

−

</code>

+

</syntaxhighlight>

<tt>fileName.clear()</tt> sets the <tt>fileName</tt> QString to be empty to reflect the fact that this document does not yet have a presence on disc. <tt>textArea->clear()</tt> then clears the central text area using the same function that we connected the <tt>clear</tt> <tt>KAction</tt> to in tutorial 3.

<tt>fileName.clear()</tt> sets the <tt>fileName</tt> QString to be empty to reflect the fact that this document does not yet have a presence on disc. <tt>textArea->clear()</tt> then clears the central text area using the same function that we connected the <tt>clear</tt> <tt>KAction</tt> to in tutorial 3.

Line 256:

Line 251:

The function's prototype is

The function's prototype is

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

void MainWindow::saveFileAs(const QString &outputFileName)

void MainWindow::saveFileAs(const QString &outputFileName)

−

</code>

+

</syntaxhighlight>

We then create our <tt>KSaveFile</tt> object and open it with

We then create our <tt>KSaveFile</tt> object and open it with

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

KSaveFile file(outputFileName);

KSaveFile file(outputFileName);

file.open();

file.open();

−

</code>

+

</syntaxhighlight>

Now that we have our file to write to, we need to format the text in the text area to a format which can be written to file. For this, we create a {{qt|QByteArray}} and fill it with the plain text version of whatever is in the text area:

Now that we have our file to write to, we need to format the text in the text area to a format which can be written to file. For this, we create a {{qt|QByteArray}} and fill it with the plain text version of whatever is in the text area:

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

QByteArray outputByteArray;

QByteArray outputByteArray;

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

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

−

</code>

+

</syntaxhighlight>

Now that we have our <tt>QByteArray</tt>, we use it to write to the file with <tt>KSaveFile::write()</tt>. If we were using a normal <tt>QFile</tt>, this would make the changes immediately. However, if a problem occurred partway through writing, the file would become corrupted. For this reason, <tt>KSaveFile</tt> works by first writing to a temporary file and then, when you call <tt>KSaveFile::finalize()</tt> the changes are made to the actual file.

Now that we have our <tt>QByteArray</tt>, we use it to write to the file with <tt>KSaveFile::write()</tt>. If we were using a normal <tt>QFile</tt>, this would make the changes immediately. However, if a problem occurred partway through writing, the file would become corrupted. For this reason, <tt>KSaveFile</tt> works by first writing to a temporary file and then, when you call <tt>KSaveFile::finalize()</tt> the changes are made to the actual file.

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

file.write(outputByteArray);

file.write(outputByteArray);

file.finalize();

file.finalize();

file.close();

file.close();

−

</code>

+

</syntaxhighlight>

Finally, we set <tt>MainWindows</tt>'s <tt>fileName</tt> member to point to the file name we just saved to.

Finally, we set <tt>MainWindows</tt>'s <tt>fileName</tt> member to point to the file name we just saved to.

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

fileName = outputFileName;

fileName = outputFileName;

−

</code>

+

</syntaxhighlight>

====saveFileAs()====

====saveFileAs()====

Line 286:

Line 281:

This is the function that the <tt>saveAs</tt> slot is connected to. It simply calls the generic <tt>saveFileAs(QString)</tt> function and passes the file name returned by <tt>{{class|KFileDialog}}::[http://api.kde.org/4.0-api/kdelibs-apidocs/kio/html/classKFileDialog.html#8891356c249c5911e1ab15cc2739a89b getSaveFileName()]</tt>.

This is the function that the <tt>saveAs</tt> slot is connected to. It simply calls the generic <tt>saveFileAs(QString)</tt> function and passes the file name returned by <tt>{{class|KFileDialog}}::[http://api.kde.org/4.0-api/kdelibs-apidocs/kio/html/classKFileDialog.html#8891356c249c5911e1ab15cc2739a89b getSaveFileName()]</tt>.

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

void MainWindow::saveFileAs()

void MainWindow::saveFileAs()

{

{

saveFileAs(KFileDialog::getSaveFileName());

saveFileAs(KFileDialog::getSaveFileName());

}

}

−

</code>

+

</syntaxhighlight>

This is our first actual use of the KIO library. {{class|KFileDialog}} provides a number of static functions for displaying the common file dialog that is used by all KDE applications. Calling <tt>KFileDialog::getSaveFileName()</tt> will display a dialog where the user can select the name of the file to save to or choose a new name. The function returns the full file name, which we then pass to <tt>saveFileAs(QString)</tt>.

This is our first actual use of the KIO library. {{class|KFileDialog}} provides a number of static functions for displaying the common file dialog that is used by all KDE applications. Calling <tt>KFileDialog::getSaveFileName()</tt> will display a dialog where the user can select the name of the file to save to or choose a new name. The function returns the full file name, which we then pass to <tt>saveFileAs(QString)</tt>.

Line 297:

Line 292:

====saveFile()====

====saveFile()====

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

void MainWindow::saveFile()

void MainWindow::saveFile()

{

{

Line 309:

Line 304:

}

}

}

}

−

</code>

+

</syntaxhighlight>

There's nothing exciting or new in this function, just the logic to decide whether or not to show the save dialog. If <tt>fileName</tt> is not empty, then the file is saved to <tt>fileName</tt>. But if it is, then the dialog is shown to allow the user to select a file name.

There's nothing exciting or new in this function, just the logic to decide whether or not to show the save dialog. If <tt>fileName</tt> is not empty, then the file is saved to <tt>fileName</tt>. But if it is, then the dialog is shown to allow the user to select a file name.

Line 318:

Line 313:

First we must ask the user for the name of the file they wish to open. We do this using another one of the <tt>KFileDialog</tt> functions, this time <tt>getOpenFileName()</tt>:

First we must ask the user for the name of the file they wish to open. We do this using another one of the <tt>KFileDialog</tt> functions, this time <tt>getOpenFileName()</tt>:

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

QString fileNameFromDialog = KFileDialog::getOpenFileName();

QString fileNameFromDialog = KFileDialog::getOpenFileName();

−

</code>

+

</syntaxhighlight>

Then we use the KIO library to retrieve our file. This allows us to open the file with QFile even if it's stored in a remote location like an FTP site. We make the following call to {{class|NetAccess}}'s <tt>download()</tt> function

Then we use the KIO library to retrieve our file. This allows us to open the file with QFile even if it's stored in a remote location like an FTP site. We make the following call to {{class|NetAccess}}'s <tt>download()</tt> function

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

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

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

−

</code>

+

</syntaxhighlight>

The first argument is the name of the file you wish to download. The second is a QString which, after the download is complete, will contain the location of the temporary copy of the file. It is this <tt>tmpFile</tt> we will work with from now on.

The first argument is the name of the file you wish to download. The second is a QString which, after the download is complete, will contain the location of the temporary copy of the file. It is this <tt>tmpFile</tt> we will work with from now on.

The function returns <tt>true</tt> or <tt>false</tt> depending on whether the transfer was successful. If it failed, we display a message box giving the error:

The function returns <tt>true</tt> or <tt>false</tt> depending on whether the transfer was successful. If it failed, we display a message box giving the error:

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

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

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

−

</code>

+

</syntaxhighlight>

Otherwise, we continue with opening the file.

Otherwise, we continue with opening the file.

We create a QFile by passing the temporary file created by <tt>NetAccess::download()</tt> to its constructor and then open it in read-only mode

We create a QFile by passing the temporary file created by <tt>NetAccess::download()</tt> to its constructor and then open it in read-only mode

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

QFile file(tmpFile);

QFile file(tmpFile);

file.open(QIODevice::ReadOnly);

file.open(QIODevice::ReadOnly);

−

</code>

+

</syntaxhighlight>

In order to display the contents of the file, we must use a {{qt|QTextStream}}. We create one by passing the contents of our file to its constructor and then call QFile's <tt>readAll()</tt> function to get the text from the file. This is then passed to the <tt>setPlainText()</tt> function of our text area.

In order to display the contents of the file, we must use a {{qt|QTextStream}}. We create one by passing the contents of our file to its constructor and then call QFile's <tt>readAll()</tt> function to get the text from the file. This is then passed to the <tt>setPlainText()</tt> function of our text area.

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

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

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

−

</code>

+

</syntaxhighlight>

We then store the path of the file we just opened:

We then store the path of the file we just opened:

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

fileName = fileNameFromDialog;

fileName = fileNameFromDialog;

−

</code>

+

</syntaxhighlight>

and finally, we remove the temporary file that was created by <tt>NetAccess::download()</tt>:

and finally, we remove the temporary file that was created by <tt>NetAccess::download()</tt>:

−

<code cppqt>

+

<syntaxhighlight lang="cpp-qt">

KIO::NetAccess::removeTempFile(tmpFile);

KIO::NetAccess::removeTempFile(tmpFile);

−

</code>

+

</syntaxhighlight>

==Make, Install And Run==

==Make, Install And Run==

===CMakeLists.txt===

===CMakeLists.txt===

−

<code ini n>

+

<syntaxhighlight lang="cmake">

project(tutorial4)

project(tutorial4)

Line 378:

Line 373:

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.

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.

With this file, the tutorial can be built and run in the same way as tutorial 3. For more information, see tutorial 3.

With this file, the tutorial can be built and run in the same way as tutorial 3. For more information, see tutorial 3.

−

<code>

+

<syntaxhighlight lang="bash">

mkdir build && cd build

mkdir build && cd build

cmake .. -DCMAKE_INSTALL_PREFIX=$HOME

cmake .. -DCMAKE_INSTALL_PREFIX=$HOME

make install

make install

$HOME/bin/tutorial4

$HOME/bin/tutorial4

−

</code>

+

</syntaxhighlight>

{{note|Changed settings are saved in your KDE directory, in this case into $HOME/.kde/share/apps/tutorial4.}}

{{note|Changed settings are saved in your KDE directory, in this case into $HOME/.kde/share/apps/tutorial4.}}

Now that we have a basic text editor interface, it's time to make it do something useful. At the most basic, a text editor needs to be able to load files from disc, save files that you've created/edited and create new files.

KDE provides a number of classes for working with files which make life a lot easier for developers. The KIO library allows you to easily access files through network-transparent protocols as well as providing standard file dialogs.

Since we want to add the ability to load and save files, we must add the functions which will do the work. Since the functions will be called through Qt's signal/slot mechanism we must specify that these functions are slots as we do on line 19. Since we are using slots in this header file, we must also add the Q_OBJECT macro.

We also want to keep track of the filename of the currently opened file so we declare a QString fileName.

This is identical to tutorial3ui.rc from tutorial 3 except the name has changed to 'tutorial4'. We do not need to add any information about any of the KStandardActions since the placement of those actions is handled automatically by KDE.

The first thing we are going to do is provide the outward interface for the user so they can tell the application to load and save. Like with the quit action in tutorial 3, we will use KStandardActions. On lines 37 to 47 we add the actions in the same way as for the quit action. For each one, we connect it to the appropriate slot that we declared in the header file.

fileName.clear() sets the fileName QString to be empty to reflect the fact that this document does not yet have a presence on disc. textArea->clear() then clears the central text area using the same function that we connected the clearKAction to in tutorial 3.

Now we get onto our first file handling code. We're going to implement a function which will save the contents of the text area to the file name given as a parameter. KDE provides a class for safely saving a file called KSaveFile which is derived from Qt's QFile.

The function's prototype is

void MainWindow::saveFileAs(constQString&outputFileName)

We then create our KSaveFile object and open it with

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

Now that we have our file to write to, we need to format the text in the text area to a format which can be written to file. For this, we create a QByteArray and fill it with the plain text version of whatever is in the text area:

Now that we have our QByteArray, we use it to write to the file with KSaveFile::write(). If we were using a normal QFile, this would make the changes immediately. However, if a problem occurred partway through writing, the file would become corrupted. For this reason, KSaveFile works by first writing to a temporary file and then, when you call KSaveFile::finalize() the changes are made to the actual file.

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

Finally, we set MainWindows's fileName member to point to the file name we just saved to.

This is our first actual use of the KIO library. KFileDialog provides a number of static functions for displaying the common file dialog that is used by all KDE applications. Calling KFileDialog::getSaveFileName() will display a dialog where the user can select the name of the file to save to or choose a new name. The function returns the full file name, which we then pass to saveFileAs(QString).

There's nothing exciting or new in this function, just the logic to decide whether or not to show the save dialog. If fileName is not empty, then the file is saved to fileName. But if it is, then the dialog is shown to allow the user to select a file name.

Finally, we get round to being able to load a file from disc. The code for this is all contained in MainWindow::openFile().

First we must ask the user for the name of the file they wish to open. We do this using another one of the KFileDialog functions, this time getOpenFileName():

QString fileNameFromDialog = KFileDialog::getOpenFileName();

Then we use the KIO library to retrieve our file. This allows us to open the file with QFile even if it's stored in a remote location like an FTP site. We make the following call to NetAccess's download() function

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

The first argument is the name of the file you wish to download. The second is a QString which, after the download is complete, will contain the location of the temporary copy of the file. It is this tmpFile we will work with from now on.

The function returns true or false depending on whether the transfer was successful. If it failed, we display a message box giving the error:

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

Otherwise, we continue with opening the file.

We create a QFile by passing the temporary file created by NetAccess::download() to its constructor and then open it in read-only mode

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

In order to display the contents of the file, we must use a QTextStream. We create one by passing the contents of our file to its constructor and then call QFile's readAll() function to get the text from the file. This is then passed to the setPlainText() function of our text area.

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

We then store the path of the file we just opened:

fileName = fileNameFromDialog;

and finally, we remove the temporary file that was created by NetAccess::download():