LeechCraft Azoth  %{LEECHCRAFT_VERSION}
Modular multiprotocol IM plugin for LeechCraft
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator
LeechCraft::Azoth::IAdvancedCLEntry Class Referenceabstract

#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...
 
virtual void attentionDrawn (const QString &text, const QString &variant)=0
 Notifies about attention request from this entry. More...
 
virtual void moodChanged (const QString &variant)=0
 Notifies that entry's user mood has changed. More...
 
virtual void activityChanged (const QString &variant)=0
 Notifies that entry's user activity has changed. More...
 
virtual void tuneChanged (const QString &variant)=0
 Notifies that entry's user tune has changed. 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 47 of file iadvancedclentry.h.

Member Enumeration Documentation

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 55 of file iadvancedclentry.h.

Constructor & Destructor Documentation

virtual LeechCraft::Azoth::IAdvancedCLEntry::~IAdvancedCLEntry ( )
inlinevirtual

Definition at line 50 of file iadvancedclentry.h.

Member Function Documentation

virtual void LeechCraft::Azoth::IAdvancedCLEntry::activityChanged ( const QString &  variant)
pure virtual

Notifies that entry's user activity has changed.

The actual activity information should be contained in the map returned from ICLEntry::GetClientInfo(). Please refer to its documentation for information about user activities.

Note
This function is expected to be a signal.
Parameters
[out]variantVariant of the entry whose activity has changed.
See Also
moodChanged(), tuneChanged()
ICLEntry::GetClientInfo()
virtual void LeechCraft::Azoth::IAdvancedCLEntry::attentionDrawn ( const QString &  text,
const QString &  variant 
)
pure 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]textOptional accompanying text.
[out]variantSource variant of the entry that has requested our attention.
See Also
DrawAttention()
virtual void LeechCraft::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]textOptional accompanying text.
[in]variantThe entry variant to buzz, or a null string for variant with highest priority.
See Also
attentionDrawn()
virtual AdvancedFeatures LeechCraft::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.
virtual void LeechCraft::Azoth::IAdvancedCLEntry::locationChanged ( const QString &  variant)
pure 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]variantVariant of the entry whose location has changed.
See Also
ISupportGeolocation
virtual void LeechCraft::Azoth::IAdvancedCLEntry::moodChanged ( const QString &  variant)
pure virtual

Notifies that entry's user mood has changed.

The actual mood information should be contained in the map returned from ICLEntry::GetClientInfo(). Please refer to its documentation for information about user moods.

Note
This function is expected to be a signal.
Parameters
[out]variantVariant of the entry whose mood has changed.
See Also
activityChanged(), tuneChanged()
ICLEntry::GetClientInfo()
virtual void LeechCraft::Azoth::IAdvancedCLEntry::tuneChanged ( const QString &  variant)
pure virtual

Notifies that entry's user tune has changed.

The actual tune information should be contained in the map returned from ICLEntry::GetClientInfo(). Please refer to its documentation for information about user tunes.

Note
This function is expected to be a signal.
Parameters
[out]variantVariant of the entry whose tune has changed.
See Also
moodChanged(), activityChanged()
ICLEntry::GetClientInfo()

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