LeechCraft Azoth  0.6.70-15082-g543737046d
Modular multiprotocol IM plugin for LeechCraft
Public Member Functions | Protected Member Functions | List of all members
LC::Azoth::IHaveContactMood Class Referenceabstract

Interface for contacts announcing their current mood. More...

#include "ihavecontactmood.h"

Public Member Functions

virtual ~IHaveContactMood ()
 
virtual MoodInfo GetUserMood (const QString &variant) const =0
 Returns the user mood for the given variant. More...
 

Protected Member Functions

virtual void moodChanged (const QString &variant)=0
 Notifies that entry's user mood has changed. More...
 

Detailed Description

Interface for contacts announcing their current mood.

This interface should be implemented by those contact list entries (ICLEntry objects) that support providing information about their current mood.

Different variants of an entry (as per ICLEntry::Variants()) can have different moods, so exact variant is specified both when announcing the mood change via the moodChanged() signal and when retrieving the mood via the GetUserMood() function.

See also
ICLEntry
IHaveContactActivity
IHaveContactTune
MoodInfo

Definition at line 37 of file ihavecontactmood.h.

Constructor & Destructor Documentation

◆ ~IHaveContactMood()

virtual LC::Azoth::IHaveContactMood::~IHaveContactMood ( )
inlinevirtual

Definition at line 40 of file ihavecontactmood.h.

Member Function Documentation

◆ GetUserMood()

virtual MoodInfo LC::Azoth::IHaveContactMood::GetUserMood ( const QString &  variant) const
pure virtual

Returns the user mood for the given variant.

If the contact does not announce any mood on this variant, an empty MoodInfo structure is returned, that is, with empty MoodInfo::General_ field.

Parameters
[in]variantThe variant to query
Returns
The information about the mood of the given variant.

◆ moodChanged()

virtual void LC::Azoth::IHaveContactMood::moodChanged ( const QString &  variant)
protectedpure virtual

Notifies that entry's user mood has changed.

The actual mood is obtained via the GetUserMood() method.

Note
This function is expected to be a signal.
Parameters
[out]variantVariant of the entry whose mood has changed.
The documentation for this class was generated from the following file: