/usr/include/KF5/KEmoticons/kemoticons.h is in libkf5emoticons-dev 5.28.0-1.
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 | /**********************************************************************************
* 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_H
#define KEMOTICONS_H
#include "kemoticons_export.h"
#include "kemoticonstheme.h"
#include <QtCore/QObject>
#include <kservicetypetrader.h>
class KEmoticonsPrivate;
/**
* This class can be used to retrieve, install, create emoticons theme.
* For example, if you want to get the current emoticon theme
* @code
* KEmoticons ke;
* KEmoticonsTheme et = ke.theme();
* //do whatever you want with the theme
* @endcode
* It can also be used to set the emoticon theme and the parse mode in the config file
* @author Carlo Segato (brandon.ml@gmail.com)
*/
class KEMOTICONS_EXPORT KEmoticons : public QObject
{
Q_OBJECT
public:
/**
* Default constructor
*/
KEmoticons();
/**
* Destructor
*/
~KEmoticons();
/**
* Retrieves the current emoticon theme
* @return the current KEmoticonsTheme
*/
KEmoticonsTheme theme() const;
/**
* Retrieves the emoticon theme with name @p name
* @param name name of the theme
* @return the KEmoticonsTheme with name @p name
*/
KEmoticonsTheme theme(const QString &name) const;
/**
* Retrieves the current emoticon theme name
*/
static QString currentThemeName();
/**
* Returns a list of installed emoticon themes
*/
static QStringList themeList();
/**
* Sets @p theme as the current emoticon theme
* @param theme a reference to a KEmoticonsTheme object
*/
static void setTheme(const KEmoticonsTheme &theme);
/**
* Sets @p theme as the current emoticon theme
* @param theme the name of a theme
*/
static void setTheme(const QString &theme);
/**
* Creates a new emoticon theme
* @code
* KEmoticonsTheme theme;
* KService::List srv = KServiceTypeTrader::self()->query("KEmoticons");
* for (int i = 0; i < srv.size(); ++i) {
* // we want to create a kde emoticons theme
* if (srv.at(i)->property("X-KDE-EmoticonsFileName").toString() == "emoticons.xml") {
* theme = KEmoticons().newTheme("test", srv.at(i));
* }
* }
* @endcode
* @param name the name of the new emoticon theme
* @param service the kind of emoticon theme to create
*/
KEmoticonsTheme newTheme(const QString &name, const KService::Ptr &service);
/**
* Installs all emoticon themes inside the archive @p archiveName
* @param archiveName path to the archive
* @return a list of installed themes
*/
QStringList installTheme(const QString &archiveName);
/**
* Sets the parse mode to @p mode
*/
static void setParseMode(KEmoticonsTheme::ParseMode mode);
/**
* Returns the current parse mode
*/
static KEmoticonsTheme::ParseMode parseMode();
/**
* If a preferred size is set, all parsed emoticons will be
* returned with the @p size
*
* @param size The desired QSize of parsed emoticons
* @since 5.23
*/
void setPreferredEmoticonSize(const QSize &size);
/**
* Returns size in which parsed emoticons will be returned.
*
* If the QSize returned is not valid (isValid() == false),
* then the default will be used, that is the actual file size.
*
* @since 5.23
*/
QSize preferredEmoticonSize() const;
private:
/**
* Private implementation class
*/
const QScopedPointer<KEmoticonsPrivate> d;
Q_PRIVATE_SLOT(d, void changeTheme(const QString &path))
};
#endif /* KEMOTICONS_H */
|