File indexing completed on 2024-05-05 03:40:59

0001 /***************************************************************************
0002  *   Copyright (C) 2002 by Gunnar Schmi Dt <kmouth@schmi-dt.de             *
0003  *             (C) 2015,2022 by Jeremy Whiting <jpwhiting@kde.org>         *
0004  *                                                                         *
0005  *   This program is free software; you can redistribute it and/or modify  *
0006  *   it under the terms of the GNU General Public License as published by  *
0007  *   the Free Software Foundation; either version 2 of the License, or     *
0008  *   (at your option) any later version.                                   *
0009  *                                                                         *
0010  *   This program is distributed in the hope that it will be useful,       *
0011  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
0012  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
0013  *   GNU General Public License for more details.                          *
0014  *                                                                         *
0015  *   You should have received a copy of the GNU General Public License     *
0016  *   along with this program; if not, write to the                         *
0017  *   Free Software Foundation, Inc.,                                       *
0018  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.          *
0019  ***************************************************************************/
0020 
0021 #ifndef PHRASEBOOKREADER_H
0022 #define PHRASEBOOKREADER_H
0023 
0024 #include <QXmlStreamReader>
0025 
0026 #include "phrasebook.h"
0027 
0028 /**
0029  * This class implements a reader for both the phrase list and for phrase
0030  * books. Pass a QIODevice to read check the return value and get the list.
0031  */
0032 
0033 class PhraseBookReader
0034 {
0035 public:
0036     PhraseBookReader();
0037     ~PhraseBookReader();
0038 
0039     bool read(QIODevice *device);
0040 
0041     QString errorString() const;
0042 
0043     /** returns a list of phrase book entries */
0044     PhraseBookEntryList getPhraseList();
0045 
0046 private:
0047     // Read an entire book
0048     void readbook();
0049 
0050     // Read a phrase
0051     void readphrase();
0052 
0053     PhraseBookEntryList list;
0054     QXmlStreamReader xml;
0055 
0056     int level;
0057     bool starting;
0058 };
0059 
0060 #endif