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
69
70
|
/*
$Id: event_trigger.h,v 1.14 2001/12/05 23:50:51 mbn Exp $
------------------------------------------------------------------------
ClanLib, the platform independent game SDK.
This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
version 2. See COPYING for details.
For a total list of contributers see CREDITS.
See http://www.clanlib.org
------------------------------------------------------------------------
*/
//! clanCore="System"
//! header=core.h
#ifndef header_event_trigger
#define header_event_trigger
class CL_EventListener;
class CL_EventTrigger_Generic;
//: ClanLib Event trigger.
//- This class represents an event that can be triggered.
//- <p>Collect several triggers together using the CL_EventListener class, and then
//- call the CL_EventListener::wait function to sleep until one of the events
//- are triggered.</p>
class CL_EventTrigger
{
//! Construction:
public:
//: Constructs an event trigger object.
CL_EventTrigger();
//: Copy constructor.
CL_EventTrigger(const CL_EventTrigger ©);
//: Event Trigger Destructor
virtual ~CL_EventTrigger();
//! Attributes:
public:
//: Returns true if the trigger flag has been raised.
bool get_flag() const;
//! Operations:
public:
// Assignment operator.
CL_EventTrigger &operator =(const CL_EventTrigger ©);
//: Reset trigger flag.
void reset() const;
//: Raise trigger flag.
void set_flag();
//: Wait until one of the event triggers.
//: The timeout is in milliseconds.
//- If timeout = -1, this function will not timeout.
//- Returns true if the event triggered, false if it timed out.
bool wait(int timeout = -1);
//! Implementation:
public:
CL_EventTrigger_Generic *impl;
};
#endif
|
