• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdenetwork API Reference
  • KDE Home
  • Contact Us
 

kopete/libkopete

  • Kopete
  • SimpleMessageHandlerFactory
Public Member Functions | List of all members
Kopete::SimpleMessageHandlerFactory Class Reference

#include <kopetesimplemessagehandler.h>

Inheritance diagram for Kopete::SimpleMessageHandlerFactory:
Inheritance graph
[legend]

Public Member Functions

 SimpleMessageHandlerFactory (Message::MessageDirection direction, int position, QObject *target, const char *slot)
 
 ~SimpleMessageHandlerFactory ()
 
MessageHandler * create (ChatSession *manager, Message::MessageDirection direction)
 
int filterPosition (ChatSession *manager, Message::MessageDirection direction)
 
- Public Member Functions inherited from Kopete::MessageHandlerFactory
 MessageHandlerFactory ()
 
virtual ~MessageHandlerFactory ()
 

Additional Inherited Members

- Public Types inherited from Kopete::MessageHandlerFactory
typedef QLinkedList
< MessageHandlerFactory * > 
FactoryList
 
enum  InboundStage {
  InStageStart = 0, InStageToSent = 2000, InStageToDesired = 5000, InStageFormat = 7000,
  InStageEnd = 10000
}
 
enum  InternalStage { IntStageStart = 0, IntStageEnd = 10000 }
 
enum  Offset {
  OffsetBefore = -90, OffsetVeryEarly = -60, OffsetEarly = -30, OffsetNormal = 0,
  OffsetLate = 30, OffsetVeryLate = 60, OffsetAfter = 90
}
 
enum  OutboundStage {
  OutStageStart = 0, OutStageParse = 2000, OutStageToDesired = 4000, OutStageFormat = 6000,
  OutStageToSent = 8000, OutStageEnd = 10000
}
 
enum  SpecialStage { StageDoNotCreate = -10000, StageStart = 0, StageEnd = 10000 }
 
- Static Public Member Functions inherited from Kopete::MessageHandlerFactory
static FactoryList messageHandlerFactories ()
 

Detailed Description

A MessageHandlerFactory that creates synchronous MessageHandlers that just call a slot.

A concrete MessageHandlerFactory. This class is intended to make writing MessageHandlers simpler; all that is required is to implement a message processing function and place an instance of this class in your Plugin-derived class.

Whenever a message passes through a handler created by this factory, the slot passed to the constructor will be called. The slot should take a single argument of type (non-const) Message &.

Definition at line 37 of file kopetesimplemessagehandler.h.

Constructor & Destructor Documentation

Kopete::SimpleMessageHandlerFactory::SimpleMessageHandlerFactory ( Message::MessageDirection  direction,
int  position,
QObject *  target,
const char *  slot 
)
Parameters
directionThe direction this factory should create message handlers for
positionWhere in the chain the handler should be installed
targetThe object to call back to when handling a message
slotThe slot on target to call when handling a message
See also
Kopete::MessageHandlerFactory::filterPosition

Definition at line 36 of file kopetesimplemessagehandler.cpp.

Kopete::SimpleMessageHandlerFactory::~SimpleMessageHandlerFactory ( )

Definition at line 46 of file kopetesimplemessagehandler.cpp.

Member Function Documentation

MessageHandler * Kopete::SimpleMessageHandlerFactory::create ( ChatSession *  manager,
Message::MessageDirection  direction 
)
virtual

Creates and returns a SimpleMessageHandler object.

Implements Kopete::MessageHandlerFactory.

Definition at line 51 of file kopetesimplemessagehandler.cpp.

int Kopete::SimpleMessageHandlerFactory::filterPosition ( ChatSession *  manager,
Message::MessageDirection  direction 
)
virtual

Returns the filter position passed to the constructor if direction matches the direction passed to the constructor, otherwise returns StageDoNotCreate.

Implements Kopete::MessageHandlerFactory.

Definition at line 61 of file kopetesimplemessagehandler.cpp.


The documentation for this class was generated from the following files:
  • kopetesimplemessagehandler.h
  • kopetesimplemessagehandler.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:29:20 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

kopete/libkopete

Skip menu "kopete/libkopete"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdenetwork API Reference

Skip menu "kdenetwork API Reference"
  • kget
  • kopete
  •   kopete
  •   libkopete
  • krdc
  • krfb

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal