KEmoticons Class Reference

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

#include <kemoticons.h>

Inheritance diagram for KEmoticons:

[legend]

List of all members.

Public Member Functions
QStringList	installTheme (const QString &archiveName)
	KEmoticons ()
KEmoticonsTheme	newTheme (const QString &name, const KService::Ptr &service)
KEmoticonsTheme	theme (const QString &name)
KEmoticonsTheme	theme ()
	~KEmoticons ()
Static Public Member Functions
static QString	currentThemeName ()
static KEmoticonsTheme::ParseMode	parseMode ()
static void	setParseMode (KEmoticonsTheme::ParseMode mode)
static void	setTheme (const QString &theme)
static void	setTheme (const KEmoticonsTheme &theme)
static QStringList	themeList ()

---

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 (brandon.ml@gmail.com)

Definition at line 44 of file kemoticons.h.

---

Constructor & Destructor Documentation

KEmoticons::KEmoticons

(

)

Default constructor.

Definition at line 95 of file kemoticons.cpp.

KEmoticons::~KEmoticons

(

)

Destruct the object.

Definition at line 103 of file kemoticons.cpp.

---

Member Function Documentation

QString KEmoticons::currentThemeName

(

)

[static]

Retrieve the current emoticon theme name.

Definition at line 138 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 182 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 171 of file kemoticons.cpp.

KEmoticonsTheme::ParseMode KEmoticons::parseMode

(

)

[static]

Returns the current parse mode.

Definition at line 280 of file kemoticons.cpp.

void KEmoticons::setParseMode

(

KEmoticonsTheme::ParseMode

mode

)

[static]

Set the parse mode to mode.

Definition at line 273 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 164 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 159 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 113 of file kemoticons.cpp.

KEmoticonsTheme KEmoticons::theme

(

)

Retrieve the current emoticons theme.

Returns:

the current KEmoticonsTheme

Definition at line 108 of file kemoticons.cpp.

QStringList KEmoticons::themeList

(

)

[static]

Returns a list of installed theme.

Definition at line 145 of file kemoticons.cpp.

---

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

• kemoticons.h
• kemoticons.cpp