EmoteShortcut Class Reference

The class which keeps track of the emote shortcuts. More...

#include <emoteshortcut.h>

Public Member Functions
	EmoteShortcut ()
	~EmoteShortcut ()
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 () const
	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 = -1
	The emote held by cursor.

Detailed Description

The class which keeps track of the emote shortcuts.

Definition at line 29 of file emoteshortcut.h.

Constructor & Destructor Documentation

EmoteShortcut()

EmoteShortcut::EmoteShortcut

(

)

Definition at line 29 of file emoteshortcut.cpp.

~EmoteShortcut()

EmoteShortcut::~EmoteShortcut

(

)

Definition at line 34 of file emoteshortcut.cpp.

Member Function Documentation

getEmote()

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 46 of file emoteshortcut.h.

getEmoteCount()

int EmoteShortcut::getEmoteCount ( ) const

inline

Returns the amount of shortcut Emotes.

Definition at line 52 of file emoteshortcut.h.

getEmoteSelected()

int EmoteShortcut::getEmoteSelected ( ) const

inline

Returns the emote ID that is currently selected.

Definition at line 58 of file emoteshortcut.h.

isEmoteSelected()

bool EmoteShortcut::isEmoteSelected ( ) const

inline

A flag to check if the Emote is selected.

Definition at line 89 of file emoteshortcut.h.

load()

void EmoteShortcut::load

(

)

Load the configuration information.

Definition at line 39 of file emoteshortcut.cpp.

removeEmote()

void EmoteShortcut::removeEmote ( int  index )

inline

Remove a Emote from the shortcut.

Definition at line 95 of file emoteshortcut.h.

save()

void EmoteShortcut::save ( )

private

Save the configuration information.

Definition at line 51 of file emoteshortcut.cpp.

setEmote()

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 66 of file emoteshortcut.h.

setEmotes()

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 75 of file emoteshortcut.h.

setEmoteSelected()

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 83 of file emoteshortcut.h.

useEmote()

void EmoteShortcut::useEmote

(

int

index

)

Try to use the Emote specified by the index.

Parameters

index

Index of the emote shortcut.

Definition at line 62 of file emoteshortcut.cpp.

Member Data Documentation

mEmotes

int EmoteShortcut::mEmotes[SHORTCUT_EMOTES]

private

The emote stored.

Definition at line 111 of file emoteshortcut.h.

mEmoteSelected

int EmoteShortcut::mEmoteSelected = -1

private

The emote held by cursor.

Definition at line 112 of file emoteshortcut.h.

---

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

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