KEmoticons Class Reference

#include <kemoticons.h>

Inheritance diagram for KEmoticons:

Public Member Functions
	KEmoticons ()
	~KEmoticons ()
QStringList	installTheme (const QString &archiveName)
KEmoticonsTheme	newTheme (const QString &name, const KService::Ptr &service)
KEmoticonsTheme	theme ()
KEmoticonsTheme	theme (const QString &name)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () 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
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
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)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Additional Inherited Members
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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.nosp@m.on.m.nosp@m.l@gma.nosp@m.il.c.nosp@m.om)

Definition at line 44 of file kemoticons.h.

Constructor & Destructor Documentation

KEmoticons::KEmoticons

(

)

Default constructor.

Definition at line 118 of file kemoticons.cpp.

KEmoticons::~KEmoticons

(

)

Destruct the object.

Definition at line 126 of file kemoticons.cpp.

Member Function Documentation

QString KEmoticons::currentThemeName ( )

static

Retrieve the current emoticon theme name.

Definition at line 145 of file kemoticons.cpp.

QStringList KEmoticons::installTheme

(

const QString &

archiveName

)

Install all themes inside the archive archiveName.

Parameters

archiveName

path to the archive

Returns

a list of installed themes

Definition at line 189 of file kemoticons.cpp.

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

Create a new emoticons 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 emoticons theme
service	the kind of emoticon theme to create

Definition at line 178 of file kemoticons.cpp.

KEmoticonsTheme::ParseMode KEmoticons::parseMode ( )

static

Returns the current parse mode.

Definition at line 291 of file kemoticons.cpp.

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

static

Set the parse mode to mode.

Definition at line 284 of file kemoticons.cpp.

void KEmoticons::setTheme ( const KEmoticonsTheme &  theme )

static

Set theme as the current theme.

Parameters

theme

a pointer to a KEmoticonsTheme object

Definition at line 166 of file kemoticons.cpp.

void KEmoticons::setTheme ( const QString &  theme )

static

Set theme as the current theme.

Parameters

theme

the name of a theme

Definition at line 171 of file kemoticons.cpp.

KEmoticonsTheme KEmoticons::theme

(

)

Retrieve the current emoticons theme.

Returns

the current KEmoticonsTheme

Definition at line 131 of file kemoticons.cpp.

KEmoticonsTheme KEmoticons::theme

(

const QString &

name

)

Retrieve the theme with name name.

Parameters

name	name of the theme

Returns

the KEmoticonsTheme name

Definition at line 136 of file kemoticons.cpp.

QStringList KEmoticons::themeList ( )

static

Returns a list of installed theme.

Definition at line 152 of file kemoticons.cpp.

---

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

• kemoticons.h
• kemoticons.cpp