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

#include "ihavecontacttune.h"

Public Member Functions
virtual	~IHaveContactTune ()

virtual Media::AudioInfo	GetUserTune (const QString &variant) const =0
	Returns the user tune for the given variant. More...

Protected Member Functions
virtual void	tuneChanged (const QString &variant)=0
	Notifies that entry's current tune has changed. More...

Detailed Description

Interface for contacts announcing their current tune.

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

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

See also: ICLEntry; IHaveContactActivity; IHaveContactMood

Definition at line 39 of file ihavecontacttune.h.

Constructor & Destructor Documentation

◆ ~IHaveContactTune()

virtual LC::Azoth::IHaveContactTune::~IHaveContactTune ( )

inlinevirtual

Definition at line 42 of file ihavecontacttune.h.

Member Function Documentation

◆ GetUserTune()

virtual Media::AudioInfo LC::Azoth::IHaveContactTune::GetUserTune ( const QString & variant ) const

pure virtual

Returns the user tune for the given variant.

If the contact does not announce any tune on this variant, an empty Media::AudioInfo structure is returned.

Parameters

[in] variant The variant to query

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

◆ tuneChanged()

virtual void LC::Azoth::IHaveContactTune::tuneChanged ( const QString & variant )

protectedpure virtual

Notifies that entry's current tune has changed.

The actual tune is obtained via the GetUserTune() method.

Note: This function is expected to be a signal.

Parameters

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

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

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