lyx_mirror/src/DispatchResult.h

70 lines
1.6 KiB
C
Raw Normal View History

// -*- C++ -*-
/**
* \file DispatchResult.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author none
* \author Lars Gullik Bjønnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef DISPATCH_RESULT_H
#define DISPATCH_RESULT_H
#include "update_flags.h"
#include "support/docstring.h"
namespace lyx {
/// Maybe this can go entirely
class DispatchResult {
public:
///
DispatchResult() : dispatched_(false), error_(false),
update_(Update::None), need_buf_update_(false) {}
///
DispatchResult(bool disp, Update::flags f)
: dispatched_(disp), error_(false), update_(f) {}
///
bool dispatched() const { return dispatched_; }
///
void dispatched(bool disp) { dispatched_ = disp; }
///
bool error() const { return error_; }
///
void setError(bool e) { error_ = e; }
///
docstring message() { return message_; }
///
void setMessage(docstring m) { message_ = m; }
///
Update::flags update() const { return update_; }
///
void update(Update::flags f) { update_ = f; }
/// Does the buffer need updating?
bool needBufferUpdate() const { return need_buf_update_; }
/// Force the buffer to be updated
void forceBufferUpdate() { need_buf_update_ = true; }
/// Clear the flag indicating we need an update
void clearBufferUpdate() { need_buf_update_ = false; }
private:
/// was the event fully dispatched?
bool dispatched_;
/// was there an error?
bool error_;
/// do we need to redraw the screen afterwards?
Update::flags update_;
///
docstring message_;
///
bool need_buf_update_;
};
} // namespace lyx
#endif // DISPATCH_RESULT_H