---

event_trigger.h

Go to the documentation of this file.

#ifndef header_event_trigger
#define header_event_trigger

class CL_EventListener;
class CL_EventTrigger_Generic;

class CL_EventTrigger
// ClanLib Event trigger. This class represents an event that can be trigged.
// 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 trigged.
{
public:
        CL_EventTrigger();
        // Constructs an event trigger object.

        virtual ~CL_EventTrigger();

public:
        bool get_flag() const;
        // Returns true if the trigger flag has been raised.

public:
        void reset() const;
        // Reset trigger flag.

        void set_flag();
        // Raise trigger flag.

        bool wait(int timeout = -1);
        // Wait until one of the event triggers. The timeout is in milliseconds.
        // Returns true if the event triggered, false if it timed out.

public:
        CL_EventTrigger_Generic *impl;
};

#endif

---