Differential D15313 Diff 41099 src/acbf/AcbfReferences.h

Changeset View

Standalone View

src/acbf/AcbfReferences.h

This file was added.

1		/*
2		* Copyright 2018 Wolthera van Hövell tot Westerflier <griffinvalley@gmail.com>
3		*
4		* This library is free software; you can redistribute it and/or
5		* modify it under the terms of the GNU Lesser General Public
6		* License as published by the Free Software Foundation; either
7		* version 2.1 of the License, or (at your option) version 3, or any
8		* later version accepted by the membership of KDE e.V. (or its
9		* successor approved by the membership of KDE e.V.), which shall
10		* act as a proxy defined in Section 6 of version 3 of the license.
11		*
12		* This library is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15		* Lesser General Public License for more details.
16		*
17		* You should have received a copy of the GNU Lesser General Public
18		* License along with this library. If not, see <http://www.gnu.org/licenses/>.
19		*
20		*/
21
22		#ifndef ACBFREFERENCES_H
23		#define ACBFREFERENCES_H
24
25		#include <memory>
26
27		#include "AcbfDocument.h"
28		#include "AcbfReference.h"
29		#include <QObject>
30		#include <QXmlStreamReader>
31
32
33		namespace AdvancedComicBookFormat
34		{
35
36		class ACBF_EXPORT References : public QObject
	leinirUnsubmitted Done Missing a description of what References are leinir: Missing a description of what References are
37		{
38		Q_OBJECT
39
40		public:
41		explicit References(Document* parent = nullptr);
42		~References() override;
43
44		/**
45		* \brief Write the textarea into the xml writer.
	leinirUnsubmitted Done this isn't a textarea, though... ;) (same in fromXml below) leinir: this isn't a textarea, though... ;) (same in fromXml below)
46		*/
47		void toXml(QXmlStreamWriter* writer);
48		/**
49		* \brief load a textarea element into this object.
50		* @return True if the xmlReader encountered no errors.
51		*/
52		bool fromXml(QXmlStreamReader *xmlReader);
53
54		/**
55		* @param id - the id that is used to reference to this object.
56		* @return the reference object referenced by this id.
57		*/
58		Reference* reference(const QString& id) const;
59
60		/**
61		* @brief Add reference at ID.
62		*
63		* @param id The id that will refer to this reference.
64		* @param paragraphs The paragraphs comprising this reference.
65		* @param language The language (optional, and 1.2 only)
66		*/
67		void setReference(const QString& id, const QStringList& paragraphs, const QString& language = "");
68
69		private:
70		class Private;
71		std::unique_ptr<Private> d;
72		};
73		}
74
75		#endif // ACBFREFERENCES_H