1 /*
2  * %kadu copyright begin%
3  * Copyright 2012, 2013, 2014 Rafał Przemysław Malinowski (rafal.przemyslaw.malinowski@gmail.com)
4  * %kadu copyright end%
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License as
8  * published by the Free Software Foundation; either version 2 of
9  * the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef EMOTICON_PATH_PROVIDER_H
21 #define EMOTICON_PATH_PROVIDER_H
22 
23 #include <QtCore/QString>
24 
25 #include "emoticon.h"
26 
27 /**
28  * @addtogroup Emoticons
29  * @{
30  */
31 
32 /**
33  * @class EmoticonPathProvider
34  * @short Interface to get path of emoticon file from Emoticon instance.
35  * @author Rafał 'Vogel' Malinowski
36  */
37 class EmoticonPathProvider
38 {
39 public:
~EmoticonPathProvider()40 	virtual ~EmoticonPathProvider() {}
41 
42 	/**
43 	 * @short Return path of emoticon file for given emoticon.
44 	 * @author Rafał 'Vogel' Malinowski
45 	 * @param emoticon emoticon to get path for
46 	 * @return path to file of emoticon
47 	 */
48 	virtual QString emoticonPath(const Emoticon &emoticon) = 0;
49 
50 };
51 
52 /**
53  * @}
54  */
55 
56 #endif // EMOTICON_PATH_PROVIDER_H
57