/usr/include/kemoticonsprovider.h is in kdelibs5-dev 4:4.13.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | /**********************************************************************************
* Copyright (C) 2008 by Carlo Segato <brandon.ml@gmail.com> *
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library. If not, see <http://www.gnu.org/licenses/>.*
* *
**********************************************************************************/
#ifndef KEMOTICONS_PROVIDER_H
#define KEMOTICONS_PROVIDER_H
#include "kemoticons_export.h"
#include <QtCore/QObject>
#include <QtCore/QVariant>
#include <QtCore/QStringList>
#include <QtCore/QPair>
class QString;
class KEmoticonsProviderPrivate;
struct Emoticon;
/**
* This is the base class for the emoticons provider plugins
*/
class KEMOTICONS_EXPORT KEmoticonsProvider : public QObject
{
Q_OBJECT
public:
struct Emoticon
{
Emoticon(){}
/* sort by longest to shortest matchText */
bool operator < (const Emoticon &e) const { return matchText.length() > e.matchText.length(); }
QString matchText;
QString matchTextEscaped;
QString picPath;
QString picHTMLCode;
};
/**
* Options to pass to addEmoticon
*/
enum AddEmoticonOption {
DoNotCopy, /**<< Don't copy the emoticon file into the theme directory */
Copy /**<< Copy the emoticon file into the theme directory */
};
/**
* Default constructor
*/
explicit KEmoticonsProvider(QObject *parent = 0);
/**
* Destructor
*/
virtual ~KEmoticonsProvider();
/**
* Load the theme inside the directory @p path
* @param path path to the directory
*/
virtual bool loadTheme(const QString &path);
/**
* Remove the emoticon @p emo, this will not delete the image file too
* @param emo the emoticon text to remove
* @return @c true if it can delete the emoticon
*/
virtual bool removeEmoticon(const QString &emo);
/**
* Add the emoticon @p emo with text @p text
* @param emo path to the emoticon image
* @param text the text of the emoticon separated by space for multiple text
* @param copy whether or not copy @p emo into the theme directory
* @return @c true if it can add the emoticon
*/
virtual bool addEmoticon(const QString &emo, const QString &text, AddEmoticonOption option = DoNotCopy);
/**
* Save the emoticon theme
*/
virtual void save();
/**
* Returns the theme name
*/
QString themeName() const;
/**
* Set the theme name
* @param name name of the theme
*/
void setThemeName(const QString &name);
/**
* Returns the theme path
*/
QString themePath() const;
/**
* Returns the file name of the theme
*/
QString fileName() const;
/**
* Returns a QHash that contains the emoticons path as keys and the text as values
*/
QHash<QString, QStringList> emoticonsMap() const;
/**
* Returns a QHash that contains emoticons indexed by the first char
*/
QHash<QChar, QList<Emoticon> > emoticonsIndex() const;
/**
* Create a new theme
*/
virtual void createNew();
protected:
/**
* Clears the emoticons map
*/
void clearEmoticonsMap();
/**
* Insert a new item in the emoticons map
*/
void addEmoticonsMap(QString key, QStringList value);
/**
* Remove an item from the emoticons map
*/
void removeEmoticonsMap(QString key);
/**
* Add an emoticon to the index
* @param path path to the emoticon
* @param emoList list of text associated with this emoticon
*/
void addEmoticonIndex(const QString &path, const QStringList &emoList);
/**
* Remove an emoticon from the index
* @param path path to the emoticon
* @param emoList list of text associated with this emoticon
*/
void removeEmoticonIndex(const QString &path, const QStringList &emoList);
/**
* Private class
*/
KEmoticonsProviderPrivate * const d;
};
#endif /* KEMOTICONS_PROVIDER_H */
// kate: space-indent on; indent-width 4; replace-tabs on;
|