summaryrefslogtreecommitdiffstats
path: root/konq-plugins/domtreeviewer/signalreceiver.h
blob: d550cc0f7efcaae71a4eaddebeae88af41aa8d62 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/* This file is part of the KDE project
 *
 * Copyright (C) 2005 Leo Savernik <l.savernik@aon.at>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef SIGNALCATCHER_H
#define SIGNALCATCHER_H

#include <tqobject.h>

/**
 * \brief Class for receiving signals.
 *
 * This is a convenience class for receiving signals when it is not worth
 * the effort, or overly complicated to introduce a dedicated slot.
 *
 * Use as follows:
 * \code
 * SignalReceiver sr;
 * sr.connect(some_obj, TQ_SIGNAL(someSignal()), TQ_SLOT(slot()));
 * <do something with some_obj> ...
 * if (sr.receivedSignal()) { // yes, signal was received
 * }
 * \endcode
 *
 * It is not possible to discriminate between different signals. Hence,
 * use different signal receiver instances for different signals.
 * @autor Leo Savernik
 */
class SignalReceiver : public TQObject
{
  TQ_OBJECT
  

public:  
  SignalReceiver(TQObject *parent = 0, const char *name = 0);
  virtual ~SignalReceiver();
  
  /** returns true if any signal has been received */
  bool signalReceived() const { return rcvd; }
  
  /** returns true if any signal has been received */
  bool operator ()() const { return rcvd; }

public slots:
  /** connect a signal to this slot to receive it */
  void slot();

private:
  bool rcvd;
};

#endif // SIGNALCATCHER_H