/usr/include/KF5/KEmoticons/kemoticonstheme.h is in libkf5emoticons-dev 5.18.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 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 | /**********************************************************************************
* Copyright (C) 2008 by Carlo Segato <brandon.ml@gmail.com> *
* Copyright (c) 2002-2003 by Stefan Gehn <metz@gehn.net> *
* Kopete (c) 2002-2008 by the Kopete developers <kopete-devel@kde.org> *
* Copyright (c) 2005 by Engin AYDOGAN <engin@bzzzt.biz> *
* *
* 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_THEME_H
#define KEMOTICONS_THEME_H
#include "kemoticonsprovider.h"
#include <QtCore/QSharedDataPointer>
class QString;
/**
* This class contains the emoticons theme
*/
class KEMOTICONS_EXPORT KEmoticonsTheme
{
public:
/**
* The possible parse modes
*/
enum ParseModeEnum {
DefaultParse = 0x0, /**< Use strict or relaxed according to the config */
StrictParse = 0x1, /**< Strict parsing requires a space between each emoticon */
RelaxedParse = 0x2, /**< Parse mode where all possible emoticon matches are allowed */
SkipHTML = 0x4 /**< Skip emoticons within HTML */
};
Q_DECLARE_FLAGS(ParseMode, ParseModeEnum)
/**
* TokenType, a token might be an image ( emoticon ) or text.
*/
enum TokenType {
Undefined, /**< Undefined, for completeness only */
Image, /**< Token contains a path to an image */
Text /**< Token contains text */
};
/**
* A token consists of a QString text which is either a regular text
* or a path to image depending on the type.
* If type is Image the text refers to an image path.
* If type is Text the text refers to a regular text.
*/
struct Token {
Token() : type(Undefined) {}
/**
* Creates a Token of type @p t, and text @p m
*/
Token(TokenType t, const QString &m) : type(t), text(m) {}
/**
* Creates a Token of type @p t, text @p m, image path @p p and html code @p html
*/
Token(TokenType t, const QString &m, const QString &p, const QString &html)
: type(t), text(m), picPath(p), picHTMLCode(html) {}
TokenType type; /**< type */
QString text; /**< text */
QString picPath; /**< path to the image */
QString picHTMLCode; /**< \<img> html code */
};
/**
* Default constructor, it creates a null emoticon theme
* You should probably never use this, use KEmoticons::theme() instead
*/
KEmoticonsTheme();
/**
* Copy constructor
*/
KEmoticonsTheme(const KEmoticonsTheme &ket);
/**
* Another constructor where you set the KEmoticonsProvider @p p
* You should probably never use this, use KEmoticons::theme() instead
*/
KEmoticonsTheme(KEmoticonsProvider *p);
/**
* Destructor
*/
~KEmoticonsTheme();
/**
* Parses emoticons in text @p text with ParseMode @p mode and optionally excluding emoticons from @p exclude
* @code
* KEmoticonsTheme theme = KEmoticons().theme();
* QString text = ":D hi :)";
* QStringList exclude(":)");
* QString parsed = theme.parseEmoticons(text, KEmoticonsTheme::DefaultParse, exclude);
* // parsed will be "<img align="center" title=":D" alt=":D" src="/path/to/:D.png" width="24" height="24" /> hi :)"
* @endcode
* @param text the text to parse
* @param mode how to parse the text
* @param exclude a list of emoticons to exclude from the parsing
* @return the text with emoticons replaced by html images
* @note SkipHTML is forced when using this function
*/
QString parseEmoticons(const QString &text, ParseMode mode = DefaultParse, const QStringList &exclude = QStringList()) const;
/**
* Tokenizes the message @p message with ParseMode @p mode
* @code
* KEmoticonsTheme theme = KEmoticons().theme();
* QString text = "hi :)";
* QList<Token> tokens = theme.tokenize(text, KEmoticonsTheme::DefaultParse);
* // tokens[0].text = "hi "
* // tokens[1].text = ":)"
* // tokens[1].picPath = "/path/to/:).png"
* // tokens[1].picHTMLCode = "<img align="center" title=":)" alt=":)" src="/path/to/:).png" width="24" height="24" />"
* @endcode
*/
QList<Token> tokenize(const QString &message, ParseMode mode = DefaultParse) const;
/**
* Loads the emoticon theme inside the directory @p path
* @param path path to the directory
* @return @c true if the emoticon is successfully loaded
*
* @deprecated since 5.0, subclass KEmoticonsProvider instead
*/
#ifndef KEMOTICONS_NO_DEPRECATED
KEMOTICONS_DEPRECATED bool loadTheme(const QString &path);
#endif
/**
* Removes the emoticon @p emo. This doesn't delete the image file.
* @code
* KEmoticonsTheme theme = KEmoticons().theme();
* theme.removeEmoticon(":)");
* @endcode
* @param emo the emoticon text to remove
* @return @c true if the emoticon is successfully removed
*
* @deprecated since 5.0, subclass KEmoticonsProvider instead
*/
#ifndef KEMOTICONS_NO_DEPRECATED
KEMOTICONS_DEPRECATED bool removeEmoticon(const QString &emo);
#endif
/**
* Adds the emoticon @p emo with text @p text
* @code
* KEmoticonsTheme theme = KEmoticons().theme();
* theme.addEmoticon("/path/to/smiley.png", ":) :-)");
* @endcode
* @param emo path to the emoticon image
* @param text the emoticon text. If alternative texts are to be added,
* use spaces to separate them.
* @param copy whether or not to copy @p emo into the theme directory
* @return @c true if the emoticon is successfully added
*
* @deprecated since 5.0, subclass KEmoticonsProvider instead
*/
#ifndef KEMOTICONS_NO_DEPRECATED
KEMOTICONS_DEPRECATED bool addEmoticon(const QString &emo,
const QString &text,
KEmoticonsProvider::AddEmoticonOption option = KEmoticonsProvider::DoNotCopy);
#endif
/**
* Saves the emoticon theme
*
* @deprecated since 5.0, subclass KEmoticonsProvider instead
*/
#ifndef KEMOTICONS_NO_DEPRECATED
KEMOTICONS_DEPRECATED void save();
#endif
/**
* Returns the theme name
*/
QString themeName() const;
/**
* Sets the emoticon theme name
* @param name name of the theme
*/
void setThemeName(const QString &name);
/**
* Returns the emoticon theme path
*/
QString themePath() const;
/**
* Returns the file name of the emoticon theme
*/
QString fileName() const;
/**
* Returns a QHash that contains the emoticon path as keys and the text as values
*/
QHash<QString, QStringList> emoticonsMap() const;
/**
* Creates a new theme
*
* @deprecated since 5.0, subclass KEmoticonsProvider instead
*/
#ifndef KEMOTICONS_NO_DEPRECATED
KEMOTICONS_DEPRECATED void createNew();
#endif
/**
* Checks if the emoticon theme has a valid provider
* @return true if it can't find a valid provider
*/
bool isNull() const;
/**
* @internal
*/
KEmoticonsTheme &operator=(const KEmoticonsTheme &ket);
private:
class KEmoticonsThemeData;
/**
* Private implementation class
*/
QSharedDataPointer<KEmoticonsThemeData> d;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KEmoticonsTheme::ParseMode)
#endif /* KEMOTICONS_THEME_H */
|