KEmoticons Class Reference

#include <kemoticons.h>

Inheritance diagram for KEmoticons:

Public Member Functions
	KEmoticons ()
	~KEmoticons () override
QStringList	installTheme (const QString &archiveName)
KEmoticonsTheme	newTheme (const QString &name, const KService::Ptr &service)
QSize	preferredEmoticonSize () const
void	setPreferredEmoticonSize (const QSize &size)
KEmoticonsTheme	theme () const
KEmoticonsTheme	theme (const QString &name) const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThread *	thread () const const

Static Public Member Functions
static QString	currentThemeName ()
static KEmoticonsTheme::ParseMode	parseMode ()
static void	setParseMode (KEmoticonsTheme::ParseMode mode)
static void	setTheme (const KEmoticonsTheme &theme)
static void	setTheme (const QString &theme)
static QStringList	themeList ()
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Additional Inherited Members
Properties inherited from QObject
	objectName
Public Attributes inherited from QObject
typedef	QObjectList
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

This class can be used to retrieve, install, create emoticons theme.

For example, if you want to get the current emoticon theme

KEmoticons ke;
KEmoticonsTheme et = ke.theme();
//do whatever you want with the theme

It can also be used to set the emoticon theme and the parse mode in the config file

Author

Carlo Segato (brand[email protected]on.m[email protected][email protected][email protected]il.c[email protected]om)

Definition at line 31 of file kemoticons.h.

Constructor & Destructor Documentation

KEmoticons()

KEmoticons::KEmoticons

(

)

Default constructor.

Definition at line 146 of file kemoticons.cpp.

~KEmoticons()

KEmoticons::~KEmoticons ( )

override

Destructor.

Definition at line 153 of file kemoticons.cpp.

Member Function Documentation

currentThemeName()

QString KEmoticons::currentThemeName ( )

static

Retrieves the current emoticon theme name.

Definition at line 172 of file kemoticons.cpp.

installTheme()

QStringList KEmoticons::installTheme

(

const QString &

archiveName

)

Installs all emoticon themes inside the archive archiveName.

Parameters

archiveName

path to the archive

Returns

a list of installed themes

Definition at line 226 of file kemoticons.cpp.

newTheme()

KEmoticonsTheme KEmoticons::newTheme	(	const QString &	name,
		const KService::Ptr &	service
	)

Creates a new emoticon theme.

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));
    }
}

Parameters

name	the name of the new emoticon theme
service	the kind of emoticon theme to create

Definition at line 212 of file kemoticons.cpp.

parseMode()

KEmoticonsTheme::ParseMode KEmoticons::parseMode ( )

static

Returns the current parse mode.

Definition at line 202 of file kemoticons.cpp.

preferredEmoticonSize()

QSize KEmoticons::preferredEmoticonSize

(

)

const

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

Definition at line 332 of file kemoticons.cpp.

setParseMode()

void KEmoticons::setParseMode ( KEmoticonsTheme::ParseMode  mode )

static

Sets the parse mode to mode.

Definition at line 207 of file kemoticons.cpp.

setPreferredEmoticonSize()

void KEmoticons::setPreferredEmoticonSize

(

const QSize &

size

)

If a preferred size is set, all parsed emoticons will be returned with the size.

Parameters

size	The desired QSize of parsed emoticons

Since

5.23

Definition at line 327 of file kemoticons.cpp.

setTheme() [1/2]

void KEmoticons::setTheme ( const KEmoticonsTheme &  theme )

static

Sets theme as the current emoticon theme.

Parameters

theme

a reference to a KEmoticonsTheme object

Definition at line 192 of file kemoticons.cpp.

setTheme() [2/2]

void KEmoticons::setTheme ( const QString &  theme )

static

Sets theme as the current emoticon theme.

Parameters

theme

the name of a theme

Definition at line 197 of file kemoticons.cpp.

theme() [1/2]

KEmoticonsTheme KEmoticons::theme

(

)

const

Retrieves the current emoticon theme.

Returns

the current KEmoticonsTheme

Definition at line 157 of file kemoticons.cpp.

theme() [2/2]

KEmoticonsTheme KEmoticons::theme

(

const QString &

name

)

const

Retrieves the emoticon theme with name name.

Parameters

name	name of the theme

Returns

the KEmoticonsTheme with name name

Definition at line 162 of file kemoticons.cpp.

themeList()

QStringList KEmoticons::themeList ( )

static

Returns a list of installed emoticon themes.

Definition at line 177 of file kemoticons.cpp.

---

The documentation for this class was generated from the following files:

• kemoticons.h
• kemoticons.cpp