mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-11-08 20:32:49 +00:00
ec94b42f51
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@9010 a592a061-630c-0410-9148-cb99ea01b6c8
93 lines
1.8 KiB
C++
93 lines
1.8 KiB
C++
// -*- C++ -*-
|
|
/**
|
|
* \file Timeout.h
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Lars Gullik Bjønnes
|
|
* \author John Levon
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#ifndef TIMEOUT_H
|
|
#define TIMEOUT_H
|
|
|
|
#include <boost/signal.hpp>
|
|
|
|
|
|
/**
|
|
* This class executes the callback when the timeout expires.
|
|
*/
|
|
class Timeout {
|
|
public:
|
|
/// the timeout type
|
|
enum Type {
|
|
ONETIME, //< one-shot timer
|
|
CONTINUOUS //< repeating
|
|
};
|
|
/// Note that the c-tor is implemented in the GUI-specific frontends
|
|
Timeout(unsigned int msec, Type = ONETIME);
|
|
///
|
|
~Timeout();
|
|
/// Is the timer running?
|
|
bool running() const;
|
|
/// start the timer
|
|
void start();
|
|
/// stop the timer
|
|
void stop();
|
|
/// restart the timer
|
|
void restart();
|
|
/// signal emitted on timer expiry
|
|
boost::signal<void()> timeout;
|
|
/// emit the signal
|
|
void emit();
|
|
/// set the timer type
|
|
Timeout & setType(Type t);
|
|
/// set the timeout value
|
|
Timeout & setTimeout(unsigned int msec);
|
|
|
|
/** Base class for the GUI implementation.
|
|
It must be public so that C callback functions can access its
|
|
daughter classes.
|
|
*/
|
|
class Impl
|
|
{
|
|
public:
|
|
///
|
|
Impl(Timeout & owner) : owner_(owner) {}
|
|
///
|
|
virtual ~Impl() {}
|
|
/// Is the timer running?
|
|
virtual bool running() const = 0;
|
|
/// start the timer
|
|
virtual void start() = 0;
|
|
/// stop the timer
|
|
virtual void stop() = 0;
|
|
/// reset
|
|
virtual void reset() = 0;
|
|
|
|
protected:
|
|
///
|
|
void emit() { owner_.emit(); }
|
|
///
|
|
unsigned int timeout_ms() const { return owner_.timeout_ms; }
|
|
|
|
private:
|
|
///
|
|
Timeout & owner_;
|
|
};
|
|
|
|
private:
|
|
///
|
|
friend class Impl;
|
|
///
|
|
boost::scoped_ptr<Impl> const pimpl_;
|
|
/// one-shot or repeating
|
|
Type type;
|
|
/// timeout value in milliseconds
|
|
unsigned int timeout_ms;
|
|
};
|
|
|
|
#endif
|