Differential D22968 Diff 63191 src/backends/abstracteditablecontact.h

Changeset View

Standalone View

src/backends/abstracteditablecontact.h

This file was added.

1		/*
2		Copyright (C) 2019 Aleix Pol i Gonzalez <aleixpol@blue-systems.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) any later version.
8
9		This library is distributed in the hope that it will be useful,
10		but WITHOUT ANY WARRANTY; without even the implied warranty of
11		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12		Lesser General Public License for more details.
13
14		You should have received a copy of the GNU Lesser General Public
15		License along with this library; if not, write to the Free Software
16		Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17		*/
18
19		#ifndef KPEOPLE_ABSTRACT_EDITABLE_CONTACT_H
20		#define KPEOPLE_ABSTRACT_EDITABLE_CONTACT_H
21
22		#include "abstractcontact.h"
23		#include <kpeoplebackend/kpeoplebackend_export.h>
24
25		namespace KPeople
26		{
27		/**
28		* @brief Additionally to @class AbstractContact features, it will allow us
29		* to suggest the backend property values for a said key.
30		*
31		* @since 5.60
32		* @internal
	bshahUnsubmitted Done Since 5.62 bshah: Since 5.62
33		*/
34
35		class KPEOPLEBACKEND_EXPORT AbstractEditableContact : public AbstractContact
36		{
37		public:
38		typedef QExplicitlySharedDataPointer<AbstractEditableContact> Ptr;
39		typedef QList<AbstractEditableContact::Ptr> List;
40		AbstractEditableContact();
41		virtual ~AbstractEditableContact();
42
43		/**
44		* @p key @see AbstractContact for key identifiers
45		* @p value suggested value
46		*
47		* @returns whether the change was successful
48		*/
49		virtual bool setCustomProperty(const QString &key, const QVariant &value) = 0;
50
51		private:
52		Q_DISABLE_COPY(AbstractEditableContact)
53		};
54
55		}
56
57		Q_DECLARE_METATYPE(KPeople::AbstractEditableContact::List)
58		Q_DECLARE_METATYPE(KPeople::AbstractEditableContact::Ptr)
59
60		#endif