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

#include "ihavecontactactivity.h"

Public Member Functions
virtual	~IHaveContactActivity ()

virtual ActivityInfo	GetUserActivity (const QString &variant) const =0
	Returns the user activity at the given variant. More...

Protected Member Functions
virtual void	activityChanged (const QString &variant)=0
	Notifies that entry's user activity has changed. More...

Detailed Description

Interface for contacts announcing their current activity.

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

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

See also: ICLEntry; IHaveContactMood; IHaveContactTune; ActivityInfo

Definition at line 48 of file ihavecontactactivity.h.

Constructor & Destructor Documentation

◆ ~IHaveContactActivity()

virtual LC::Azoth::IHaveContactActivity::~IHaveContactActivity ( )

inlinevirtual

Definition at line 51 of file ihavecontactactivity.h.

Member Function Documentation

◆ activityChanged()

virtual void LC::Azoth::IHaveContactActivity::activityChanged ( const QString & variant )

protectedpure virtual

Notifies that entry's user activity has changed.

The actual activity is obtained via the GetUserActivity() method

Note: This function is expected to be a signal.

Parameters

[out] variant Variant of the entry whose activity has changed.

◆ GetUserActivity()

virtual ActivityInfo LC::Azoth::IHaveContactActivity::GetUserActivity ( const QString & variant ) const

pure virtual

Returns the user activity at the given variant.

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

Parameters

[in] variant The variant to query

Returns: The information about the activity of the given variant.

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

/home/d34df00d/leechcraft/src/plugins/azoth/interfaces/azoth/ihavecontactactivity.h