dcop Library API Documentation

DCOPSignals Class Reference

Collaboration diagram for DCOPSignals:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 DCOPSignals ()
void emitSignal (DCOPConnection *conn, const QCString &fun, const QByteArray &data, bool excludeSelf)
bool connectSignal (const QCString &sender, const QCString &senderObj, const QCString &signal, DCOPConnection *conn, const QCString &receiverObj, const QCString &slot, bool Volatile)
bool disconnectSignal (const QCString &sender, const QCString &senderObj, const QCString &signal, DCOPConnection *conn, const QCString &receiverObj, const QCString &slot)
void removeConnections (DCOPConnection *conn, const QCString &obj=0)

Public Attributes

QAsciiDict< DCOPSignalConnectionListconnections

Detailed Description

Definition at line 60 of file dcopsignals.h.


Member Function Documentation

void DCOPSignals::emitSignal DCOPConnection *  conn,
const QCString fun,
const QByteArray data,
bool  excludeSelf
 

Client "conn" emits the signal "fun" with "data" as arguments.

conn is 0L if the dcopserver sends the signal itself

The emitting object is encoded in "fun".

If "excludeSelf" is true, signal is never send to "conn" itself.

Definition at line 38 of file dcopsignals.cpp.

References connections, QAsciiDict::find(), QCString::find(), QPtrList::first(), QCString::isEmpty(), QCString::left(), QCString::mid(), QPtrList::next(), DCOPSignalConnection::recvConn, DCOPSignalConnection::recvObj, DCOPSignalConnection::sender, DCOPSignalConnection::senderConn, DCOPSignalConnection::senderObj, and DCOPSignalConnection::slot.

bool DCOPSignals::connectSignal const QCString sender,
const QCString senderObj,
const QCString signal,
DCOPConnection *  conn,
const QCString receiverObj,
const QCString slot,
bool  Volatile
 

Connects "signal" of the client named "sender" with the "slot" of "receiverObj" in the "conn" client.

If "Volatile" is true the connection will be removed when either "sender" or "conn" unregisters.

If "Volatile" is false the connection will only be removed when "conn" unregisters.

Returns true if succesfull. False on failure. An attempt to create a Volatile connection to a non-existing client results in a failure.

Definition at line 99 of file dcopsignals.cpp.

References QPtrList::append(), connections, QAsciiDict::find(), QCString::find(), QAsciiDict::insert(), QCString::left(), QCString::length(), QCString::mid(), DCOPSignalConnection::recvConn, DCOPSignalConnection::recvObj, DCOPSignalConnection::sender, DCOPSignalConnection::senderConn, DCOPSignalConnection::senderObj, DCOPSignalConnection::signal, DCOPSignalConnection::slot, and QCString::truncate().

bool DCOPSignals::disconnectSignal const QCString sender,
const QCString senderObj,
const QCString signal,
DCOPConnection *  conn,
const QCString receiverObj,
const QCString slot
 

Disconnects "signal" of the client named "sender" from the "slot" of "receiverObj" in the "conn" client.

If "receiverObj" is empty, every object is disconnected. If "slot" is empty, every slot is disconnected.

Returns true if successful, false if no connection was found.

Definition at line 175 of file dcopsignals.cpp.

References connections, QAsciiDict::find(), QPtrList::first(), QCString::isEmpty(), QPtrList::next(), DCOPSignalConnection::recvConn, DCOPSignalConnection::recvObj, removeConnections(), QPtrList::removeRef(), DCOPSignalConnection::sender, DCOPSignalConnection::senderConn, DCOPSignalConnection::senderObj, and DCOPSignalConnection::slot.

void DCOPSignals::removeConnections DCOPConnection *  conn,
const QCString obj = 0
 

Removes all connections related to the "conn" client.

This means: All connections for which "conn" is the receiver. All volatile connections for which "conn" is the sender.

Definition at line 239 of file dcopsignals.cpp.

References connections, QAsciiDict::find(), QPtrList::first(), QPtrList::isEmpty(), QCString::isEmpty(), QPtrList::next(), DCOPSignalConnection::recvConn, DCOPSignalConnection::recvObj, QAsciiDict::remove(), QPtrList::removeRef(), DCOPSignalConnection::senderConn, and DCOPSignalConnection::senderObj.

Referenced by disconnectSignal().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for dcop Library Version 3.4.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sun Oct 9 07:53:29 2005 by doxygen 1.4.4 written by Dimitri van Heesch, © 1997-2003