Differential D15313 Diff 41099 src/acbf/AcbfReference.h

Changeset View

Standalone View

src/acbf/AcbfReference.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 ACBFREFERENCE_H
23		#define ACBFREFERENCE_H
24
25		#include <QObject>
26		#include <memory>
27
28		#include "acbf_export.h"
29		class QXmlStreamWriter;
30		class QXmlStreamReader;
31
32
33		namespace AdvancedComicBookFormat
34		{
35		/**
36		* \brief a Class to handle a single ACBF reference.
37		*
38		*/
39		class References;
40		class ACBF_EXPORT Reference : public QObject
41		{
42		Q_OBJECT
43
44		public:
45		explicit Reference(References* parent = nullptr);
46		~Reference() override;
47
48		/**
49		* \brief Write the textarea into the xml writer.
	leinirUnsubmitted Done Not a textarea... :) leinir: Not a textarea... :)
50		*/
51		void toXml(QXmlStreamWriter* writer);
52		/**
53		* \brief load a textarea element into this object.
54		* @return True if the xmlReader encountered no errors.
55		*/
56		bool fromXml(QXmlStreamReader *xmlReader);
57
58		/**
59		* @return The ID of this reference data element as a QString.
60		* Used to identify it from other parts of the
61		* ACBF document.
62		*/
63		QString id() const;
64
65		/**
66		* \brief Set the ID for this reference element.
67		* This is used to reference this element from
68		* other parts of the ACBF document.
69		* @param newId - The new ID as a string.
70		*/
71		void setId(const QString& newId);
72
73		/**
74		* @returns the language for this reference.
75		*/
76		QString language() const;
77		/**
78		* \brief set the language for this reference.
79		* @param language - the language of the entry in language code, country
80		* code format joined by a dash (not an underscore).
81		*/
82		void setLanguage(const QString& language);
83
84		/**
85		* @returns a list of paragraphs.
86		*
87		* Contains allowed sub-elements: strong, emphasis, strikethrough
88		* sub, sup, a (with mandatory href attribute only)
89		* Can also contain deprecated sub-elements (superceded by...): code (type option code),
90		* inverted (textarea option inverted)
91		*/
92		QStringList paragraphs() const;
93		/**
94		* \brief set the list of paragraphs for this reference.
95		* @param paragraphs - a list of paragraphs. Can contain sub-elements:
96		* strong, emphasis, strikethrough, sub, sup, a (with mandatory href attribute only)
97		*/
98		void setParagraphs(const QStringList& paragraphs);
99		private:
100		class Private;
101		std::unique_ptr<Private> d;
102		};
103		}
104
105		#endif // ACBFREFERENCE_H