LC::Azoth::IAdvancedCLEntry Class Reference

#include "iadvancedclentry.h"

Public Types
enum	AdvancedFeature { AFSupportsAttention = 0x0001 }

Public Member Functions
virtual	~IAdvancedCLEntry ()
virtual AdvancedFeatures	GetAdvancedFeatures () const =0
virtual void	DrawAttention (const QString &text, const QString &variant)=0
	Requests attention of the user behind this entry. More...

Protected Member Functions
virtual void	attentionDrawn (const QString &text, const QString &variant)=0
	Notifies about attention request from this entry. More...
virtual void	locationChanged (const QString &variant)=0
	Notifies that entry's geolocation has changed. More...

Detailed Description

This interface defines some advanced actions and signals on contact list entries, like methods for drawing attention and such.

Entries implementing this interface should, of course, implement plain ICLEntry as well.

See also

ICLEntry

Definition at line 38 of file iadvancedclentry.h.

Member Enumeration Documentation

AdvancedFeature

enum LC::Azoth::IAdvancedCLEntry::AdvancedFeature

This enum represents some advanced features that may or may be not supported by advanced CL entries.

Enumerator
AFSupportsAttention	This entry supports drawing attention.

Definition at line 52 of file iadvancedclentry.h.

Constructor & Destructor Documentation

~IAdvancedCLEntry()

virtual LC::Azoth::IAdvancedCLEntry::~IAdvancedCLEntry ( )

inlinevirtual

Definition at line 47 of file iadvancedclentry.h.

Member Function Documentation

attentionDrawn()

virtual void LC::Azoth::IAdvancedCLEntry::attentionDrawn ( const QString &  text, const QString &  variant  )

protectedpure virtual

Notifies about attention request from this entry.

This signal should be emitted by the entry whenever the user behind the entry decides to request our own attention.

Depending on Azoth settings, the request may be displayed in some way or ignored completely.

Note

This function is expected to be a signal.

Parameters

[out]	text	Optional accompanying text.
[out]	variant	Source variant of the entry that has requested our attention.

See also

DrawAttention()

DrawAttention()

virtual void LC::Azoth::IAdvancedCLEntry::DrawAttention ( const QString &  text, const QString &  variant  )

pure virtual

Requests attention of the user behind this entry.

This method, if called, should send request for attention to this entry, if supported by the protocol. An optional text message may be added to the attention request.

If variant is an empty string, the variant with the highest priority should be used.

Parameters

[in]	text	Optional accompanying text.
[in]	variant	The entry variant to buzz, or a null string for variant with highest priority.

See also

attentionDrawn()

GetAdvancedFeatures()

virtual AdvancedFeatures LC::Azoth::IAdvancedCLEntry::GetAdvancedFeatures ( ) const

pure virtual

Returns the OR-ed combination of advanced features supported by this contact list entry.

Returns

The advanced features supported by this entry.

locationChanged()

virtual void LC::Azoth::IAdvancedCLEntry::locationChanged ( const QString &  variant )

protectedpure virtual

Notifies that entry's geolocation has changed.

The actual geolocation information could be obtained via ISupportGeolocation::GetUserGeolocationInfo() method.

Note

This function is expected to be a signal.

Parameters

[out]

variant

Variant of the entry whose location has changed.

See also

ISupportGeolocation

---

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

• /home/d34df00d/leechcraft/src/plugins/azoth/interfaces/azoth/iadvancedclentry.h