Archive:Development/Tutorials/Saving and loading (zh TW)

Jump to: navigation, search

Template:I18n/Language Navigation Bar (zh TW)

Template:TutorialBrowser (zh TW)

摘要

現在我們擁有了一個基本的文字編輯器界面,開始要讓他做一些有用的事情了。最根本的來說,一個文字編輯器需要能夠從硬碟中載入檔案,儲存你新增或編輯過的檔案。

KDE 提供了許多讓開發者能輕鬆操作檔案的類別。KIO 函式庫讓你可以十分容易地透過網路協定訪問檔案,而且提供標準的檔案對話框。

Introtokdetutorial4.png

程式碼

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 與教學3中的相比沒什麼變化,除了說明參數從 tutorial 3 變為了 tutorial 4。

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 //與教學3相比,新增加的
10   
11   public:
12     MainWindow(QWidget *parent=0);
13   
14   private:
15     KTextEdit* textArea;
16     void setupActions();
17     QString fileName; //新增的
18 
19   private slots: //新增的
20     void newFile(); //新增的
21     void openFile(); //新增的
22     void saveFile(); //新增的
23     void saveFileAs(); //新增的
24     void saveFileAs(const QString &outputFileName); //新增的
25 };
26 
27 #endif

由於我們想要加上載入和儲存檔案的能力,所以我們必須加入用來完成這些工作的函式。由於這些函式將會透過 Qt 的 訊號/槽(signal/slot) 機制被呼叫,所以我們必須註明這些函數是槽(slots),就像我們在第19行做的那樣。由於我們在標頭檔中使用槽,所以我們同樣必須加入Q_OBJECT 巨集。

我們同樣想要跟踪當前打開檔案的名稱,所以我們宣告了一個 QString fileName 。

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> //新增的
  9 #include <KMessageBox> //新增的
 10 #include <KIO/NetAccess> //新增的
 11 #include <KSaveFile> //新增的
 12 #include <QTextStream> //新增的
 13  
 14 MainWindow::MainWindow(QWidget *parent)
 15     : KXmlGuiWindow(parent),
 16       fileName(QString()) //新增的
 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()); //新增的
 39  
 40   KStandardAction::save(this, SLOT(saveFile()),
 41                         actionCollection()); //新增的
 42  
 43   KStandardAction::saveAs(this, SLOT(saveFileAs()),
 44                         actionCollection()); //新增的
 45  
 46   KStandardAction::openNew(this, SLOT(newFile()),
 47                         actionCollection()); //新增的
 48  
 49   setupGUI();
 50 }
 51 
 52 //從這裡開始都是新增加的
 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().toUtf8());
 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>

這和教學 3 的 tutorial3ui.rc 相同,除了 name 改為 'tutorial4' 以外。我們不需要加入任何 KStandardAction 的資訊來安置這些動作,KDE 會自動處理。

解釋

Okay,現在實現的程式碼將執行載入和儲存。這都實做在 mainwindow.cpp

首先我們加入

fileName(QString())

MainWindow 建構子列表的第16行。這可以確保 fileName一開始是空的。

加入動作

我們首先要做的是為使用者提供操作介面,使他們能夠告訴應用程式載入和儲存。類似教學3的 quit 動作,我們將使用 KStandardActions。在37至47行,我們用和 quit 動作同樣的方式加入動作。我們將每一項連接到適當的槽,並宣告在標頭檔中。

建立新文件

我們第一個建立的函數是 newFile()

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

fileName.clear() 會設定 fileName QString 是空的,以反映該文件還沒有存在於硬碟的事實。textArea->clear() 會清除中央的文字區塊,使用在教學3我們連接 clear KAction 的相同功能函式。

儲存檔案

saveFileAs(QString)

現在,我們有了第一個檔案處理的程式碼。我們將實現一個函數,它將儲存文字區塊內容的檔案名給作為參數。KDE 提供了一個安全儲存檔案名的KSaveFile類別,來自 Qt 的QFile

該函數的原型是

void MainWindow::saveFileAs(const QString &outputFileName)

然後,我們建立 KSaveFile 物件,並使用以下程式碼打開它

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

現在,我們有檔案寫入,我們需要格式化在文字區塊中的文字,為可以被寫入檔案的格式。因此,我們建立了一個 QByteArray 並填寫它,和任何在文字區塊中的純文字版本:

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

現在,我們有了 QByteArray,使用它和 KSaveFile::write() 寫入檔案。如果我們使用普通的 QFile,這將立即進行更改。但是,如果寫入中發生問題,該檔案將會損壞。為此,KSaveFile會先寫入文字到一個臨時檔案,然後,當你調用KSaveFile::finalize()再改變實際的檔案。

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

最後,我們設定 MainWindowsfileName 成員指向我們剛剛儲存的檔案名。

fileName = outputFileName;

saveFileAs()

這是一個連接 saveAs 槽的函式。它只是呼叫一般的 saveFileAs(QString) 函式並傳遞 KFileDialog::getSaveFileName() 返回的檔案名。

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

這是我們第一次實際使用 KIO 函式庫。KFileDialog 提供了一些顯示常見的檔案對話框的靜態函數。呼叫 KFileDialog::getSaveFileName() 將顯示一個對話框,使用者可以選擇已儲存的檔案名稱或選擇一個新名稱。該函式返回完整的檔案名稱,我們再傳遞到saveFileAs(QString)

saveFile()

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

這個沒有什麼令人興奮的新功能,只是決定是否顯示儲存對話框。如果fileName不為空,則該檔案儲存到 fileName。但是,如果是空的話,這個對話框會讓用戶選擇檔案名。

載入檔案

最後,載入硬碟的檔案的功能。所有程式碼,包含在 MainWindow::openFile()

首先,我們必須詢問使用者他們希望打開的檔案名稱。我們是用另一個 KFileDialog 的函式,這次用 getOpenFileName()

QString fileNameFromDialog = KFileDialog::getOpenFileName();

然後,我們使用 KIO 函式庫來檢索檔案。這使我們能夠用 QFile 打開檔案,即使它儲存在遠端例如 FTP 網站。我們呼叫 NetAccessdownload() 函數

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

第一個參數是您要下載檔案的名稱。第二個是僅次於下載完成後的 QString,將包含檔案暫時備份的位置。我們將從現在開始工作這個 tmpFile

該函數返回 truefalse 取決於轉換是否成功。如果失敗,我們顯示一個訊息框提供錯誤:

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

否則,我們繼續打開檔案。

我們傳遞 NetAccess::download() 建立的臨時檔案,給新建立 QFile 的建構子,然後在唯讀模式打開它

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

為了顯示檔案的內容,我們必須使用QTextStream。建立他並將傳遞的檔案的內容給它的建構子,然呼叫 QFile 的 readAll() 函式從檔案中取得文字。然後傳遞給文字區塊的 setPlainText() 函式。

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

然後,存儲我們剛才打開檔案的路徑:

fileName = fileNameFromDialog;

最後,刪除 NetAccess::download() 建立的臨時檔案:

KIO::NetAccess::removeTempFile(tmpFile);

編譯、安裝與執行

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)

由於我們使用 KIO 函式庫,我們必須告訴 CMake 鏈接。我們這樣做,傳遞 ${KDE4_KIO_LIBS}target_link_libraries() 函式。

有了這個檔案,該教學可以用和教學3相同的方式建構和執行。有關更多資訊,請參閱教學3。

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

Template:Note (zh TW)

繼續前進

現在你可以開始學習下一課:KCmdLineArgs 教學。


This page was last modified on 23 June 2013, at 13:26. Content is available under Creative Commons License SA 3.0 as well as the GNU Free Documentation License 1.2 unless otherwise noted.