EmoteShortcut Class Reference

#include <emoteshortcut.h>

List of all members.

---

Detailed Description

The class which keeps track of the emote shortcuts.

Definition at line 30 of file emoteshortcut.h.

Public Member Functions
	EmoteShortcut ()
	Constructor.
	~EmoteShortcut ()
	Destructor.
void	load ()
	Load the configuration information.
int	getEmote (int index) const
	Returns the shortcut Emote ID specified by the index.
int	getEmoteCount () const
	Returns the amount of shortcut Emotes.
int	getEmoteSelected () const
	Returns the emote ID that is currently selected.
void	setEmote (int index)
	Adds the selected emote ID to the emotes specified by the index.
void	setEmotes (int index, int emoteId)
	Adds a emoticon to the emotes store specified by the index.
void	setEmoteSelected (int emoteId)
	Set the Emote that is selected.
bool	isEmoteSelected ()
	A flag to check if the Emote is selected.
void	removeEmote (int index)
	Remove a Emote from the shortcut.
void	useEmote (int index)
	Try to use the Emote specified by the index.
Private Member Functions
void	save ()
	Save the configuration information.
Private Attributes
int	mEmotes [SHORTCUT_EMOTES]
	The emote stored.
int	mEmoteSelected
	The emote held by cursor.

---

Constructor & Destructor Documentation

EmoteShortcut::EmoteShortcut

(

)

Constructor.

Definition at line 31 of file emoteshortcut.cpp.

EmoteShortcut::~EmoteShortcut

(

)

Destructor.

Definition at line 41 of file emoteshortcut.cpp.

---

Member Function Documentation

void EmoteShortcut::load

(

)

Load the configuration information.

Definition at line 46 of file emoteshortcut.cpp.

int EmoteShortcut::getEmote

(

int

index

)

const [inline]

Returns the shortcut Emote ID specified by the index.

Parameters:

index

Index of the shortcut Emote.

Definition at line 53 of file emoteshortcut.h.

int EmoteShortcut::getEmoteCount

(

)

const [inline]

Returns the amount of shortcut Emotes.

Definition at line 59 of file emoteshortcut.h.

int EmoteShortcut::getEmoteSelected

(

)

const [inline]

Returns the emote ID that is currently selected.

Definition at line 65 of file emoteshortcut.h.

void EmoteShortcut::setEmote

(

int

index

)

[inline]

Adds the selected emote ID to the emotes specified by the index.

Parameters:

index

Index of the emotes.

Definition at line 73 of file emoteshortcut.h.

void EmoteShortcut::setEmotes	(	int	index,
		int	emoteId
	)			[inline]

Adds a emoticon to the emotes store specified by the index.

Parameters:

	index	Index of the emote.
	emoteId	ID of the emote.

Definition at line 82 of file emoteshortcut.h.

void EmoteShortcut::setEmoteSelected

(

int

emoteId

)

[inline]

Set the Emote that is selected.

Parameters:

emoteId

The ID of the emote that is to be assigned.

Definition at line 90 of file emoteshortcut.h.

bool EmoteShortcut::isEmoteSelected

(

)

[inline]

A flag to check if the Emote is selected.

Definition at line 96 of file emoteshortcut.h.

void EmoteShortcut::removeEmote

(

int

index

)

[inline]

Remove a Emote from the shortcut.

Definition at line 102 of file emoteshortcut.h.

void EmoteShortcut::useEmote

(

int

index

)

Try to use the Emote specified by the index.

Parameters:

index

Index of the emote shortcut.

Definition at line 68 of file emoteshortcut.cpp.

void EmoteShortcut::save

(

)

[private]

Save the configuration information.

Definition at line 59 of file emoteshortcut.cpp.

---

Member Data Documentation

int EmoteShortcut::mEmotes[SHORTCUT_EMOTES] [private]

The emote stored.

Definition at line 118 of file emoteshortcut.h.

int EmoteShortcut::mEmoteSelected [private]

The emote held by cursor.

Definition at line 119 of file emoteshortcut.h.

---

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

• tmw/src/emoteshortcut.h
• tmw/src/emoteshortcut.cpp