IRCAdapterBase Class Referenceabstract

Provides an unified communication interface between a client and IRC network entities. More...

#include <ircadapterbase.h>

+ Inheritance diagram for IRCAdapterBase:

Public Types

enum  AdapterType { NetworkAdapter, ChannelAdapter, PrivAdapter }
 Defines all possible types of IRC adapters. More...
 

Public Slots

void emitMessageToAllChatBoxes (const QString &message, const IRCMessageClass &msgClass)
 
void sendMessage (const QString &message)
 

Signals

void error (const QString &error)
 
void focusRequest ()
 Called when this adapter requests UI focus. More...
 
void message (const QString &message)
 
void messageToNetworksCurrentChatBox (const QString &message, const IRCMessageClass &msgClass)
 
void messageWithClass (const QString &message, const IRCMessageClass &messageClass)
 
void terminating ()
 
void titleChange ()
 Can be called when the variable returned by title() might have changed and the application should be notified of this fact. More...
 

Public Member Functions

virtual ~IRCAdapterBase ()
 Destructor emits terminating() signal. More...
 
virtual AdapterType adapterType () const =0
 Gets adapter type for this adapter instance. More...
 
virtual void doSendMessage (const QString &message, IRCAdapterBase *pOrigin)=0
 Implement to handle and send a message to the IRC network entity. More...
 
void emitError (const QString &strError)
 
void emitFocusRequest ()
 
void emitMessage (const QString &strMessage)
 
void emitMessageWithClass (const QString &strMessage, const IRCMessageClass &messageClass)
 
virtual IRCNetworkAdapternetwork ()=0
 The idea of the adapter system is that each adapter is either a network or is a child of a network. More...
 
const IRCNetworkEntitynetworkEntity () const
 
virtual QString recipient () const
 
virtual QString title () const =0
 Gets title for this adapter. More...
 

Detailed Description

Provides an unified communication interface between a client and IRC network entities.

Definition at line 37 of file ircadapterbase.h.

Member Enumeration Documentation

Defines all possible types of IRC adapters.

Definition at line 45 of file ircadapterbase.h.

Constructor & Destructor Documentation

virtual IRCAdapterBase::~IRCAdapterBase ( )
inlinevirtual

Destructor emits terminating() signal.

Definition at line 55 of file ircadapterbase.h.

Member Function Documentation

virtual AdapterType IRCAdapterBase::adapterType ( ) const
pure virtual

Gets adapter type for this adapter instance.

Implemented in IRCChannelAdapter, IRCPrivAdapter, and IRCNetworkAdapter.

virtual void IRCAdapterBase::doSendMessage ( const QString &  message,
IRCAdapterBase pOrigin 
)
pure virtual

Implement to handle and send a message to the IRC network entity.

This is meant for internal use by the IRCAdapterBase derivatives.

Each implementation treats this method a bit differently. Please refer to the documentation in the classes that derive from this one.

Parameters
pOriginOrigin of this message. Can be used to determine where the error and message signals should be passed.

Implemented in IRCNetworkAdapter, and IRCChatAdapter.

void IRCAdapterBase::focusRequest ( )
signal

Called when this adapter requests UI focus.

virtual IRCNetworkAdapter* IRCAdapterBase::network ( )
pure virtual

The idea of the adapter system is that each adapter is either a network or is a child of a network.

This method is supposed to return a pointer to a network to which this adapter belongs.

Implemented in IRCNetworkAdapter, and IRCChatAdapter.

virtual QString IRCAdapterBase::title ( ) const
pure virtual

Gets title for this adapter.

Implemented in IRCNetworkAdapter, and IRCChatAdapter.

void IRCAdapterBase::titleChange ( )
signal

Can be called when the variable returned by title() might have changed and the application should be notified of this fact.


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