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

Interface for entries for sending directed statuses. More...

#include "ihavedirectedstatus.h"

Public Member Functions

virtual ~IHaveDirectedStatus ()
 
virtual bool CanSendDirectedStatusNow (const QString &variant)=0
 Checks if status can be sent to the given variant. More...
 
virtual void SendDirectedStatus (const EntryStatus &status, const QString &variant)=0
 Sends directed status to the given variant. More...
 

Detailed Description

Interface for entries for sending directed statuses.

This interface should be implemented by CL entries that support directed statuses — that is, statuses sent only to a given entry.

See Also
ICLEntry

Definition at line 46 of file ihavedirectedstatus.h.

Constructor & Destructor Documentation

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

Definition at line 49 of file ihavedirectedstatus.h.

Member Function Documentation

virtual bool LeechCraft::Azoth::IHaveDirectedStatus::CanSendDirectedStatusNow ( const QString &  variant)
pure virtual

Checks if status can be sent to the given variant.

This function should return false if directed status cannot be sent to variant right now, otherwise it should return true (even in doubt). A naive implementation may choose to always return true here.

Parameters
[in]variantThe variant of the entry to check.
Returns
Whether directed status can be sent to the given variant.
virtual void LeechCraft::Azoth::IHaveDirectedStatus::SendDirectedStatus ( const EntryStatus status,
const QString &  variant 
)
pure virtual

Sends directed status to the given variant.

This function should (try to) send the given status to the given variant of the entry.

Parameters
[in]statusThe status to send.
[in]variantThe variant of the entry where to send the status.

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